@wonderflow/react-components
Version:
UI components from Wonderflow's Wanda design system
44 lines • 1.73 kB
TypeScript
import { ChangeEvent, InputHTMLAttributes } from 'react';
export declare type ToggleProps = InputHTMLAttributes<HTMLInputElement> & {
/**
* Set disabled state. The component is not interactive and grayed out.
*/
disabled?: boolean;
/**
* Define the accessible label of the input. While this is not
* mandatory, an input should always have a label. If not using this property
* you can bind a custom label to the input by using an id.
*/
label?: string;
/**
* Set the size of the toggle.
*/
dimension?: 'regular' | 'small';
/**
* Callback function to be called when is toggled.
* A parameter `ChangeEvent<HTMLInputElement>` is passed with the event details
*/
onChange?: (event: ChangeEvent<HTMLInputElement>) => void;
};
export declare const Toggle: import("react").ForwardRefExoticComponent<InputHTMLAttributes<HTMLInputElement> & {
/**
* Set disabled state. The component is not interactive and grayed out.
*/
disabled?: boolean | undefined;
/**
* Define the accessible label of the input. While this is not
* mandatory, an input should always have a label. If not using this property
* you can bind a custom label to the input by using an id.
*/
label?: string | undefined;
/**
* Set the size of the toggle.
*/
dimension?: "small" | "regular" | undefined;
/**
* Callback function to be called when is toggled.
* A parameter `ChangeEvent<HTMLInputElement>` is passed with the event details
*/
onChange?: ((event: ChangeEvent<HTMLInputElement>) => void) | undefined;
} & import("react").RefAttributes<HTMLInputElement>>;
//# sourceMappingURL=toggle.d.ts.map