@konstructio/ui
Version:
A set of reusable and customizable React components built for konstruct.io
30 lines (29 loc) • 744 B
TypeScript
import { FC } from 'react';
import { Props } from './Switch.types';
/**
* A toggle switch component built on Radix UI primitives.
* Supports horizontal and vertical layouts with label and helper text.
*
* @example
* ```tsx
* // Basic switch
* <Switch label="Enable feature" />
*
* // Controlled switch
* <Switch
* label="Dark mode"
* value={isDarkMode}
* onChange={(enabled) => setIsDarkMode(enabled)}
* />
*
* // Vertical layout with helper text
* <Switch
* label="Notifications"
* helperText="Receive email notifications"
* alignment="vertical"
* />
* ```
*
* @see {@link https://konstructio.github.io/konstruct-ui/?path=/docs/components-switch--docs Storybook}
*/
export declare const Switch: FC<Props>;