Toggle
A two-state button with default and outline variants.
When to use
- Use when
- A single on/off button in a toolbar, such as bold.
- Avoid when
- The setting is part of a form; use Switch or Checkbox.
Installation
The source lands in src/components/ui/toggle.tsx, along with any Shelf items it builds on, and .shelf/lock.json records what was installed. It's yours to edit.
Usage
Built on
- Packages
@base-ui/react,@stylexjs/stylex- Shelf items
foundations,utils- Accessibility
- Focus, keyboard, and ARIA behavior come from Base UI.
- Figma
- Optional native Figma library. See Designers.
Verified
- Size
- 1.6 kB gzipped on its own, 7.3 kB with the Shelf items and packages it builds on. JS and CSS in a production build, without React.
- Accessibility
- Axe passes on 5 stories
- Behavior
- 5 interaction tests in Storybook
- React Doctor
- React Doctor finds nothing