2016-07-21 10:10:04 +08:00
---
category: Components
2022-11-09 12:28:04 +08:00
group: Data Entry
2016-07-21 10:10:04 +08:00
title: Radio
2022-11-30 20:14:41 +08:00
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*M-YKTJnWM2kAAAAAAAAAAAAADrJ8AQ/original
2022-11-09 12:28:04 +08:00
demo:
cols: 2
2016-07-21 10:10:04 +08:00
---
Radio.
2016-09-10 13:43:30 +08:00
## When To Use
2016-07-21 10:10:04 +08:00
2018-10-21 12:44:03 +08:00
- 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.
2016-07-21 10:10:04 +08:00
2022-11-09 12:28:04 +08:00
## Examples
2022-11-17 17:31:26 +08:00
<!-- prettier - ignore -->
2022-11-09 12:28:04 +08:00
< code src = "./demo/basic.tsx" > Basic< / code >
< code src = "./demo/disabled.tsx" > disabled< / code >
< code src = "./demo/radiogroup.tsx" > Radio Group< / code >
< code src = "./demo/radiogroup-more.tsx" > Vertical Radio.Group< / code >
< code src = "./demo/radiogroup-options.tsx" > Radio.Group group - optional< / code >
< code src = "./demo/radiobutton.tsx" > radio style< / code >
< code src = "./demo/radiogroup-with-name.tsx" > Radio.Group with name< / code >
< code src = "./demo/size.tsx" > Size< / code >
< code src = "./demo/radiobutton-solid.tsx" > Solid radio button< / code >
< code src = "./demo/badge.tsx" debug > 测试 Badge 的样式< / code >
2016-07-21 10:10:04 +08:00
## API
2020-02-26 16:09:22 +08:00
### Radio/Radio.Button
2016-07-21 10:10:04 +08:00
2019-11-22 14:37:39 +08:00
| Property | Description | Type | Default |
| --- | --- | --- | --- |
2020-07-01 16:21:56 +08:00
| autoFocus | Whether get focus when component mounted | boolean | false |
| checked | Specifies whether the radio is selected | boolean | false |
| defaultChecked | Specifies the initial state: whether or not the radio is selected | boolean | false |
2019-11-22 14:37:39 +08:00
| disabled | Disable radio | boolean | false |
2020-07-01 16:21:56 +08:00
| value | According to value for comparison, to determine whether the selected | any | - |
2017-10-25 10:25:44 +08:00
2016-07-21 10:10:04 +08:00
### RadioGroup
2018-06-28 14:18:23 +08:00
Radio group can wrap a group of `Radio` 。
2020-06-28 22:41:59 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
2020-10-21 10:33:43 +08:00
| buttonStyle | The style type of radio button | `outline` \| `solid` | `outline` | |
2020-07-01 16:21:56 +08:00
| defaultValue | Default selected value | any | - | |
2020-06-28 22:41:59 +08:00
| disabled | Disable all radio buttons | boolean | false | |
2020-07-01 16:21:56 +08:00
| name | The `name` property of all `input[type="radio"]` children | string | - | |
2022-11-24 23:51:00 +08:00
| options | Set children optional | string\[] \| number\[] \| Array< { label: ReactNode; value: string; disabled?: boolean; }> | - | |
2020-10-21 10:33:43 +08:00
| optionType | Set Radio optionType | `default` \| `button` | `default` | 4.4.0 |
2020-07-01 16:21:56 +08:00
| size | The size of 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) | - | |
2017-12-01 19:28:41 +08:00
## Methods
### Radio
2022-01-12 22:57:43 +08:00
| Name | Description |
| ------- | ------------ |
| blur() | Remove focus |
| focus() | Get focus |