Radio Group
Radios provide users with different selection and activation tools.
| install | yarn add @clayui/form |
|---|---|
| version | 3.122.0 |
Form.RadioGroup
| Property | Description |
|---|---|
childrenArray<
React.ReactElement<IRadioProps> | React.ReactElement<IToggleProps>
> | Takes either Radio or Toggle as a child. |
defaultValueReact.ReactText | Property to set the default value (uncontrolled). |
inlineboolean | Flag to indicate if radio elements should display inline. |
namestring | Form element name that is applied to each radio element. |
onChangeInternalDispatch<React.ReactText> | Callback function for whenever a radio element is selected (controlled). |
onSelectedValueChangeInternalDispatch<React.ReactText> | Callback function for whenever a radio element is selected.
@deprecated since v3.51.0 - use onChange instead. |
selectedValueReact.ReactText | The value that corresponds to the selected radio element. Leave
undefined if no option is selected.
@deprecated since v3.51.0 - use value instead. |
valueReact.ReactText | The value property sets the current value (controlled). |
Form.Radio
| Property | Description |
|---|---|
containerPropsReact.HTMLAttributes<HTMLDivElement> | Props for the outer most container element. The default value is {className: ''} |
inlineboolean | Flag to indicate if radio elements should display inline. |
labelReact.ReactText | Text to describe for radio element. |
valueReact.ReactText | Value provided if element is selected. |