RadioChoicesWidget
SourceSee Radio for props available
Parameter | Type | Description | |
---|---|---|---|
* | props An object with the properties below | ||
props.asyncChoices | AsyncChoicesInterface | Any AsyncChoices, if applicable. This typically comes from Field.asyncChoices. | |
props.choiceProps | Map | Any additional props to pass through to each choice. These are passed through to the Should be a | |
* | props.choices | Map|[ValueT, string][] | The choices to render. This can be a |
* | props.input | InputProps | The input props for the widget. This should include, at minimum:
Can also include
|
props.meta | Record | Any extra details such as field errors, touched status etc. The values here depend on the form library in use. If using @prestojs/final-form see FieldRenderProps for what this will be. | |
props.radioComponent | React.ComponentType | The component to use for each choice (ie. the radio button). Defaults to Radio. | |
... | any | Any properties from RadioGroupProps |
Basic Usage
Any extra props are passed through to Radio.Group.
Choices are rendered as:
<Radio.Group> <Radio key="1" value="1">One</Radio> <Radio key="2" value="2">Two</Radio> </Radio.Group>
You can customise the component used instead of Radio
by passing radioComponent
(eg. radioComponent={RadioChoicesWidget.Button}
).
You can pass any extra props to each Radio
by passing choiceProps
which is a Map
of choice value to the props to apply.