Radio group

A radio group presents a list of options where only one choice can be selected.

Props

analyticsContext

Description

Additional information to be included in the context of analytics events that come from radio.

Type{ [x: string]: any; }

aria-labelledby

Deprecated
Description

The id of the element that links to this radio group.

Use the labelId prop instead.

Typestring

defaultValue

Description

Sets the initial selected value on the RadioGroup.

Typestring

id

Description
No description.
Typestring

isDisabled

Description

Sets the disabled state of all Radio elements in the group. Overrides the isDisabled setting of all child Radio items.

Typeboolean

isInvalid

Description

Sets the invalid state of all Radio elements in the group.

Typeboolean

isRequired

Description

Sets the required state of all Radio elements in the group.

Typeboolean

labelId

Description

This sets the aria-labelledby attribute. It sets an accessible name for the radio, for people who use assistive technology. Use of a visible label is highly recommended for greater accessibility support.

Typestring

name

Description

Sets the name prop on each of the Radio elements in the group.

Typestring

onChange

Description

Function that gets after each change event.

Type(e: React.ChangeEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent) => void

onInvalid

Description

Function that gets fired after each invalid event.

Type(event: React.SyntheticEvent<any, Event>) => void

options

Required
Description

An array of objects, each object is mapped onto a Radio element within the group. Name must be unique to the group.

TypeOptionPropType[]

testId

Description

A testId prop is provided for specified elements, which is a unique string that appears as a data attribute data-testid in the rendered code, serving as a hook for automated tests. The specified testId is applied to the root element of RadioGroup. If no testId is supplied in the options prop, then the one supplied to RadioGroup will also be propagated to the Radio children. Otherwise, the testId supplied in the options prop will be used.

See here for details about how testId is used on Radio.

Typestring

value

Description

Once set, controls the selected value on the RadioGroup.

Typestring
Was this page helpful?
We use this feedback to improve our documentation.
© 2026 AtlassianTrademark, (opens new window)Privacy, (opens new window)License