Button group
Related buttons joined into one control.
In Accessible first
See it live
npm run storybookWhen to use it
In Accessible first: A few related buttons, each with a word, and at most one primary. Not unrelated actions, and never icon-only.
- Use it when: A few actions that belong together, such as previous and next, or a split action.
- Not when: A choice that stays selected (toggle group), or unrelated actions.
Instead:
- Toggle group: The choice stays pressed.
- Dropdown menu: More actions than fit in a row.
Words
- Use common words. Explain any term you must use.
- One idea per sentence. Put the action first.
- Never blame the person.
- Use: Continue, Change, Start, You. Avoid: Invalid, Utilise, Submit, Error code.
The labels components use, from the voice tokens:
content.action.commit: Continuecontent.action.cancel: Go backcontent.action.destroy: Deletecontent.action.retry: Try againcontent.action.empty-action: Start a new application
See Voice and tone for the whole voice.
Accessibility and keyboard
Test before you ship:
- The buttons are a group with a name. undefined
Use it in code
npx open-ds add button-group
The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.
Tokens it reads
Button group reads 9 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 Button group's tokens to change Button group alone.
Accessible first decides what changes when you switch theme. Here a switch changes colors only, so the marked rows differ between light and dark; everything else holds steady.
| Part | Its token and the semantic it aliases | Value |
|---|---|---|
| Button group | ||
| Gap | component.button-group.gapspace.gap.defaultvar(--button-group-gap) | space.16:1rem |
| Text | ||
| Gap | component.button-group.text.gapspace.gap.defaultvar(--button-group-text-gap) | space.16:1rem |
| Corner | component.button-group.text.radiusradius.controlvar(--button-group-text-radius) | radius.6:0.375rem |
| Fill Changes with theme | component.button-group.text.backgroundcolor.surface.sunkenvar(--button-group-text-background) | Lightgray.light.100:#EDEDEDDarkgray.dark.100:#222222 |
| Padding, left and right | component.button-group.text.padding-xcomponent-spacing-map.x4var(--button-group-text-padding-x) | space.28:1.75rem |
| Text size | component.button-group.text.font-sizetype.body.font-sizevar(--button-group-text-font-size) | font.size.19:1.1875rem |
| Weight | component.button-group.text.font-weighttype.label.font-weightvar(--button-group-text-font-weight) | font.weight.700:700 |
| Icon size | component.button-group.text.icon-sizesize.iconvar(--button-group-text-icon-size) | size.20:1.25rem |
| Separator | ||
| Fill Changes with theme | component.button-group.separator.backgroundcolor.border.strongvar(--button-group-separator-background) | Lightgray.light.500:#595959Darkgray.dark.500:#949494 |
| From the system | ||
| Edge Changes with theme | color.border.default straight from the system, through --border | Lightgray.light.200 · #D6D6D6Darkgray.dark.100 · #222222 |