mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-04 13:08:41 +08:00
882cec62d6
* docs: Add components overview page * fix detail * remove ContributorsList form overview page * fix components url * improve code style * remove extra file * fix detail * fix lint * fix lint * docs: Finish components overview page * fix lint * docs: Update cover * fix lint * update cover * update menu * improve overview page * refactor code * fix order * update title * add components count * fix overview page ssr bug * move less file * update title margin Co-authored-by: arvinxx <arvinx@foxmail.com>
50 lines
1.7 KiB
Markdown
50 lines
1.7 KiB
Markdown
---
|
|
category: Components
|
|
type: Data Entry
|
|
title: Radio
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/jhSTlg4WQ/Radio.svg
|
|
---
|
|
|
|
Radio.
|
|
|
|
## 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 | |
|
|
|
|
### RadioGroup
|
|
|
|
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 }> | |
|
|
| 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 |
|