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

35 lines
1.8 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
| Property | Description | Type | optional | Default |
|----------------|------------------------------------------|------------|---------|--------|
| checked | Specifies whether the radio is selected. | boolean | | false |
| defaultChecked | Specifies the initial state: whether or not the radio is selected. | boolean | | false |
2016-12-16 16:38:14 +08:00
| value | According to value for comparison, to determine whether the selected | any | | none |
| disabled | Disable radio | boolean | | false |
### RadioGroup
radio groupwrap a group of `Radio`
| Property | Description | Type | optional | Default |
|----------------|----------------------------------|-------------------|--------|--------|
2016-08-18 11:22:55 +08:00
| onChange | The callback function that is triggered when the state changes. | Function(e:Event) | none | none |
| value | Used for setting the currently selected value. | any | none | none |
| defaultValue | Default selected value | any | none | none |
| size | Size, only on radio style | string | `large` `default` `small` | `default` |
2017-03-28 11:56:38 +08:00
| options | set children optional | string[] \| Array<{ label: string value: string disabled?: boolean }> | 无 | 无 |
| disabled | Disable all radio buttons | boolean | | false |