Skip to main content

Interface: RadioGroupProps

Defined in: components/RadioGroup/RadioGroup.tsx:70

Props for the RadioGroup component.

Extends​

  • Omit<RACRadioGroupProps, "style" | "children">

Properties​

children?​

optional children?: ReactNode

Defined in: components/RadioGroup/RadioGroup.tsx:90

Radio option children — must be Radio components.

contextualHelp?​

optional contextualHelp?: ReactNode

Defined in: components/RadioGroup/RadioGroup.tsx:80

A <ContextualHelp> element rendered beside the label (the reference system's prop shape) — for the explanation too long for description.

description?​

optional description?: ReactNode

Defined in: components/RadioGroup/RadioGroup.tsx:82

Supplementary helper text linked to the group via aria-describedby.

errorMessage?​

optional errorMessage?: ReactNode

Defined in: components/RadioGroup/RadioGroup.tsx:88

Validation message shown when the group is invalid (isInvalid / validate). Supply caller-localized copy (i18n rule / §6); omit it and the platform's own constraint message is shown instead.

label?​

optional label?: ReactNode

Defined in: components/RadioGroup/RadioGroup.tsx:75

Group label displayed above the radio options.