Skip to main content

Radio - Radio button

Effect demonstration

1. Default effect

<Radio
options={[
{ label: 'Apple', value: 'Apple' },
{ label: 'Pear', value: 'Pear' },
{ label: 'Orange', value: 'Orange' },
]}
/>

2. Selected by default

<Radio
options={[
{ label: 'Apple', value: 'Apple' },
{ label: 'Pear', value: 'Pear' },
{ label: 'Orange', value: 'Orange' },
]}
defaultValue={'Pear'}
/>

3. Disable something

<Radio
options={[
{ label: 'Apple', value: 'Apple' },
{ label: 'Pear', value: 'Pear' },
{ label: 'Orange', value: 'Orange' },
]}
disabledValue={['Apple']}
/>

4. RadioList

<RadioList
options={[
{ label: 'Apple', value: 'Apple' },
{ label: 'Pear', value: 'Pear' },
{ label: 'Orange', value: 'Orange' },
]}
/>

API

Radio /RadioList

PropertiesRequiredDescriptionTypeDefault Value
optionstrueSpecify optionsRadioOption[]
valuefalseselected itemReactText
onChangefalseThe callback function triggered by selecting the radio button(value: ReactText) => void
defaultValuefalseDefault selected itemsReactText
sizefalseicon sizenumber
disabledValuefalseSet disabled itemsReactText[]
containerStylefalseCustom container styleViewStyle
itemStylefalseCustomize the style of a single radio buttonViewStyle
labelStylefalseCustom text styleTextStyle
activeOpacityfalseOpacity when not disablednumber0.6

RadioItem

PropertiesRequiredDescriptionTypeDefault Value
itemStylefalseCustomize the style of a single radio buttonViewStyle
labelStylefalseCustom text styleTextStyle
sizefalseicon sizenumber
activeOpacityfalseOpacity when not disablednumber0.6
labeltrueradio button textReactNode
valuetrueThe value of the radio buttonReactText
statustrueRadio button checked status'checked' | 'unchecked'
disabledtrueRadio button disabled stateboolean
modefalseRadio button mode, list means display in a list'list' | 'row'
onChangefalseThe callback function triggered by selecting the radio button(value: ReactText, status: RadioStatus) => void
isLastfalseWhether it is the last onebooleanfalse