@octopusdeploy/design-system-components
Version:
The design systems component library.
39 lines (38 loc) • 1.01 kB
TypeScript
interface SharedSwitchProps {
/**
* Controls whether the switch is disabled.
*/
disabled?: boolean;
/**
* The current value of the switch.
*/
value: boolean;
/**
* The action to perform when the value is changed.
*/
onChange?: (value: boolean) => void;
/**
* Controls whether the checkbox should be automatically focused.
*/
autoFocus?: boolean;
/**
* The accessible name of the switch.
*/
accessibleName?: string;
/**
* A property that controls the size of the switch and the label (if specified).
*/
size?: "small" | "medium";
}
interface SwitchProps extends SharedSwitchProps {
/**
* The label to display alongside the switch.
*/
label?: string;
}
/**
*
* @deprecated please use Switch instead
*/
export declare function DeprecatedSwitch({ label, value, disabled, onChange, autoFocus, accessibleName, size }: SwitchProps): import("react/jsx-runtime").JSX.Element;
export {};