2016-11-10 13:46:55 +00:00
## Radio
2016-11-11 11:06:27 +00:00
Single selection among multiple options.
2016-11-10 13:46:55 +00:00
2016-11-11 11:06:27 +00:00
### Basic usage
2016-11-10 13:46:55 +00:00
2016-11-11 11:06:27 +00:00
Radio should not have too many options. Otherwise, use the Select component instead.
2016-11-10 13:46:55 +00:00
2017-08-25 05:37:56 +00:00
:::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 `label` of the chosen radio. The type of `label` is `String` , `Number` or `Boolean` .
2016-11-10 13:46:55 +00:00
```html
< template >
2017-08-25 05:37:56 +00:00
< el-radio v-model = "radio" label = "1" > Option A< / el-radio >
< el-radio v-model = "radio" label = "2" > Option B< / el-radio >
2016-11-10 13:46:55 +00:00
< / template >
< script >
export default {
data () {
return {
2016-11-14 10:10:52 +00:00
radio: '1'
2016-11-10 13:46:55 +00:00
};
}
}
< / script >
```
:::
### Disabled
2016-11-11 11:06:27 +00:00
`disabled` attribute is used to disable the radio.
2016-11-10 13:46:55 +00:00
2016-11-11 11:06:27 +00:00
:::demo You just need to add the `disabled` attribute.
2016-11-10 13:46:55 +00:00
```html
< template >
2019-04-12 02:40:46 +00:00
< el-radio disabled v-model = "radio" label = "disabled" > Option A< / el-radio >
< el-radio disabled v-model = "radio" label = "selected and disabled" > Option B< / el-radio >
2016-11-10 13:46:55 +00:00
< / template >
< script >
export default {
data () {
return {
2019-04-12 02:40:46 +00:00
radio: 'selected and disabled'
2016-11-10 13:46:55 +00:00
};
}
}
< / script >
```
:::
### Radio button group
2017-01-18 07:12:26 +00:00
Suitable for choosing from some mutually exclusive options.
2016-11-10 13:46:55 +00:00
2017-08-25 05:37:56 +00:00
:::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.
2016-11-10 13:46:55 +00:00
```html
2019-04-12 02:40:46 +00:00
< el-radio-group v-model = "radio" >
2017-08-25 05:37:56 +00:00
< el-radio :label = "3" > Option A< / el-radio >
< el-radio :label = "6" > Option B< / el-radio >
< el-radio :label = "9" > Option C< / el-radio >
2016-11-10 13:46:55 +00:00
< / el-radio-group >
2016-11-14 10:10:52 +00:00
< script >
export default {
data () {
return {
2019-04-12 02:40:46 +00:00
radio: 3
2016-11-14 10:10:52 +00:00
};
}
}
< / script >
2016-11-10 13:46:55 +00:00
```
:::
### Button style
Radio with button styles.
2017-08-25 05:37:56 +00:00
:::demo You just need to change `el-radio` element into `el-radio-button` element. We also provide `size` attribute.
2016-11-10 13:46:55 +00:00
```html
2017-08-25 05:37:56 +00:00
< template >
< div >
2019-04-12 02:40:46 +00:00
< el-radio-group v-model = "radio1" >
2017-08-25 05:37:56 +00:00
< el-radio-button label = "New York" > < / el-radio-button >
< el-radio-button label = "Washington" > < / el-radio-button >
< el-radio-button label = "Los Angeles" > < / el-radio-button >
< el-radio-button label = "Chicago" > < / el-radio-button >
< / el-radio-group >
< / div >
< div style = "margin-top: 20px" >
2019-04-12 02:40:46 +00:00
< el-radio-group v-model = "radio2" size = "medium" >
2017-08-25 05:37:56 +00:00
< el-radio-button label = "New York" > < / el-radio-button >
< el-radio-button label = "Washington" > < / el-radio-button >
< el-radio-button label = "Los Angeles" > < / el-radio-button >
< el-radio-button label = "Chicago" > < / el-radio-button >
< / el-radio-group >
< / div >
< div style = "margin-top: 20px" >
2019-04-12 02:40:46 +00:00
< el-radio-group v-model = "radio3" size = "small" >
2017-08-25 05:37:56 +00:00
< el-radio-button label = "New York" > < / el-radio-button >
< el-radio-button label = "Washington" disabled > < / el-radio-button >
< el-radio-button label = "Los Angeles" > < / el-radio-button >
< el-radio-button label = "Chicago" > < / el-radio-button >
< / el-radio-group >
< / div >
< div style = "margin-top: 20px" >
2019-04-12 02:40:46 +00:00
< el-radio-group v-model = "radio4" disabled size = "mini" >
2017-08-25 05:37:56 +00:00
< el-radio-button label = "New York" > < / el-radio-button >
< el-radio-button label = "Washington" > < / el-radio-button >
< el-radio-button label = "Los Angeles" > < / el-radio-button >
< el-radio-button label = "Chicago" > < / el-radio-button >
< / el-radio-group >
< / div >
< / template >
2016-11-10 13:46:55 +00:00
2016-11-11 11:06:27 +00:00
< script >
export default {
data () {
return {
2019-04-12 02:40:46 +00:00
radio1: 'New York',
radio2: 'New York',
2017-01-16 02:43:10 +00:00
radio3: 'New York',
2019-04-12 02:40:46 +00:00
radio4: 'New York'
2017-08-25 05:37:56 +00:00
};
}
}
< / script >
```
:::
### With borders
:::demo The `border` attribute adds a border to Radios.
```html
< template >
< div >
2019-04-12 02:40:46 +00:00
< el-radio v-model = "radio1" label = "1" border > Option A< / el-radio >
< el-radio v-model = "radio1" label = "2" border > Option B< / el-radio >
2017-08-25 05:37:56 +00:00
< / div >
< div style = "margin-top: 20px" >
2019-04-12 02:40:46 +00:00
< el-radio v-model = "radio2" label = "1" border size = "medium" > Option A< / el-radio >
< el-radio v-model = "radio2" label = "2" border size = "medium" > Option B< / el-radio >
2017-08-25 05:37:56 +00:00
< / div >
< div style = "margin-top: 20px" >
2019-04-12 02:40:46 +00:00
< el-radio-group v-model = "radio3" size = "small" >
2017-08-25 05:37:56 +00:00
< el-radio label = "1" border > Option A< / el-radio >
< el-radio label = "2" border disabled > Option B< / el-radio >
< / el-radio-group >
< / div >
< div style = "margin-top: 20px" >
2019-04-12 02:40:46 +00:00
< el-radio-group v-model = "radio4" size = "mini" disabled >
2017-08-25 05:37:56 +00:00
< el-radio label = "1" border > Option A< / el-radio >
< el-radio label = "2" border > Option B< / el-radio >
< / el-radio-group >
< / div >
< / template >
< script >
export default {
data () {
return {
2019-04-12 02:40:46 +00:00
radio1: '1',
radio2: '1',
radio3: '1',
radio4: '1'
2016-11-11 11:06:27 +00:00
};
}
}
< / script >
```
2016-11-10 13:46:55 +00:00
:::
### Radio Attributes
2017-01-18 07:12:26 +00:00
Attribute | Description | Type | Accepted Values | Default
2016-11-10 13:46:55 +00:00
---- | ---- | ---- | ---- | ----
2019-01-23 03:34:19 +00:00
value / v-model | binding value | string / number / boolean | — | —
2017-08-25 05:37:56 +00:00
label | the value of Radio | 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, only works when `border` is true | string | medium / small / mini | —
2017-01-18 07:12:26 +00:00
name | native 'name' attribute | string | — | —
2016-11-10 13:46:55 +00:00
2017-08-08 04:39:19 +00:00
### Radio Events
| Event Name | Description | Parameters |
| --- | --- | --- |
| change | triggers when the bound value changes | the label value of the chosen radio |
2016-11-10 13:46:55 +00:00
### Radio-group Attributes
2017-01-18 07:12:26 +00:00
Attribute | Description | Type | Accepted Values | Default
2016-11-10 13:46:55 +00:00
---- | ---- | ---- | ---- | ----
2019-01-23 03:34:19 +00:00
value / v-model | binding value | string / number / boolean | — | —
2017-08-25 05:37:56 +00:00
size | the size of radio buttons or bordered radios | string | medium / small / mini | —
disabled | whether the nesting radios are disabled | boolean | — | false
2016-12-20 08:21:44 +00:00
text-color | font color when button is active | string | — | #ffffff |
2017-09-30 07:50:04 +00:00
fill | border and background color when button is active | string | — | #409EFF |
2016-11-10 13:46:55 +00:00
### Radio-group Events
2016-11-11 11:06:27 +00:00
| Event Name | Description | Parameters |
2017-08-08 04:39:19 +00:00
| --- | --- | --- |
| change | triggers when the bound value changes | the label value of the chosen radio |
2016-11-10 13:46:55 +00:00
### Radio-button Attributes
2017-01-18 07:12:26 +00:00
Attribute | Description | Type | Accepted Values | Default
2016-11-10 13:46:55 +00:00
---- | ---- | ---- | ---- | ----
2017-08-25 05:37:56 +00:00
label | the value of radio | string / number | — | —
2016-11-11 11:06:27 +00:00
disabled | whether radio is disabled | boolean | — | false
2017-08-25 05:37:56 +00:00
name | native 'name' attribute | string | — | —