Prepared Docs

Prepared Docs

⌘K

    Loading navigation…

User

  1. Components
  2. Radio
  3. API and Development

Radio

API and Development

View Source
Submit Issue

RadioItem and RadioGroup provide single-selection interfaces for choosing one option from a set of mutually exclusive choices. RadioItem displays a standalone radio button, while RadioGroupItem is used within RadioGroup for managed selection. The components are built on Radix UI and ensure consistent selection patterns across the interface with full keyboard and screen reader accessibility.

For card-based single-select with descriptions, see Radio cards.

Props

RadioItem

NameDefaultDescription
valuerequiredThe value of the radio button.
nameThe name attribute for grouping standalone radio inputs.
labelValueText to display as the label. If not provided, children is used.
labelPositionRadioLabelPosition.RightPosition of the label relative to the radio button. Options: Left, Right.
checkedWhether the radio button is checked (controlled component).
defaultCheckedWhether the radio button is checked by default (uncontrolled component).
disabledfalseWhether the radio button is disabled.
childrenLabel content when labelValue is not provided.

RadioGroup

NameDefaultDescription
childrenrequiredRadioGroupItem components to display in the group.
nameThe name attribute for the radio group.
valueCurrently selected value (controlled component).
defaultValueDefault selected value (uncontrolled component).
onValueChangeCallback function called when selection changes: (value: string) => void.
directionFlexDirection.ColumnLayout direction for radio buttons. Options: Column, Row.
labelOptional label text displayed above the radio group.
labelTypeTextType.BodyBaseText type for the group label.

Basic Radio Group

Use for simple single-selection lists.

Radio with Label Position

Control label placement relative to the radio button.

Right Position (Default)

Left Position

Radio Group with Label

Add a group label to provide context.

Horizontal Radio Group

Arrange radio buttons horizontally.

Controlled Radio Group

Control selection state programmatically.

Disabled Radio

Disable specific options or the entire group.

Radio with Children

Use children for label content when you need more control.

Previous

Radio / Usage

Next

Radio / Accessibility

On this page

Props
RadioItem
RadioGroup
Basic Radio Group
Radio with Label Position
Right Position (Default)
Left Position
Radio Group with Label
Horizontal Radio Group
Controlled Radio Group
Disabled Radio
Radio with Children