mirror of
https://github.com/element-plus/element-plus.git
synced 2026-03-13 07:51:17 +08:00
d64028509a
* feat(components): [radio-group] support options with el-radio-button * chore: rename prop * chore: add doc * Update radio-group.vue * Update radio.test.tsx * Update radio.test.tsx * refactor: change prop name and enum
164 lines
9.3 KiB
Markdown
164 lines
9.3 KiB
Markdown
---
|
||
title: Radio
|
||
lang: en-US
|
||
---
|
||
|
||
# Radio
|
||
|
||
Single selection among multiple options.
|
||
|
||
:::warning
|
||
|
||
`label` act as `value` has been **deprecated**, `label` is used only as display text, this action **will be** removed in ^(3.0.0), consider switching to new API.
|
||
|
||
:::
|
||
|
||
:::tip
|
||
|
||
New API `value` has been added in ^(2.6.0), the examples in the document all use the `value`.
|
||
If you are using a version **less than** ^(2.6.0), please refer to:
|
||
|
||
:::
|
||
|
||
```vue
|
||
<template>
|
||
<el-radio-group v-model="radio1">
|
||
<!-- works when >=2.6.0, recommended ✔️ not work when <2.6.0 ❌ -->
|
||
<el-radio value="Value 1">Option 1</el-radio>
|
||
<!-- works when <2.6.0, deprecated act as value when >=3.0.0 -->
|
||
<el-radio label="Label 2 & Value 2">Option 2</el-radio>
|
||
</el-radio-group>
|
||
</template>
|
||
```
|
||
|
||
## Basic usage
|
||
|
||
Radio should not have too many options. Otherwise, use the Select component instead.
|
||
|
||
:::demo Creating a radio component is easy, you just need to bind a variable to Radio's `v-model`. It equals to the value of `value` of the chosen radio. The type of `value` is `String`, `Number` or `Boolean`.
|
||
|
||
radio/basic-usage
|
||
|
||
:::
|
||
|
||
## Disabled
|
||
|
||
`disabled` attribute is used to disable the radio.
|
||
|
||
:::demo You just need to add the `disabled` attribute.
|
||
|
||
radio/disabled
|
||
|
||
:::
|
||
|
||
## Radio Group
|
||
|
||
Suitable for choosing from some mutually exclusive options.
|
||
|
||
:::demo Combine `el-radio-group` with `el-radio` to display a radio group. Bind a variable with `v-model` of `el-radio-group` element and set label value in `el-radio`. It also provides `change` event with the current value as its parameter.
|
||
|
||
radio/radio-group
|
||
|
||
:::
|
||
|
||
## With borders
|
||
|
||
:::demo The `border` attribute adds a border to Radios.
|
||
|
||
radio/with-borders
|
||
|
||
:::
|
||
|
||
## Options attribute ^(2.11.2)
|
||
|
||
:::demo Shortcut from basic `el-radio-group` usage. You can customize the alias of the `options` through the `props` attribute.
|
||
|
||
radio/options
|
||
|
||
:::
|
||
|
||
## Radio Button
|
||
|
||
Radio with button group visual effect.
|
||
|
||
:::demo You just need to change `el-radio` element into `el-radio-button` element. You can also set the style of the button when it is active by using `fill` and `text-color`.
|
||
|
||
radio/radio-button
|
||
|
||
:::
|
||
|
||
## Radio API
|
||
|
||
### Radio Attributes
|
||
|
||
| Name | Description | Type | Default |
|
||
| --------------------- | ---------------------------------------------------------------------- | ---------------------------------------- | ------- |
|
||
| model-value / v-model | binding value | ^[string] / ^[number] / ^[boolean] | — |
|
||
| value ^(2.6.0) | the value of Radio | ^[string] / ^[number] / ^[boolean] | — |
|
||
| label | the label of Radio. If there's no `value`, `label` will act as `value` | ^[string] / ^[number] / ^[boolean] | — |
|
||
| disabled | whether Radio is disabled | ^[boolean] | false |
|
||
| border | whether to add a border around Radio | ^[boolean] | false |
|
||
| size | size of the Radio | ^[enum]`'large' \| 'default' \| 'small'` | — |
|
||
| name | native `name` attribute | ^[string] | — |
|
||
|
||
### Radio Events
|
||
|
||
| Name | Description | Type |
|
||
| ------ | ------------------------------------- | --------------------------------------------------------- |
|
||
| change | triggers when the bound value changes | ^[Function]`(value: string \| number \| boolean) => void` |
|
||
|
||
### Radio Slots
|
||
|
||
| Name | Description |
|
||
| ------- | ------------------------- |
|
||
| default | customize default content |
|
||
|
||
## RadioGroup API
|
||
|
||
### RadioGroup Attributes
|
||
|
||
| Name | Description | Type | Default |
|
||
| --------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------- |
|
||
| model-value / v-model | binding value | ^[string] / ^[number] / ^[boolean] | — |
|
||
| size | the size of radio buttons or bordered radios | ^[string] | default |
|
||
| disabled | whether the nesting radios are disabled | ^[boolean] | false |
|
||
| validate-event | whether to trigger form validation | ^[boolean] | true |
|
||
| text-color | font color when button is active | ^[string] | #ffffff |
|
||
| fill | border and background color when button is active | ^[string] | #409eff |
|
||
| aria-label ^(a11y) ^(2.7.2) | same as `aria-label` in RadioGroup | ^[string] | — |
|
||
| name | native `name` attribute | ^[string] | — |
|
||
| id | native `id` attribute | ^[string] | — |
|
||
| label ^(a11y) ^(deprecated) | same as `aria-label` in RadioGroup | ^[string] | — |
|
||
| options ^(2.11.2) | data of the options, the key of `value` and `label` and `disabled` can be customize by `props` | ^[array]`Array<{[key: string]: any}>` | — |
|
||
| props ^(2.11.2) | configuration options | ^[object]`{ value?: string, label?: string, disabled?: boolean}` | `{value: 'value', label: 'label', disabled: 'disabled'}` |
|
||
| type ^(2.11.5) | component type to render options (e.g. `'button'`) | ^[enum]`'radio' \| 'button'` | 'radio' |
|
||
|
||
### RadioGroup Events
|
||
|
||
| Name | Description | Type |
|
||
| ------ | ------------------------------------- | --------------------------------------------------------- |
|
||
| change | triggers when the bound value changes | ^[Function]`(value: string \| number \| boolean) => void` |
|
||
|
||
### RadioGroup Slots
|
||
|
||
| Name | Description | Subtags |
|
||
| ------- | ------------------------- | ------------------- |
|
||
| default | customize default content | Radio / RadioButton |
|
||
|
||
## RadioButton API
|
||
|
||
### RadioButton Attributes
|
||
|
||
| Name | Description | Type | Default |
|
||
| -------------- | ---------------------------------------------------------------------- | ---------------------------------- | ------- |
|
||
| value ^(2.6.0) | the value of Radio | ^[string] / ^[number] / ^[boolean] | — |
|
||
| label | the label of Radio. If there's no `value`, `label` will act as `value` | ^[string] / ^[number] / ^[boolean] | — |
|
||
| disabled | whether Radio is disabled | ^[boolean] | false |
|
||
| name | native 'name' attribute | ^[string] | — |
|
||
|
||
### RadioButton Slots
|
||
|
||
| Name | Description |
|
||
| ------- | ------------------------- |
|
||
| default | customize default content |
|