RadioGroup Radio buttons allow users to select a single option from a list of mutually exclusive options.
All possible options are exposed up front for users to compare.
< RadioGroup label = "Favorite pet" >
< Radio value = "dogs" > Dogs< / Radio >
< Radio value = "cats" > Cats< / Radio >
< / RadioGroup >
< RadioGroup label = "Favorite pet" >
< Radio value = "dogs" > Dogs< / Radio >
< Radio value = "cats" > Cats< / Radio >
< / RadioGroup >
< RadioGroup label = "Favorite pet" >
< Radio value = "dogs" >
Dogs
< / Radio >
< Radio value = "cats" >
Cats
< / Radio >
< / RadioGroup >
RadioGroup accepts multiple Radio elements as children.
Each Radio represents an option that can be selected, labeled by its children.
Note: A Radio cannot be used outside of a RadioGroup.
RadioGroup only allows single selection. An initial, uncontrolled value can be provided to the RadioGroup using the defaultValue
prop.
Alternatively, a controlled value can be provided using the value
prop.
function Example ( ) {
let [ selected, setSelected] = React . useState ( 'yes' ) ;
return (
< Flex gap = "size-300" >
< RadioGroup label = "Are you a wizard? (uncontrolled)" defaultValue = "yes" >
< Radio value = "yes" > Yes< / Radio >
< Radio value = "no" > No< / Radio >
< / RadioGroup >
< RadioGroup
label = "Are you a wizard? (controlled)"
value = { selected}
onChange = { setSelected} >
< Radio value = "yes" > Yes< / Radio >
< Radio value = "no" > No< / Radio >
< / RadioGroup >
< / Flex >
) ;
}
function Example ( ) {
let [ selected, setSelected] = React . useState ( 'yes' ) ;
return (
< Flex gap = "size-300" >
< RadioGroup
label = "Are you a wizard? (uncontrolled)"
defaultValue = "yes" >
< Radio value = "yes" > Yes< / Radio >
< Radio value = "no" > No< / Radio >
< / RadioGroup >
< RadioGroup
label = "Are you a wizard? (controlled)"
value = { selected}
onChange = { setSelected} >
< Radio value = "yes" > Yes< / Radio >
< Radio value = "no" > No< / Radio >
< / RadioGroup >
< / Flex >
) ;
}
function Example ( ) {
let [
selected,
setSelected
] = React . useState (
'yes'
) ;
return (
< Flex gap = "size-300" >
< RadioGroup
label = "Are you a wizard? (uncontrolled)"
defaultValue = "yes" >
< Radio value = "yes" >
Yes
< / Radio >
< Radio value = "no" >
No
< / Radio >
< / RadioGroup >
< RadioGroup
label = "Are you a wizard? (controlled)"
value = { selected}
onChange = {
setSelected
} >
< Radio value = "yes" >
Yes
< / Radio >
< Radio value = "no" >
No
< / Radio >
< / RadioGroup >
< / Flex >
) ;
}
A visual label should be provided for the RadioGroup using the label
prop. If the RadioGroup is required, the isRequired
and
necessityIndicator
props can be used to show a required state.
< Flex gap = "size-300" wrap >
< RadioGroup label = "Favorite avatar" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup label = "Favorite avatar" isRequired necessityIndicator = "icon" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup label = "Favorite avatar" isRequired necessityIndicator = "label" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup label = "Favorite avatar" necessityIndicator = "label" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< / Flex >
< Flex gap = "size-300" wrap >
< RadioGroup label = "Favorite avatar" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
isRequired
necessityIndicator = "icon" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
isRequired
necessityIndicator = "label" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
necessityIndicator = "label" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< / Flex >
< Flex
gap = "size-300"
wrap >
< RadioGroup label = "Favorite avatar" >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio value = "dragon" >
Dragon
< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
isRequired
necessityIndicator = "icon" >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio value = "dragon" >
Dragon
< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
isRequired
necessityIndicator = "label" >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio value = "dragon" >
Dragon
< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
necessityIndicator = "label" >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio value = "dragon" >
Dragon
< / Radio >
< / RadioGroup >
< / Flex >
If a visible label isn't specified for a RadioGroup, an aria-label
must be provided for accessibility. If the field is labeled by a separate element, an aria-labelledby
prop must be provided using the id of the labeling element instead.
Radio elements should always have a visible label.
To internationalize a RadioGroup, a localized string should be passed to the label
prop and as the child content of the Radio elements.
For languages that are read right-to-left (e.g. Hebrew and Arabic), the Radio is automatically placed on the right side of the text. When the necessityIndicator prop is set to "label", a localized string will be provided for "(required)" or "(optional)" automatically.
RadioGroup accepts an onChange
prop, which is triggered when a user changes the selected value.
The example below uses onChange
to log how the user is interacting with the component.
function Example ( ) {
let [ selected, setSelected] = React . useState ( '' ) ;
return (
< >
< RadioGroup
label = "Favorite avatar"
value = { selected}
onChange = { setSelected} >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< div > You have selected: { selected} < / div >
< / >
) ;
}
function Example ( ) {
let [ selected, setSelected] = React . useState ( '' ) ;
return (
< >
< RadioGroup
label = "Favorite avatar"
value = { selected}
onChange = { setSelected} >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< div > You have selected: { selected} < / div >
< / >
) ;
}
function Example ( ) {
let [
selected,
setSelected
] = React . useState ( '' ) ;
return (
< >
< RadioGroup
label = "Favorite avatar"
value = { selected}
onChange = {
setSelected
} >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio value = "dragon" >
Dragon
< / Radio >
< / RadioGroup >
< div >
You have
selected:{ ' ' }
{ selected}
< / div >
< / >
) ;
}
RadioGroups can display a validation state to communicate to the user if the current value is invalid.
Implement your own validation logic in your app and pass "invalid"
to the RadioGroup via the validationState
prop.
< RadioGroup label = "Favorite avatar" validationState = "invalid" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
validationState = "invalid" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
validationState = "invalid" >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio value = "dragon" >
Dragon
< / Radio >
< / RadioGroup >
Name Type Default Description children
ReactElement < RadioProps > | ReactElement < RadioProps > []
— The Radio(s) contained within the RadioGroup. isEmphasized
boolean
— By default, radio buttons are not emphasized (gray).
The emphasized (blue) version provides visual prominence. orientation
Orientation
'vertical'
The axis the Radio Button(s) should align with. name
string
— The name of the RadioGroup, used when submitting an HTML form.
See MDN . value
string
— The current value (controlled). defaultValue
string
— The default value (uncontrolled). isDisabled
boolean
— Whether the input is disabled. isReadOnly
boolean
— Whether the input can be selected but not changed by the user. validationState
ValidationState
— Whether the input should display its "valid" or "invalid" visual styling. isRequired
boolean
— Whether user input is required on the input before form submission.
Often paired with the necessityIndicator
prop to add a visual indicator to the input. label
ReactNode
— The content to display as the label. labelPosition
LabelPosition
'top'
The label's overall position relative to the element it is labeling. labelAlign
Alignment
'start'
The label's horizontal alignment relative to the element it is labeling. necessityIndicator
NecessityIndicator
'icon'
Whether the required state should be shown as an icon or text.
EventsName Type Default Description onChange
(
( value : T
) ) => void
— Handler that is called when the value changes.
LayoutName Type Default Description flex
Responsive < string
| number
| boolean >
— When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN . flexGrow
Responsive < number >
— When used in a flex layout, specifies how the element will grow to fit the space available. See MDN . flexShrink
Responsive < number >
— When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN . flexBasis
Responsive < number | string >
— When used in a flex layout, specifies the initial main size of the element. See MDN . alignSelf
Responsive < 'auto'
| 'normal'
| 'start'
| 'end'
| 'center'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'stretch' >
— Overrides the alignItems
property of a flex or grid container. See MDN . justifySelf
Responsive < 'auto'
| 'normal'
| 'start'
| 'end'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'center'
| 'left'
| 'right'
| 'stretch' >
— Specifies how the element is justified inside a flex or grid container. See MDN . order
Responsive < number >
— The layout order for the element within a flex or grid container. See MDN . gridArea
Responsive < string >
— When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN . gridColumn
Responsive < string >
— When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN . gridRow
Responsive < string >
— When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN . gridColumnStart
Responsive < string >
— When used in a grid layout, specifies the starting column to span within the grid. See MDN . gridColumnEnd
Responsive < string >
— When used in a grid layout, specifies the ending column to span within the grid. See MDN . gridRowStart
Responsive < string >
— When used in a grid layout, specifies the starting row to span within the grid. See MDN . gridRowEnd
Responsive < string >
— When used in a grid layout, specifies the ending row to span within the grid. See MDN .
Spacing Sizing Positioning AccessibilityName Type Default Description id
string
— The element's unique identifier. See MDN . aria-label
string
— Defines a string value that labels the current element. aria-labelledby
string
— Identifies the element (or elements) that labels the current element. aria-describedby
string
— Identifies the element (or elements) that describes the object. aria-details
string
— Identifies the element (or elements) that provide a detailed, extended description for the object. aria-errormessage
string
— Identifies the element that provides an error message for the object.
AdvancedName Type Default Description UNSAFE_className
string
— Sets the CSS className for the element. Only use as a last resort . Use style props instead. UNSAFE_style
CSSProperties
— Sets inline style for the element. Only use as a last resort . Use style props instead.
Name Type Default Description value
string
— The value of the radio button, used when submitting an HTML form.
See MDN . children
ReactNode
— The label for the Radio. Accepts any renderable node. isDisabled
boolean
— Whether the radio button is disabled or not.
Shows that a selection exists, but is not available in that circumstance. autoFocus
boolean
— Whether the element should receive focus on render.
EventsName Type Default Description onFocus
(
( e : FocusEvent
) ) => void
— Handler that is called when the element receives focus. onBlur
(
( e : FocusEvent
) ) => void
— Handler that is called when the element loses focus. onFocusChange
(
( isFocused : boolean
) ) => void
— Handler that is called when the element's focus status changes. onKeyDown
(
( e : KeyboardEvent
) ) => void
— Handler that is called when a key is pressed. onKeyUp
(
( e : KeyboardEvent
) ) => void
— Handler that is called when a key is released.
LayoutName Type Default Description flex
Responsive < string
| number
| boolean >
— When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN . flexGrow
Responsive < number >
— When used in a flex layout, specifies how the element will grow to fit the space available. See MDN . flexShrink
Responsive < number >
— When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN . flexBasis
Responsive < number | string >
— When used in a flex layout, specifies the initial main size of the element. See MDN . alignSelf
Responsive < 'auto'
| 'normal'
| 'start'
| 'end'
| 'center'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'stretch' >
— Overrides the alignItems
property of a flex or grid container. See MDN . justifySelf
Responsive < 'auto'
| 'normal'
| 'start'
| 'end'
| 'flex-start'
| 'flex-end'
| 'self-start'
| 'self-end'
| 'center'
| 'left'
| 'right'
| 'stretch' >
— Specifies how the element is justified inside a flex or grid container. See MDN . order
Responsive < number >
— The layout order for the element within a flex or grid container. See MDN . gridArea
Responsive < string >
— When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN . gridColumn
Responsive < string >
— When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN . gridRow
Responsive < string >
— When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN . gridColumnStart
Responsive < string >
— When used in a grid layout, specifies the starting column to span within the grid. See MDN . gridColumnEnd
Responsive < string >
— When used in a grid layout, specifies the ending column to span within the grid. See MDN . gridRowStart
Responsive < string >
— When used in a grid layout, specifies the starting row to span within the grid. See MDN . gridRowEnd
Responsive < string >
— When used in a grid layout, specifies the ending row to span within the grid. See MDN .
Spacing Sizing Positioning AccessibilityName Type Default Description id
string
— The element's unique identifier. See MDN . aria-label
string
— Defines a string value that labels the current element. aria-labelledby
string
— Identifies the element (or elements) that labels the current element. aria-describedby
string
— Identifies the element (or elements) that describes the object. aria-details
string
— Identifies the element (or elements) that provide a detailed, extended description for the object.
AdvancedName Type Default Description UNSAFE_className
string
— Sets the CSS className for the element. Only use as a last resort . Use style props instead. UNSAFE_style
CSSProperties
— Sets inline style for the element. Only use as a last resort . Use style props instead.
RadioGroups are vertically oriented by default.
The orientation
prop can be used to change the orientation to horizontal.
< RadioGroup label = "Favorite avatar" orientation = "horizontal" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
orientation = "horizontal" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
orientation = "horizontal" >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio value = "dragon" >
Dragon
< / Radio >
< / RadioGroup >
Label position and alignment# View guidelines
By default, the label is positioned above the RadioGroup.
The labelPosition
prop can be used to position the label to the side. The labelAlign
prop can
be used to align the label as "start" or "end".
For left-to-right (LTR) languages, "start" refers to the left most edge of the RadioGroup
and "end" refers to the right most edge. For right-to-left (RTL) languages, this is flipped.
< RadioGroup label = "Favorite avatar" labelPosition = "side" labelAlign = "end" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
labelPosition = "side"
labelAlign = "end" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
labelPosition = "side"
labelAlign = "end" >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio value = "dragon" >
Dragon
< / Radio >
< / RadioGroup >
View guidelines
< RadioGroup label = "Favorite avatar" isDisabled >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup label = "Favorite avatar" isDisabled >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
isDisabled >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio value = "dragon" >
Dragon
< / Radio >
< / RadioGroup >
< RadioGroup label = "Favorite avatar" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" isDisabled >
Dragon
< / Radio >
< / RadioGroup >
< RadioGroup label = "Favorite avatar" >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" isDisabled >
Dragon
< / Radio >
< / RadioGroup >
< RadioGroup label = "Favorite avatar" >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio
value = "dragon"
isDisabled >
Dragon
< / Radio >
< / RadioGroup >
View guidelines
The isReadOnly prop makes the selection immutable. Unlike isDisabled, the RadioGroup remains focusable.
See the MDN docs for more information.
< RadioGroup label = "Favorite avatar" defaultValue = "wizard" isReadOnly >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
defaultValue = "wizard"
isReadOnly >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
defaultValue = "wizard"
isReadOnly >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio value = "dragon" >
Dragon
< / Radio >
< / RadioGroup >
View guidelines
< RadioGroup label = "Favorite avatar" defaultValue = "dragon" isEmphasized >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
defaultValue = "dragon"
isEmphasized >
< Radio value = "wizard" > Wizard< / Radio >
< Radio value = "dragon" > Dragon< / Radio >
< / RadioGroup >
< RadioGroup
label = "Favorite avatar"
defaultValue = "dragon"
isEmphasized >
< Radio value = "wizard" >
Wizard
< / Radio >
< Radio value = "dragon" >
Dragon
< / Radio >
< / RadioGroup >