Toggle Group
A set of Toggles sharing one value, with arrow-key navigation.
When to use
- Use when
- Choosing one or several options shown as buttons, such as text alignment.
- Avoid when
- The options need labels longer than a word; use Radio Group.
Installation
The source lands in src/components/ui/toggle-group.tsx, along with any Shelf items it builds on, and .shelf/lock.json records what was installed. It's yours to edit.
Usage
Examples
Multiple
Several options can be on together, such as text formatting.
Outline
Outline Toggles with text labels, as a segmented control.
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
- 0.5 kB gzipped on its own, 7.8 kB with the Shelf items and packages it builds on. JS and CSS in a production build, without React.
- Accessibility
- Axe passes on 2 stories
- Behavior
- 2 interaction tests in Storybook
- React Compiler
- Compiles with React Compiler
- React Doctor
- React Doctor finds nothing