@opalkelly/frontpanel-react-components/src/primitives/Indicator/Indicator.props.ts

React Component Library for OpalKelly FrontPanel application development

/**
 * Copyright (c) 2024 Opal Kelly Incorporated
 *
 * This source code is licensed under the FrontPanel license.
 * See the LICENSE file found in the root directory of this project.
 */

export type IndicatorSize = 1 | 2 | 3;
export type IndicatorState = boolean;

/**
 * Interface for the properties of the `Indicator` component.
 */
interface IndicatorProps {
    /**
     * Label to be displayed on the indicator
     */
    label: string;

    /**
     * Current state of the indicator
     */
    state: IndicatorState;

    /**
     * Optional CSS class to apply to the indicator
     */
    className?: string;

    /**
     * Optional size of the indicator
     * @default 1
     */
    size?: IndicatorSize;

    /**
     * Optional tooltip text to be displayed on hover
     */
    tooltip?: string;
}

export default IndicatorProps;