mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-21 21:28:09 +08:00
e4c5ab9c69
* Add a name property for RadioGroup * Add document for RadioGroup's name property * Add test case for RadioGroup name property
36 lines
1.9 KiB
Markdown
36 lines
1.9 KiB
Markdown
---
|
||
category: Components
|
||
type: Data Entry
|
||
title: Radio
|
||
---
|
||
|
||
Radio.
|
||
|
||
## When To Use
|
||
|
||
- Used to select a single state in multiple options.
|
||
- 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 |
|
||
| value | According to value for comparison, to determine whether the selected | any | | none |
|
||
| disabled | Disable radio | boolean | | false |
|
||
### RadioGroup
|
||
|
||
radio group，wrap a group of `Radio`。
|
||
|
||
| Property | Description | Type | optional | Default |
|
||
|----------------|----------------------------------|-------------------|--------|--------|
|
||
| name | The `name` property of all `input[type="radio"]` children | string | | none |
|
||
| 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` |
|
||
| options | set children optional | string[] \| Array<{ label: string value: string disabled?: boolean }> | 无 | 无 |
|
||
| disabled | Disable all radio buttons | boolean | | false | |