Radio group
One choice from a short list shown at once.
In Accessible first
See it live
npm run storybookWhen to use it
In Accessible first: One choice from a short, visible list.
- Use it when: Two to about five options where the answer is one of them.
- Not when: Many options (select), many answers (checkboxes), or a setting that applies at once (switch).
Instead:
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
| Keyboard | What happens | Not |
|---|---|---|
| undefined | Arrow keys move the choice; Tab leaves the group. | undefined |
Test before you ship:
- The options are a group with a question as its name. undefined
Use it in code
npx open-ds add radio-group
The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.
Tokens it reads
Radio group reads 14 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 Radio group's tokens to change Radio 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 |
|---|---|---|
| Radio group | ||
| Gap | component.radio-group.gapcomponent-spacing-map.x3var(--radio-group-gap) | space.20:1.25rem |
| Icon Changes with theme | component.radio-group.iconcolor.action.primaryvar(--radio-group-icon) | Lightblue.light.600:#0B4FC0Darkblue.dark.600:#8AB4F8 |
| Item | ||
| Icon size | component.radio-group.item.icon-sizesize.iconvar(--radio-group-item-icon-size) | size.20:1.25rem |
| Corner | component.radio-group.item.radiusradius.roundvar(--radio-group-item-radius) | radius.full:9999px |
| Border Changes with theme | component.radio-group.item.bordercolor.border.strongvar(--radio-group-item-border) | Lightgray.light.500:#595959Darkgray.dark.500:#949494 |
| Text Changes with theme | component.radio-group.item.labelcolor.action.primaryvar(--radio-group-item-label) | Lightblue.light.600:#0B4FC0Darkblue.dark.600:#8AB4F8 |
| Shadow | component.radio-group.item.shadowelevation.cardvar(--radio-group-item-shadow) | shadow.none |
| Border focus Changes with theme on focus | component.radio-group.item.border-focuscolor.border.focusvar(--radio-group-item-border-focus) | Lightblue.light.600:#0B4FC0Darkblue.dark.600:#8AB4F8 |
| Disabled opacity disabled when disabled | component.radio-group.item.disabled-opacity-disabledopacity.disabledvar(--radio-group-item-disabled-opacity-disabled) | opacity.50:0.5 |
| Border invalid Changes with theme when invalid | component.radio-group.item.border-invalidcolor.status.dangervar(--radio-group-item-border-invalid) | Lightred.light.600:#C42B2BDarkred.dark.600:#F28B8B |
| Focus ring invalid Changes with theme when invalid | component.radio-group.item.focus-ring-invalidcolor.status.dangervar(--radio-group-item-focus-ring-invalid) | Lightred.light.600:#C42B2BDarkred.dark.600:#F28B8B |
| Focus on focus | component.radio-group.item.focusborder-width.focusvar(--radio-group-item-focus) | border-width.3:3px |
| Focus ring focus Changes with theme on focus | component.radio-group.item.focus-ring-focuscolor.border.focusvar(--radio-group-item-focus-ring-focus) | Lightblue.light.600:#0B4FC0Darkblue.dark.600:#8AB4F8 |
| Focus ring offset focus Changes with theme on focus | component.radio-group.item.focus-ring-offset-focuscolor.surface.canvasvar(--radio-group-item-focus-ring-offset-focus) | Lightgray.light.50:#F7F7F7Darkgray.dark.0:#0A0A0A |
| From the system | ||
| Edge Changes with theme | color.border.default straight from the system, through --border | Lightgray.light.200 · #D6D6D6Darkgray.dark.100 · #222222 |