mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-28 21:19:37 +08:00
fb0b4f0fc9
* docs: add api first appearance * docs: fix auto-complete doc * docs: replace Version Added with Version * docs: date picker common method * docs: date picker common method * docs: tree * docs: remove meaningless 3.0.0
49 lines
1.8 KiB
Markdown
49 lines
1.8 KiB
Markdown
---
|
||
category: Components
|
||
subtitle: 单选框
|
||
type: 数据录入
|
||
title: Radio
|
||
---
|
||
|
||
单选框。
|
||
|
||
## 何时使用
|
||
|
||
- 用于在多个备选项中选中单个状态。
|
||
- 和 Select 的区别是,Radio 所有选项默认可见,方便用户在比较中选择,因此选项不宜过多。
|
||
|
||
## API
|
||
|
||
### Radio
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| -------------- | --------------------------------- | ------- | ------ | ---- |
|
||
| autoFocus | 自动获取焦点 | boolean | false | |
|
||
| checked | 指定当前是否选中 | boolean | false | |
|
||
| defaultChecked | 初始是否选中 | boolean | false | |
|
||
| value | 根据 value 进行比较,判断是否选中 | any | - | |
|
||
|
||
### RadioGroup
|
||
|
||
单选框组合,用于包裹一组 `Radio`。
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --- | --- | --- | --- | --- |
|
||
| defaultValue | 默认选中的值 | any | - | |
|
||
| disabled | 禁选所有子单选器 | boolean | false | 3.6.5 |
|
||
| name | RadioGroup 下所有 `input[type="radio"]` 的 `name` 属性 | string | - | |
|
||
| options | 以配置形式设置子元素 | string\[] \| Array<{ label: string value: string disabled?: boolean }> | - | |
|
||
| size | 大小,只对按钮样式生效 | `large` \| `default` \| `small` | `default` | |
|
||
| value | 用于设置当前选中的值 | any | - | |
|
||
| onChange | 选项变化时的回调函数 | Function(e:Event) | - | |
|
||
| buttonStyle | RadioButton 的风格样式,目前有描边和填色两种风格 | `outline` \| `solid` | `outline` | 3.7.0 |
|
||
|
||
## 方法
|
||
|
||
### Radio
|
||
|
||
| 名称 | 描述 | 版本 |
|
||
| ------- | -------- | ---- |
|
||
| blur() | 移除焦点 | |
|
||
| focus() | 获取焦点 | |
|