Radio
Radio group displays a set of options and allows user to select only one.
#
#
#
RadioGroup automatically positions radios horizontally, if there are no more than 3 radios and none of them have descriptions.
#
#
#
Set isDisabled on the <RadioGroup /> to disable all options.
Or set isDisabled on a <Radio /> to disable that specific option.
#
#
- When user selects exactly one option from a small labeled set, especially when options benefit from descriptions.
#
- If there are many options or descriptions aren't needed, use a select instead.
- If options are views or modes on the same content, use a segmented control instead.
- If multiple options can be selected, use checkboxes instead.
#
#
| Name | Default | Description |
|---|---|---|
isDisabled | false | booleanDetermines if all radios are disabled. |
children | — | ReactNodeRadio inputs. |
orientation | "horizontal" | "horizontal" | "vertical"Orientation. |
value | — | TSelected radio value. |
width | — | "auto"
| "100%"
| "fit-content"
| "4xs"
| "3xs"
| "2xs"
| "xs"
| "sm"
| "md"
| "lg"
| "xl"Radio group width. |
onChange | — | (value: T) => voidCallback for when user selects a different radio option. |
#
| Name | Default | Description |
|---|---|---|
isDisabled | — | booleanDetermines if radio is disabled. |
label | — | stringLabel to show near the radio. |
badge | — | ReactNodeBadge to display near the label. |
description | — | ReactNodeDescription to show below the label. |
tooltip | — | Omit<TooltipProps, "children">Tooltip to display when hovering over the radio. These props are passed to the tooltip component. |
value | — | TRadio value. |