Toggle group
A set of toggles where one or many stay pressed.
In Multi-brand
See it live
npm run storybookWhen to use it
In Multi-brand: Monthly or yearly prices.
- Use it when: Switching a view or a mode between a few options, such as list and grid.
- Not when: A form answer (radio group), or actions (button group).
Instead:
- Radio group: An answer in a form.
- Button group: Actions, not a pressed choice.
Words
- Shared structure: object, state, next step.
- Brand tone lives in headlines and marketing copy, not in errors.
- Errors and confirmations read the same in every brand.
- Use: Get started, Plan, Order. Avoid: Brand-specific words in errors, Jargon.
The labels components use, from the voice tokens:
content.action.commit: Savecontent.action.cancel: Cancelcontent.action.destroy: Removecontent.action.retry: Try againcontent.action.empty-action: Get started
See Voice and tone for the whole voice.
Accessibility and keyboard
| Keyboard | What happens | Not |
|---|---|---|
| undefined | Arrow keys move between toggles. | undefined |
Test before you ship:
- It is a group with a name; each toggle says whether it is pressed. undefined
Use it in code
npx open-ds add toggle-group
The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.
Tokens it reads
Toggle group reads 3 tokens of its own, each an alias of a semantic token. Each row is one part: its own token, the semantic it aliases, and the value it ends at. Change a semantic and every component that reads it follows; override one of Toggle group's tokens to change Toggle group alone.
Multi-brand decides what changes when you switch theme. Here a switch changes colors, type and shape, so the marked rows differ between its brands and between light and dark; everything else holds steady.
| Part | Its token and the semantic it aliases | Value |
|---|---|---|
| Toggle group | ||
| Corner Changes with theme | component.toggle-group.radiusradius.controlvar(--toggle-group-radius) | Aster Lightradius.4:0.25remAster Darkradius.4:0.25remBirch Lightradius.12:0.75remBirch Darkradius.12:0.75remCoral Lightradius.999:9999pxCoral Darkradius.999:9999px |
| Shadow Changes with theme | component.toggle-group.shadowelevation.cardvar(--toggle-group-shadow) | Aster Lightshadow.cardAster Darkshadow.card-darkBirch Lightshadow.cardBirch Darkshadow.card-darkCoral Lightshadow.cardCoral Darkshadow.card-dark |
| Item | ||
| Padding, left and right | component.toggle-group.item.padding-xspace.inset.control-xvar(--toggle-group-item-padding-x) | space.16:1rem |
| From the system | ||
| Corner Changes with theme | radius.control straight from the system, through --radius-md | Aster Lightradius.4 · 0.25rem (4px)Aster Darkradius.4 · 0.25rem (4px)Birch Lightradius.12 · 0.75rem (12px)Birch Darkradius.12 · 0.75rem (12px)Coral Lightradius.999 · 9999pxCoral Darkradius.999 · 9999px |