║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║

---

title: Switch description: Switches are a pleasant interface for toggling a value between two states, and offer the same semantics and keyboard navigation as native checkbox elements. author: name: imskyleen url: https://github.com/imskyleen

<ComponentPreview name="demo-components-headless-switch" />

Installation

<ComponentInstallation name="components-headless-switch" />

Usage

<Switch />

API Reference

Switch

<div className="flex flex-col gap-2"> <ExternalLink href="https://animate-ui.com/docs/primitives/headless/switch#switch" text="Animate UI API Reference - Switch Primitive" />

<ExternalLink href="https://headlessui.com/react/switch#switch" text="Headless UI API Reference - Switch" />

</div>

<TypeTable type={{ startIcon: { description: 'The icon to display on the left of the switch.', type: 'React.ReactElement', required: false, }, endIcon: { description: 'The icon to display on the right of the switch.', type: 'React.ReactElement', required: false, }, thumbIcon: { description: 'The icon to display on the thumb of the switch.', type: 'React.ReactElement', required: false, }, pressedWidth: { description: 'The width of the switch indicator when pressed.', type: 'number', required: false, default: '19', }, '...props': { description: 'The props of the Switch component.', type: 'HTMLMotionProps<"button">', required: false, }, }} />

Credits

• Headless Switch
• Credit to shadcn/ui for style inspiration.

║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║