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

---

title: Switch description: A control that indicates whether a setting is on or off. author: name: imskyleen url: https://github.com/imskyleen

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

Installation

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

Usage

<Switch />

API Reference

Switch

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

<ExternalLink href="https://base-ui.com/react/components/switch#root" text="Base UI API Reference - Switch.Root" />

</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, }, }} />

<Callout type="info"> The `render` property is not supported in the `Switch` component, as it is used for animation. </Callout>

Credits

• Base UI Switch
• Credit to shadcn/ui for style inspiration.

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