Radio group
One choice from a short list shown at once.
In Content first
See it live
npm run storybookWhen to use it
In Content first: Two to five choices readers should see at once, such as how to sort the list. Not for many options.
- 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
- Write to one person: "you", not "users".
- Short sentences with room to breathe.
- Explain why before asking for anything.
- Use: Read, Save for later, You, Next issue. Avoid: Click here, Submit, Users, Content.
The labels components use, from the voice tokens:
content.action.commit: Savecontent.action.cancel: Not nowcontent.action.destroy: Removecontent.action.retry: Try againcontent.action.empty-action: Browse guides
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.
Content 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) | Lightnavy.light.600:#1E3A5FDarknavy.dark.600:#8FA6C4 |
| Item | ||
| Icon size | component.radio-group.item.icon-sizesize.iconvar(--radio-group-item-icon-size) | size.16:1rem |
| 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) | Lightstone.light.500:#7A7062Darkstone.dark.400:#A39A8B |
| Text Changes with theme | component.radio-group.item.labelcolor.action.primaryvar(--radio-group-item-label) | Lightnavy.light.600:#1E3A5FDarknavy.dark.600:#8FA6C4 |
| 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) | Lightnavy.light.600:#1E3A5FDarknavy.dark.600:#8FA6C4 |
| Disabled opacity disabled when disabled | component.radio-group.item.disabled-opacity-disabledopacity.disabledvar(--radio-group-item-disabled-opacity-disabled) | opacity.40:0.4 |
| 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.2:2px |
| Focus ring focus Changes with theme on focus | component.radio-group.item.focus-ring-focuscolor.border.focusvar(--radio-group-item-focus-ring-focus) | Lightnavy.light.600:#1E3A5FDarknavy.dark.600:#8FA6C4 |
| 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) | Lightstone.light.50:#FFFDF8Darkstone.dark.0:#14110D |
| From the system | ||
| Edge Changes with theme | color.border.default straight from the system, through --border | Lightstone.light.200 · #E4DDD0Darkstone.dark.100 · #2E2A24 |