Skip to content

RadioGroup

Alpha
Renders a set of radio inputs to let users make a single selection from a short list of options

Examples

Basic

Using onChange handlers

Disabled

Required

With validation

With caption

A visually hidden label

With an external label

Props

RadioGroup

NameTypeDefaultDescription
aria-labelledby
string
Used when associating the input group with a label other than RadioGroup.Label
children Required
RadioGroup.Label | RadioGroup.Caption | RadioGroup.Validation | FormControl
disabled
boolean
falseWhether the input group allows user input
id
string
A generated stringThe unique identifier for this input group. Used to associate the label, validation text, and caption text.
You may want a custom ID to make it easier to select elements in integration tests.
name Required
string
The name used to identify this group of radios
onChange
(selected: string | null, e?: ChangeEvent<HTMLInputElement>) => void
An onChange handler that gets called when the selection changes
required
boolean
falseIf true, the user must make a selection before the owning form can be submitted
sx
SystemStyleObject
Style overrides to apply to the component. See also overriding styles.

RadioGroup.Label

A title for the set of choices. If a RadioGroup.Label is not passed as a child, you must pass the external title's ID to the aria-describedby prop on RadioGroup

NameTypeDefaultDescription
visuallyHidden
boolean
falseIf true, the fieldset legend will be visually hidden
sx
SystemStyleObject
Style overrides to apply to the component. See also overriding styles.

RadioGroup.Description

NameTypeDefaultDescription
children
React.ReactNode
The caption content
sx
SystemStyleObject
Style overrides to apply to the component. See also overriding styles.

RadioGroup.Validation

If the user's selection has been flagged during validation, RadioGroup.Validation may be used to render contextual validation information to help the user complete their task

NameTypeDefaultDescription
children
React.ReactNode
The validation message
variant Required
'error' | 'success' | 'warning'
Changes the visual style to match the validation status
sx
SystemStyleObject
Style overrides to apply to the component. See also overriding styles.

Status

Alpha

  • Component props are documented on primer.style/react.
  • Component does not have any unnecessary third-party dependencies.
  • Component can adapt to different themes.
  • Component can adapt to different screen sizes.
  • Component has 100% test coverage.

Beta

  • Component is used in a production application.
  • Common usage examples are documented on primer.style/react.
  • Common usage examples are documented in storybook stories.
  • Component has been reviewed by a systems designer and any resulting issues have been addressed.
  • Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Stable

  • Component API has been stable with no breaking changes for at least one month.
  • Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.
  • Component has corresponding design guidelines documented in the interface guidelines.
  • Component has corresponding Figma component in the Primer Web library.
Edit this page on GitHub
2 contributorsmperrotticolebemis
Last edited by mperrotti on March 16, 2022