ant-design/components/radio/index.en-US.md

49 lines
1.6 KiB
Markdown
Raw Normal View History

---
category: Components
type: Data Entry
title: Radio
---
Radio.
2016-09-10 13:43:30 +08:00
## When To Use
- Used to select a single state from multiple options.
- The difference from Select is that Radio is visible to the user and can facilitate the comparison of choice, which means there shouldn't be too many of them.
## API
### Radio/Radio.Button
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| autoFocus | get focus when component mounted | boolean | false |
| checked | Specifies whether the radio is selected. | boolean | |
| defaultChecked | Specifies the initial state: whether or not the radio is selected. | boolean | false |
| disabled | Disable radio | boolean | false |
| value | According to value for comparison, to determine whether the selected | any | |
2017-10-25 10:25:44 +08:00
### RadioGroup
2018-06-28 14:18:23 +08:00
Radio group can wrap a group of `Radio`
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| defaultValue | Default selected value | any | |
| disabled | Disable all radio buttons | boolean | false |
| name | The `name` property of all `input[type="radio"]` children | string | |
| options | set children optional | string\[] \| Array<{ label: string value: string disabled?: boolean }> | |
2020-03-01 18:24:59 +08:00
| size | size for radio button style | `large` \| `middle` \| `small` | |
| value | Used for setting the currently selected value. | any | |
| onChange | The callback function that is triggered when the state changes. | Function(e:Event) | |
| buttonStyle | style type of radio button | `outline` \| `solid` | `outline` |
## Methods
### Radio
| Name | Description |
| ------- | ------------ |
| blur() | remove focus |
| focus() | get focus |