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

---

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

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

Installation

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

Usage

<Switch>
  <SwitchIcon position="left" />
  <SwitchIcon position="right" />
  <SwitchThumb>
    <SwitchIcon position="thumb" />
  </SwitchThumb>
</Switch>

API Reference

Switch

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

<TypeTable type={{ '...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>

SwitchThumb

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

<TypeTable type={{ pressedAnimation: { description: 'The animation of the thumb when pressed.', type: 'TargetAndTransition' | 'VariantLabels' | 'boolean' | 'LegacyAnimationControls', required: false, }, '...props': { description: 'The props of the SwitchThumb component.', type: 'HTMLMotionProps<"div">', required: false, }, }} />

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

SwitchIcon

<TypeTable type={{ position: { description: 'The position of the icon.', type: 'left' | 'right' | 'thumb', required: true, }, '...props': { description: 'The props of the SwitchIcon component.', type: 'HTMLMotionProps<"div">', required: false, }, }} />

Credits

• Base UI Switch

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