Button group
Related buttons joined into one control.
In Multi-brand
See it live
npm run storybookWhen to use it
In Multi-brand: A few related actions that belong together, such as previous and next. Not two primaries; one clear action per view.
- 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
- 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
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.
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 |
|---|---|---|
| Button group | ||
| Gap | component.button-group.gapspace.gap.defaultvar(--button-group-gap) | space.12:0.75rem |
| Text | ||
| Gap | component.button-group.text.gapspace.gap.defaultvar(--button-group-text-gap) | space.12:0.75rem |
| Corner Changes with theme | component.button-group.text.radiusradius.controlvar(--button-group-text-radius) | Aster Lightradius.4:0.25remAster Darkradius.4:0.25remBirch Lightradius.12:0.75remBirch Darkradius.12:0.75remCoral Lightradius.999:9999pxCoral Darkradius.999:9999px |
| Fill Changes with theme | component.button-group.text.backgroundcolor.surface.sunkenvar(--button-group-text-background) | Aster Lightslate-deep.light.100:#F1F5F9Aster Darkslate-deep.dark.100:#1E293BBirch Lightslate-deep.light.100:#F1F5F9Birch Darkslate-deep.dark.100:#1E293BCoral Lightslate-deep.light.100:#F1F5F9Coral Darkslate-deep.dark.100:#1E293B |
| Padding, left and right | component.button-group.text.padding-xcomponent-spacing-map.x4var(--button-group-text-padding-x) | space.24:1.5rem |
| Text size | component.button-group.text.font-sizetype.body.font-sizevar(--button-group-text-font-size) | font.size.16:1rem |
| Weight | component.button-group.text.font-weighttype.label.font-weightvar(--button-group-text-font-weight) | font.weight.600:600 |
| Icon size | component.button-group.text.icon-sizesize.iconvar(--button-group-text-icon-size) | size.16:1rem |
| Separator | ||
| Fill Changes with theme | component.button-group.separator.backgroundcolor.border.strongvar(--button-group-separator-background) | Aster Lightslate-deep.light.500:#64748BAster Darkslate-deep.dark.400:#96A3B5Birch Lightslate-deep.light.500:#64748BBirch Darkslate-deep.dark.400:#96A3B5Coral Lightslate-deep.light.500:#64748BCoral Darkslate-deep.dark.400:#96A3B5 |
| From the system | ||
| Edge Changes with theme | color.border.default straight from the system, through --border | Aster Lightslate-deep.light.200 · #E2E8F0Aster Darkslate-deep.dark.100 · #1E293BBirch Lightslate-deep.light.200 · #E2E8F0Birch Darkslate-deep.dark.100 · #1E293BCoral Lightslate-deep.light.200 · #E2E8F0Coral Darkslate-deep.dark.100 · #1E293B |