Checkbox 多选框
一组备选项中进行多选。
警告
使用 label
作为 value
已被废弃,label
仅作为显示文本,此操作**将**在 3.0.0 版本中被移除,请考虑切换到新的 API。
提示
新 API value
已在 2.6.0 版本中添加,文档中的示例均使用 value
。如果您使用的版本**低于** 2.6.0 并且正在使用 checkbox-group
,请参考
vue
<template>
<el-checkbox-group v-model="checkList">
<!-- works when >=2.6.0, recommended ✔️ value not work when <2.6.0 ❌ -->
<el-checkbox label="Option 1" value="Value 1" />
<!-- works when <2.6.0, deprecated act as value when >=3.0.0 -->
<el-checkbox label="Option 2 & Value 2" />
</el-checkbox-group>
</template>
基础用法
Checkbox 可以单独使用,切换两种状态。
在 el-checkbox
中定义 v-model
(绑定变量)。单个 checkbox
中,默认绑定变量的值是 Boolean
,选中为 true
。el-checkbox
标签内的内容将成为复选框按钮后的描述文字。
禁用状态
多选框的禁用状态。
设置 disabled
属性。
多选框组
适用于多个勾选框绑定成一组,通过是否勾选来表示这一组选项中选中的项。
checkbox-group
元素能把多个 checkbox 管理为一组,只需要在 v-model
中绑定一个 Array
类型的变量即可。el-checkbox
的 value
属性是当 checkbox 选中时的值。如果该标签中没有嵌套内容,label
会被渲染为 checkbox 按钮后的文字。这个 value
也与数组中的元素值相对应。如果数组中包含某个值,那么这个值对应的 checkbox 就被选中,反之亦然。
不确定状态
indeterminate
属性可以帮你实现“全选”的效果。
可选项目数量的限制
min
和 max
属性可以帮助你限制可选项目的数量。
按钮样式
按钮样式的多选框。
你只需要把 el-checkbox
元素换成 el-checkbox-button
元素。我们还提供了 size
属性。
带有边框
border
属性可以给多选框增加边框。
Checkbox API
Checkbox 属性
名称 | 描述 | 类型 | 默认值 |
---|---|---|---|
model-value / v-model | 绑定值 | string / number / boolean | — |
value 2.6.0 | 当与 checkbox-group 一起使用时,复选框的值 | string / number / boolean / object | — |
label | 当与 checkbox-group 一起使用时,复选框的标签。如果没有值,label 将作为 value | string / number / boolean / object | — |
true-value 2.6.0 | 如果复选框被选中,它的值 | string / number | — |
false-value 2.6.0 | 如果复选框未被选中,它的值 | string / number | — |
disabled | 复选框是否被禁用 | boolean | false |
边框 | 是否在复选框周围添加边框 | boolean | false |
size | 复选框的尺寸 | 枚举 | — |
名称 | 原生 'name' 属性 | string | — |
选中 | 复选框是否被选中 | boolean | false |
不确定状态 | 设置不确定状态,只负责样式控制 | boolean | false |
validate-event | 是否触发表单验证 | boolean | true |
tabindex | 输入框的 tabindex | string / number | — |
id | 输入框 id | string | — |
aria-controls a11y 2.7.2 | 与 aria-controls 相同,当 indeterminate 为 true 时生效 | string | — |
true-label 已废弃 | 如果复选框被选中,它的值 | string / number | — |
false-label 已废弃 | 如果复选框未被选中,它的值 | string / number | — |
controls a11y 已废弃 | 与 aria-controls 相同,当 indeterminate 为 true 时生效 | string | — |
Checkbox 事件
名称 | 描述 | 类型 |
---|---|---|
change | 当绑定值变化时触发 | Function |
Checkbox 插槽
名称 | 描述 |
---|---|
default | 自定义默认内容 |
CheckboxGroup API
CheckboxGroup 属性
名称 | 描述 | 类型 | 默认值 |
---|---|---|---|
model-value / v-model | 绑定值 | object | [] |
size | 多选框的尺寸 | 枚举 | — |
disabled | 嵌套的多选框是否被禁用 | boolean | false |
min | 最少选择的多选框数量 | number | — |
max | 最多选择的多选框数量 | number | — |
aria-label a11y 2.7.2 | 原生 aria-label 属性 | string | — |
text-color | 按钮激活时的字体颜色 | string | #ffffff |
填充色 | 按钮激活时的边框和背景颜色 | string | #409eff |
tag | 多选框组的元素标签 | string | div |
validate-event | 是否触发表单验证 | boolean | true |
label a11y 已废弃 | 原生 aria-label 属性 | string | — |
CheckboxGroup 事件
名称 | 描述 | 类型 |
---|---|---|
change | 当绑定值变化时触发 | Function |
CheckboxGroup 插槽
名称 | 描述 | 子标签 |
---|---|---|
default | 自定义默认内容 | Checkbox / Checkbox-button |
CheckboxButton API
CheckboxButton 属性
名称 | 描述 | 类型 | 默认值 |
---|---|---|---|
value 2.6.0 | 当在 checkbox-group 中使用时,多选框的值 | string / number / boolean / object | — |
label | 当在 checkbox-group 中使用时,多选框的标签。如果没有值,label 将作为 value | string / number / boolean / object | — |
true-value 2.6.0 | 如果多选框被选中,它的值 | string / number | — |
false-value 2.6.0 | 如果多选框未被选中,它的值 | string / number | — |
disabled | 多选框是否被禁用 | boolean | false |
名称 | 原生 'name' 属性 | string | — |
选中 | 多选框是否被选中 | boolean | false |
true-label 已废弃 | 如果多选框被选中,它的值 | string / number | — |
false-label 已废弃 | 如果多选框未被选中,它的值 | string / number | — |
CheckboxButton 插槽
名称 | 描述 |
---|---|
default | 自定义默认内容 |