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

---

title: Toggle description: A two-state button that can be on or off. author: name: imskyleen url: https://github.com/imskyleen releaseDate: 2025-09-07

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

Installation

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

Usage

<Toggle>
  <ToggleHighlight />
  <ToggleItem />
</Toggle>

API Reference

Toggle

<ExternalLink href="https://base-ui.com/react/components/toggle#api-reference" text="Base UI API Reference - Toggle" />

<TypeTable type={{ '...props': { description: 'The props of the Toggle component.', type: 'HTMLMotionProps<"button">', required: false, }, }} />

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

ToggleHighlight

<TypeTable type={{ '...props': { description: 'The props of the ToggleHighlight component.', type: 'HTMLMotionProps<"div">', required: false, }, }} />

ToggleItem

<TypeTable type={{ '...props': { description: 'The props of the ToggleItem component.', type: 'HTMLMotionProps<"div">', required: false, }, }} />

Credits

• Base UI Toggle

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