@opalkelly/frontpanel-react-components/src/primitives/ToggleSwitch/ToggleSwitch.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.
 */

import ToggleProps from "../Toggle/Toggle.props";

/**
 * Interface for the properties of the `ToggleSwitch` component.
 */
interface ToggleSwitchProps extends ToggleProps {
    /**
     * Label to be displayed on the toggle switch
     */
    label: string;

    /**
     * Optional disable the toggle switch
     * @default false
     */
    disabled?: boolean;
}

export default ToggleSwitchProps;