Radio Group
yarn add @clayui/form
Radios provide users with different selection and activation tools.
Form.RadioGroup
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
children | Array< React.ReactElement<IRadioProps> | React.ReactElement<IToggleProps> > | true | Takes either Radio or Toggle as a child. | |
defaultValue | React.ReactText | false | Property to set the default value (uncontrolled). | |
inline | boolean | false | Flag to indicate if radio elements should display inline. | |
name | string | false | Form element `name` that is applied to each radio element. | |
onChange | InternalDispatch<React.ReactText> | false | Callback function for whenever a radio element is selected (controlled). | |
onSelectedValueChange | InternalDispatch<React.ReactText> | false | Callback function for whenever a radio element is selected. @deprecated since v3.51.0 - use `onChange` instead. | |
selectedValue | React.ReactText | false | The value that corresponds to the selected radio element. Leave undefined if no option is selected. @deprecated since v3.51.0 - use `value` instead. | |
value | React.ReactText | false | The value property sets the current value (controlled). |
Form.Radio
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
containerProps | React.HTMLAttributes<HTMLDivElement> | false | {className: ''} | Props for the outer most container element. |
inline | boolean | false | Flag to indicate if radio elements should display inline. | |
label | React.ReactText | false | Text to describe for radio element. | |
value | React.ReactText | true | Value provided if element is selected. |