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

48 lines
1.7 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 in multiple options.
2016-11-29 17:13:24 +08:00
- The difference between Select is that Radio is visible to user and can facilitate the comparison of choice. So, when you want to use Radio, option should not be too much.
## API
### Radio
2017-10-25 10:25:44 +08:00
| Property | Description | Type | optional | Default |
| -------- | ----------- | ---- | -------- | ------- |
2017-12-29 20:22:58 +08:00
| autoFocus | get focus when component mounted | boolean | false | |
2017-10-25 10:25:44 +08:00
| checked | Specifies whether the radio is selected. | boolean | | false |
| 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 | | none |
### RadioGroup
radio groupwrap a group of `Radio`
2017-10-25 10:25:44 +08:00
| Property | Description | Type | optional | Default |
| -------- | ----------- | ---- | -------- | ------- |
| defaultValue | Default selected value | any | none | none |
| disabled | Disable all radio buttons | boolean | | false |
| name | The `name` property of all `input[type="radio"]` children | string | | none |
2017-10-25 10:25:44 +08:00
| options | set children optional | string\[] \| Array<{ label: string value: string disabled?: boolean }> | 无 | 无 |
| size | Size, only on radio style | string | `large` `default` `small` | `default` |
| value | Used for setting the currently selected value. | any | none | none |
| onChange | The callback function that is triggered when the state changes. | Function(e:Event) | none | none |
## Methods
### Radio
| Name | Description |
| ---- | ----------- |
| blur() | remove focus |
2017-12-29 20:22:58 +08:00
| focus() | get focus |