RadioGroup
A radio group allows a user to select a single item from a list of mutually exclusive options.
install | yarn add react-aria-components |
---|---|
version | 3.17.0 |
usage | import {RadioGroup} from 'react-aria-components' |
Example#
import {RadioGroup, Radio, Label} from 'react-aria-components';
<RadioGroup>
<Label>Favorite pet</Label>
<Radio value="dogs">Dog</Radio>
<Radio value="cats">Cat</Radio>
<Radio value="dragon">Dragon</Radio>
</RadioGroup>
import {
Label,
Radio,
RadioGroup
} from 'react-aria-components';
<RadioGroup>
<Label>Favorite pet</Label>
<Radio value="dogs">Dog</Radio>
<Radio value="cats">Cat</Radio>
<Radio value="dragon">Dragon</Radio>
</RadioGroup>
import {
Label,
Radio,
RadioGroup
} from 'react-aria-components';
<RadioGroup>
<Label>
Favorite pet
</Label>
<Radio value="dogs">
Dog
</Radio>
<Radio value="cats">
Cat
</Radio>
<Radio value="dragon">
Dragon
</Radio>
</RadioGroup>
Show CSS
.react-aria-RadioGroup {
display: flex;
flex-direction: column;
gap: 8px;
&[aria-orientation=horizontal] {
flex-direction: row;
align-items: center;
}
& [slot=description] {
font-size: 12px;
}
& [slot=errorMessage] {
font-size: 12px;
color: var(--spectrum-global-color-red-600);
}
}
.react-aria-Radio {
display: flex;
align-items: center;
gap: 8px;
font-size: 16px;
&:before {
content: '';
display: block;
width: 18px;
height: 18px;
box-sizing: border-box;
border: 2px solid gray;
background: var(--spectrum-global-color-gray-50);
border-radius: 18px;
transition: all 200ms;
}
&[data-pressed]:before {
border-color: dimgray;
}
&[data-selected] {
&:before {
border-color: slateblue;
border-width: 6px;
}
&[data-pressed]:before {
border-color: #4837b5;
}
}
&[data-validation-state=invalid]:before {
border-color: var(--spectrum-global-color-static-red-600);
}
&[data-focus-visible]:before {
box-shadow: 0 0 0 2px var(--spectrum-alias-background-color-default), 0 0 0 4px slateblue;
}
&[data-disabled] {
opacity: 0.4;
}
}
.react-aria-RadioGroup {
display: flex;
flex-direction: column;
gap: 8px;
&[aria-orientation=horizontal] {
flex-direction: row;
align-items: center;
}
& [slot=description] {
font-size: 12px;
}
& [slot=errorMessage] {
font-size: 12px;
color: var(--spectrum-global-color-red-600);
}
}
.react-aria-Radio {
display: flex;
align-items: center;
gap: 8px;
font-size: 16px;
&:before {
content: '';
display: block;
width: 18px;
height: 18px;
box-sizing: border-box;
border: 2px solid gray;
background: var(--spectrum-global-color-gray-50);
border-radius: 18px;
transition: all 200ms;
}
&[data-pressed]:before {
border-color: dimgray;
}
&[data-selected] {
&:before {
border-color: slateblue;
border-width: 6px;
}
&[data-pressed]:before {
border-color: #4837b5;
}
}
&[data-validation-state=invalid]:before {
border-color: var(--spectrum-global-color-static-red-600);
}
&[data-focus-visible]:before {
box-shadow: 0 0 0 2px var(--spectrum-alias-background-color-default), 0 0 0 4px slateblue;
}
&[data-disabled] {
opacity: 0.4;
}
}
.react-aria-RadioGroup {
display: flex;
flex-direction: column;
gap: 8px;
&[aria-orientation=horizontal] {
flex-direction: row;
align-items: center;
}
& [slot=description] {
font-size: 12px;
}
& [slot=errorMessage] {
font-size: 12px;
color: var(--spectrum-global-color-red-600);
}
}
.react-aria-Radio {
display: flex;
align-items: center;
gap: 8px;
font-size: 16px;
&:before {
content: '';
display: block;
width: 18px;
height: 18px;
box-sizing: border-box;
border: 2px solid gray;
background: var(--spectrum-global-color-gray-50);
border-radius: 18px;
transition: all 200ms;
}
&[data-pressed]:before {
border-color: dimgray;
}
&[data-selected] {
&:before {
border-color: slateblue;
border-width: 6px;
}
&[data-pressed]:before {
border-color: #4837b5;
}
}
&[data-validation-state=invalid]:before {
border-color: var(--spectrum-global-color-static-red-600);
}
&[data-focus-visible]:before {
box-shadow: 0 0 0 2px var(--spectrum-alias-background-color-default), 0 0 0 4px slateblue;
}
&[data-disabled] {
opacity: 0.4;
}
}
Features#
Radio groups can be built in HTML with the
<fieldset>
and <input> elements,
however these can be difficult to style. RadioGroup
and Radio
help achieve accessible
radio groups that can be styled as needed.
- Accessible – Radio groups are exposed to assistive technology via ARIA, and automatically associate a nested
<Label>
. Description and error message help text slots are supported as well. - HTML form integration – Each individual radio uses a visually hidden
<input>
element under the hood, which enables HTML form integration and autofill. - Cross-browser – Mouse, touch, keyboard, and focus interactions are normalized to ensure consistency across browsers and devices.
Anatomy#
A radio group consists of a set of radio buttons, and a label. Each radio includes a label and a visual selection indicator. A single radio button within the group can be selected at a time. Users may click or touch a radio button to select it, or use the Tab key to navigate to the group, the arrow keys to navigate within the group, and the Space key to select an option.
RadioGroup
also supports optional description and error message elements, which can be used
to provide more context about the field, and any validation messages. These are linked with the
inputs via the aria-describedby
attribute.
Individual radio buttons must have a visual label. If the radio group does not have a visible label,
an aria-label
or aria-labelledby
prop must be passed instead to identify the element to assistive
technology.
Composed components#
A RadioGroup
uses the following components, which may also be used standalone or reused in other components.
Props#
RadioGroup#
Name | Type | Default | Description |
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 |
children | ReactNode | (
(values: RadioGroupRenderProps
)) => ReactNode | — | |
className | string | (
(values: RadioGroupRenderProps
)) => string | — | |
style | CSSProperties | (
(values: RadioGroupRenderProps
)) => CSSProperties | — |
Events
Name | Type | Default | Description |
onChange | (
(value: T
)) => void | — | Handler that is called when the value changes. |
Accessibility
Name | 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. |
Radio#
Name | Type | Default | Description |
value | string | — | The value of the radio button, used when submitting an HTML form. See MDN. |
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. |
children | ReactNode | (
(values: RadioRenderProps
)) => ReactNode | — | |
className | string | (
(values: RadioRenderProps
)) => string | — | |
style | CSSProperties | (
(values: RadioRenderProps
)) => CSSProperties | — |
Events
Name | 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. |
Accessibility
Name | 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. |
Styling#
React Aria components can be styled in many ways, including using CSS classes, inline styles, utility classes (e.g. Tailwind), CSS-in-JS (e.g. Styled Components), etc. By default, all components include a builtin className
attribute which can be targeted using CSS selectors. These follow the react-aria-ComponentName
naming convention.
.react-aria-Radio {
/* ... */
}
.react-aria-Radio {
/* ... */
}
.react-aria-Radio {
/* ... */
}
A custom className
can also be specified on any component. This overrides the default className
provided by React Aria with your own.
<Radio className="my-radio">
{/* ... */}
</Radio>
<Radio className="my-radio">
{/* ... */}
</Radio>
<Radio className="my-radio">
{/* ... */}
</Radio>;
In addition, some components support multiple UI states (e.g. focused, placeholder, readonly, etc.). React Aria components expose states using DOM attributes, which you can target in CSS selectors. These are ARIA attributes wherever possible, or data attributes when a relevant ARIA attribute does not exist. For example:
.react-aria-Radio[data-selected] {
/* ... */
}
.react-aria-Radio[data-selected] {
/* ... */
}
.react-aria-Radio[data-selected] {
/* ... */
}
The className
and style
props also accept functions which receive states for styling. This lets you dynamically determine the classes or styles to apply, which is useful when using utility CSS libraries like Tailwind.
<Radio className={({isPressed}) => isPressed ? 'bg-gray-700' : 'bg-gray-600'} />
<Radio
className={({ isPressed }) =>
isPressed ? 'bg-gray-700' : 'bg-gray-600'}
/>;
<Radio
className={(
{ isPressed }
) =>
isPressed
? 'bg-gray-700'
: 'bg-gray-600'}
/>;
Render props may also be used as children to alter what elements are rendered based on the current state. For example, you could render an extra element when the radio is selected.
<Radio>
{({isSelected}) => (
<>
{isSelected && <SelectedIcon />}
Option
</>
)}
</Radio>
<Radio>
{({isSelected}) => (
<>
{isSelected && <SelectedIcon />}
Option
</>
)}
</Radio>
<Radio>
{({ isSelected }) => (
<>
{isSelected && (
<SelectedIcon />
)}
Option
</>
)}
</Radio>;
The states and selectors for each component used in a RadioGroup
are documented below.
RadioGroup#
A RadioGroup
can be targeted with the .react-aria-RadioGroup
CSS selector, or by overriding with a custom className
. It supports the following states and render props:
Name | CSS Selector | Description |
orientation | [aria-orientation="horizontal | vertical"] | The orientation of the radio group. |
isDisabled | [aria-disabled] | Whether the radio group is disabled. |
isReadOnly | [aria-readonly] | Whether the radio group is read only. |
isRequired | [aria-required] | Whether the radio group is required. |
validationState | [aria-invalid] | The validation state of the radio group. |
Radio#
A Radio
can be targeted with the .react-aria-Radio
CSS selector, or by overriding with a custom className
. It supports the following states:
Name | CSS Selector | Description |
isSelected | [data-selected] | Whether the radio is selected. |
isHovered | [data-hovered] | Whether the radio is currently hovered with a mouse. |
isPressed | [data-pressed] | Whether the radio is currently in a pressed state. |
isFocused | [data-focused] | Whether the radio is focused, either via a mouse or keyboard. |
isFocusVisible | [data-focus-visible] | Whether the radio is keyboard focused. |
isDisabled | [data-disabled] | Whether the radio is disabled. |
isReadOnly | [data-readonly] | Whether the radio is read only. |
validationState | [data-validation-state="valid | invalid"] | Whether the radio is valid or invalid. |
isRequired | [data-required] | Whether the checkbox is required. |
Text#
The help text elements within a RadioGroup
can be targeted with the [slot=description]
and [slot=errorMessage]
CSS selectors, or by adding a custom className
.
Reusable wrappers#
If you will use a RadioGroup in multiple places in your app, you can wrap all of the pieces into a reusable component. This way, the DOM structure, styling code, and other logic are defined in a single place and reused everywhere to ensure consistency.
This example wraps RadioGroup
and all of its children together into a single component which accepts a label
prop, which is passed to the right place. It also shows how to use the description
and errorMessage
slots to render help text (see below for details).
import {Text} from 'react-aria-components';
function MyRadioGroup({
label,
description,
errorMessage,
children,
...props
}) {
return (
<RadioGroup {...props}>
{label}
{children}
{description && <Text slot="description">{description}</Text>}
{errorMessage && <Text slot="errorMessage">{errorMessage}</Text>}
</RadioGroup>
);
}
<MyRadioGroup label="Favorite sport">
<Radio value="soccer">Soccer</Radio>
<Radio value="baseball">Baseball</Radio>
<Radio value="basketball">Basketball</Radio>
</MyRadioGroup>
import {Text} from 'react-aria-components';
function MyRadioGroup({
label,
description,
errorMessage,
children,
...props
}) {
return (
<RadioGroup {...props}>
{label}
{children}
{description && (
<Text slot="description">{description}</Text>
)}
{errorMessage && (
<Text slot="errorMessage">{errorMessage}</Text>
)}
</RadioGroup>
);
}
<MyRadioGroup label="Favorite sport">
<Radio value="soccer">Soccer</Radio>
<Radio value="baseball">Baseball</Radio>
<Radio value="basketball">Basketball</Radio>
</MyRadioGroup>
import {Text} from 'react-aria-components';
function MyRadioGroup({
label,
description,
errorMessage,
children,
...props
}) {
return (
<RadioGroup
{...props}
>
{label}
{children}
{description && (
<Text slot="description">
{description}
</Text>
)}
{errorMessage && (
<Text slot="errorMessage">
{errorMessage}
</Text>
)}
</RadioGroup>
);
}
<MyRadioGroup label="Favorite sport">
<Radio value="soccer">
Soccer
</Radio>
<Radio value="baseball">
Baseball
</Radio>
<Radio value="basketball">
Basketball
</Radio>
</MyRadioGroup>
Usage#
The following examples show how to use the MyRadioGroup
component created in the above example.
Orientation#
RadioGroups are vertically oriented by default.
The orientation
prop can be used to change the orientation to horizontal.
<MyRadioGroup label="Favorite avatar" orientation="horizontal">
<Radio value="wizard">Wizard</Radio>
<Radio value="dragon">Dragon</Radio>
</MyRadioGroup>
<MyRadioGroup
label="Favorite avatar"
orientation="horizontal"
>
<Radio value="wizard">Wizard</Radio>
<Radio value="dragon">Dragon</Radio>
</MyRadioGroup>
<MyRadioGroup
label="Favorite avatar"
orientation="horizontal"
>
<Radio value="wizard">
Wizard
</Radio>
<Radio value="dragon">
Dragon
</Radio>
</MyRadioGroup>
Default value#
An initial, uncontrolled value can be provided to the RadioGroup using the defaultValue
prop, which accepts a value corresponding with the value
prop of each Radio.
<MyRadioGroup label="Are you a wizard?" defaultValue="yes">
<Radio value="yes">Yes</Radio>
<Radio value="no">No</Radio>
</MyRadioGroup>
<MyRadioGroup label="Are you a wizard?" defaultValue="yes">
<Radio value="yes">Yes</Radio>
<Radio value="no">No</Radio>
</MyRadioGroup>
<MyRadioGroup
label="Are you a wizard?"
defaultValue="yes"
>
<Radio value="yes">
Yes
</Radio>
<Radio value="no">
No
</Radio>
</MyRadioGroup>
Controlled value#
A controlled value can be provided using the value
prop, which accepts a value corresponding with the value
prop of each Radio.
The onChange
event is fired when the user selects a radio.
function Example() {
let [selected, setSelected] = React.useState('');
return (
<>
<MyRadioGroup
label="Favorite avatar"
value={selected}
onChange={setSelected}
>
<Radio value="wizard">Wizard</Radio>
<Radio value="dragon">Dragon</Radio>
</MyRadioGroup>
<p>You have selected: {selected}</p>
</>
);
}
function Example() {
let [selected, setSelected] = React.useState('');
return (
<>
<MyRadioGroup
label="Favorite avatar"
value={selected}
onChange={setSelected}
>
<Radio value="wizard">Wizard</Radio>
<Radio value="dragon">Dragon</Radio>
</MyRadioGroup>
<p>You have selected: {selected}</p>
</>
);
}
function Example() {
let [
selected,
setSelected
] = React.useState('');
return (
<>
<MyRadioGroup
label="Favorite avatar"
value={selected}
onChange={setSelected}
>
<Radio value="wizard">
Wizard
</Radio>
<Radio value="dragon">
Dragon
</Radio>
</MyRadioGroup>
<p>
You have
selected:{' '}
{selected}
</p>
</>
);
}
Validation#
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.
<MyRadioGroup label="Favorite avatar" validationState="invalid">
<Radio value="wizard">Wizard</Radio>
<Radio value="dragon">Dragon</Radio>
</MyRadioGroup>
<MyRadioGroup
label="Favorite avatar"
validationState="invalid"
>
<Radio value="wizard">Wizard</Radio>
<Radio value="dragon">Dragon</Radio>
</MyRadioGroup>
<MyRadioGroup
label="Favorite avatar"
validationState="invalid"
>
<Radio value="wizard">
Wizard
</Radio>
<Radio value="dragon">
Dragon
</Radio>
</MyRadioGroup>
Help text#
The description
slot can be used to associate additional help text with a radio group. Additionally, the errorMessage
slot can be used to help the user fix a validation error. It should be combined with the validationState
prop to semantically mark the radio group as invalid for assistive technologies.
function Example() {
let [selected, setSelected] = React.useState('dogs');
let isValid = selected === 'dogs';
return (
<MyRadioGroup
aria-label="Favorite pet"
onChange={setSelected}
validationState={isValid ? 'valid' : 'invalid'}
description={isValid ? 'Please select a pet.' : null}
errorMessage={isValid ? null :
selected === 'cats'
? 'No cats allowed.'
: 'Please select dogs.'
}>
<Radio value="dogs">
Dogs
</Radio>
<Radio value="cats">
Cats
</Radio>
<Radio value="dragons">
Dragons
</Radio>
</MyRadioGroup>
);
}
function Example() {
let [selected, setSelected] = React.useState('dogs');
let isValid = selected === 'dogs';
return (
<MyRadioGroup
aria-label="Favorite pet"
onChange={setSelected}
validationState={isValid ? 'valid' : 'invalid'}
description={isValid ? 'Please select a pet.' : null}
errorMessage={isValid ? null :
selected === 'cats'
? 'No cats allowed.'
: 'Please select dogs.'
}>
<Radio value="dogs">
Dogs
</Radio>
<Radio value="cats">
Cats
</Radio>
<Radio value="dragons">
Dragons
</Radio>
</MyRadioGroup>
);
}
function Example() {
let [
selected,
setSelected
] = React.useState(
'dogs'
);
let isValid =
selected === 'dogs';
return (
<MyRadioGroup
aria-label="Favorite pet"
onChange={setSelected}
validationState={isValid
? 'valid'
: 'invalid'}
description={isValid
? 'Please select a pet.'
: null}
errorMessage={isValid
? null
: selected ===
'cats'
? 'No cats allowed.'
: 'Please select dogs.'}
>
<Radio value="dogs">
Dogs
</Radio>
<Radio value="cats">
Cats
</Radio>
<Radio value="dragons">
Dragons
</Radio>
</MyRadioGroup>
);
}
Disabled#
The entire RadioGroup can be disabled with the isDisabled
prop.
<MyRadioGroup label="Favorite sport" isDisabled>
<Radio value="soccer">Soccer</Radio>
<Radio value="baseball">Baseball</Radio>
<Radio value="basketball">Basketball</Radio>
</MyRadioGroup>
<MyRadioGroup label="Favorite sport" isDisabled>
<Radio value="soccer">Soccer</Radio>
<Radio value="baseball">Baseball</Radio>
<Radio value="basketball">Basketball</Radio>
</MyRadioGroup>
<MyRadioGroup
label="Favorite sport"
isDisabled
>
<Radio value="soccer">
Soccer
</Radio>
<Radio value="baseball">
Baseball
</Radio>
<Radio value="basketball">
Basketball
</Radio>
</MyRadioGroup>
To disable an individual radio, pass isDisabled
to the Radio
instead.
<MyRadioGroup label="Favorite sport">
<Radio value="soccer">Soccer</Radio>
<Radio value="baseball" isDisabled>Baseball</Radio>
<Radio value="basketball">Basketball</Radio>
</MyRadioGroup>
<MyRadioGroup label="Favorite sport">
<Radio value="soccer">Soccer</Radio>
<Radio value="baseball" isDisabled>Baseball</Radio>
<Radio value="basketball">Basketball</Radio>
</MyRadioGroup>
<MyRadioGroup label="Favorite sport">
<Radio value="soccer">
Soccer
</Radio>
<Radio
value="baseball"
isDisabled
>
Baseball
</Radio>
<Radio value="basketball">
Basketball
</Radio>
</MyRadioGroup>
Read only#
The isReadOnly
prop makes the selection immutable. Unlike isDisabled
, the RadioGroup remains focusable.
See the MDN docs for more information.
<MyRadioGroup label="Favorite avatar" defaultValue="wizard" isReadOnly>
<Radio value="wizard">Wizard</Radio>
<Radio value="dragon">Dragon</Radio>
</MyRadioGroup>
<MyRadioGroup
label="Favorite avatar"
defaultValue="wizard"
isReadOnly
>
<Radio value="wizard">Wizard</Radio>
<Radio value="dragon">Dragon</Radio>
</MyRadioGroup>
<MyRadioGroup
label="Favorite avatar"
defaultValue="wizard"
isReadOnly
>
<Radio value="wizard">
Wizard
</Radio>
<Radio value="dragon">
Dragon
</Radio>
</MyRadioGroup>
HTML forms#
RadioGroup supports the name
prop, paired with the Radio value
prop, for integration with HTML forms.
<MyRadioGroup label="Favorite pet" name="pet">
<Radio value="dogs">Dogs</Radio>
<Radio value="cats">Cats</Radio>
</MyRadioGroup>
<MyRadioGroup label="Favorite pet" name="pet">
<Radio value="dogs">Dogs</Radio>
<Radio value="cats">Cats</Radio>
</MyRadioGroup>
<MyRadioGroup
label="Favorite pet"
name="pet"
>
<Radio value="dogs">
Dogs
</Radio>
<Radio value="cats">
Cats
</Radio>
</MyRadioGroup>
Advanced customization#
Hooks#
If you need to customize things further, such as accessing internal state or customizing DOM structure, you can drop down to the lower level Hook-based API. See useRadioGroup for more details.