Checkbox 多选框

一组备选项中进行多选。

WARNING

label 作为 value 使用的写法已被弃用label 将仅作为展示文本,请迁移到新 API。

基础用法

单独使用可在两种状态间切换。

el-checkbox 上使用 v-model 绑定变量;单独使用时为布尔值,选中为 true。标签内文本会显示在复选框按钮之后。

禁用状态

禁用多选框。

设置 disabled 属性。

多选框组

用于管理一组绑定的多选框。

checkbox-group 通过数组类型的 v-model 管理多个选项。内部 el-checkboxvalue 为选中值;若无默认插槽内容,会渲染 label 作为描述。数组包含对应 value 时该项为选中。

选项属性

基于 options 的快捷用法;可通过 props 自定义字段别名。

中间状态

通过 indeterminate 实现「全选」等半选样式。

可选数量限制

通过 minmax 限制可选数量。

按钮样式

按钮外观的多选框。

el-checkbox 换为 el-checkbox-button,并可设置 size

带边框

设置 border 为复选框增加边框样式。

多选框 API

多选框 属性

名称说明类型默认值
model-value / v-model绑定值string / number / boolean
valuecheckbox-group 中作为选项值string / number / boolean / object
labelcheckbox-group 中的标签;未提供 valuelabel 仍会按旧版充当 valuestring / number / boolean / object
true-value选中时的绑定值string / number
false-value未选中时的绑定值string / number
disabled是否禁用booleanfalse
border是否显示边框booleanfalse
size尺寸enum
name原生 namestring
checked是否选中booleanfalse
indeterminate不确定状态,仅控制样式booleanfalse
validate-event是否触发表单校验booleantrue
tabindex原生 tabindexstring / number
id原生 idstring
aria-controls a11yaria-controls,在 indeterminatetrue 时生效string
aria-label a11y原生 aria-labelstring

多选框 事件

事件名说明类型
change绑定值变化时Function

多选框 插槽

名称说明
default自定义默认内容

多选框组 API

多选框组 属性

名称说明类型默认值
model-value / v-model绑定值array[]
size尺寸enum
disabled是否禁用组内所有多选框booleanfalse
min最少勾选数number
max最多勾选数number
aria-label a11y原生 aria-labelstring
text-color按钮样式激活态文字颜色string#ffffff
fill按钮样式激活态边框与背景色string#2F54EB
tag多选框组根元素标签stringdiv
validate-event是否触发表单校验booleantrue
options选项数据;valuelabeldisabled 等键名可通过 props 映射array
props选项字段映射配置object{value: 'value', label: 'label', disabled: 'disabled'}
type批量渲染类型,如 'button'enum'checkbox'

多选框组 事件

事件名说明类型
change绑定值变化时Function

多选框组 插槽

名称说明子标签
default自定义默认内容多选框 / 多选框按钮

多选框按钮 API

多选框按钮 属性

名称说明类型默认值
valuecheckbox-group 中作为选项值string / number / boolean / object
labelcheckbox-group 中的标签;未提供 valuelabel 仍会按旧版充当 valuestring / number / boolean / object
true-value选中时的绑定值string / number
false-value未选中时的绑定值string / number
disabled是否禁用booleanfalse
name原生 namestring
checked是否选中booleanfalse

多选框按钮 插槽

名称说明
default自定义默认内容