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>

基础用法

复选框可以单独使用,用于在两个状态之间切换。

el-checkbox 中定义 v-model(绑定变量)。 对于单个 checkbox,默认值为 Boolean 类型,选中时变为 trueel-checkbox 标签内的内容将作为复选框后的描述文字。

禁用状态

多选框不可用状态。

设置 disabled 属性即可。

多选框组

适用于多个勾选框绑定到同一个数组的情景,通过是否勾选来表示选中的选项。

checkbox-group 元素能通过 v-model 绑定 Array 数组来管理多个复选框。 在 el-checkbox 元素中,value 是复选框的值。 如果没有嵌套内容,label 将被渲染为复选框后的描述。 value 也与数组中的元素值相对应。 如果指定的值存在于数组中,则为选中状态,反之亦然。

Options 属性 2.11.2

基础 el-checkbox-group 用法的快捷方式。 您可以通过 props 属性自定义 options 的别名。

不确定状态

indeterminate 属性用以表示复选框的不确定状态,通常用于实现全选效果。

可选项目数量的限制

minmax 属性能够限制可以选中的复选框数量。

按钮样式

按钮样式的复选框。

只需将 el-checkbox 元素替换为 el-checkbox-button 元素即可。 我们还提供了 size 属性。

带有边框

border 属性可以为复选框添加边框。

Checkbox API

Checkbox 属性

名称描述类型默认值
model-value / v-model绑定值string / number / boolean
value 2.6.0当在 checkbox-group 中使用时,Checkbox 的值string / number / boolean / object
label当在 checkbox-group 中使用时,Checkbox 的标签。 如果没有 value,label 将作为 value 使用string / number / boolean / object
true-value 2.6.0选中时的值string / number
false-value 2.6.0未选中时的值string / number
disabled是否禁用booleanfalse
边框是否显示边框booleanfalse
sizeCheckbox 的尺寸枚举
名称原生 name 属性string
checked是否选中booleanfalse
indeterminate设置不确定状态,仅负责样式控制booleanfalse
validate-event是否触发表单验证booleantrue
tabindex输入框的 tabindexstring / number
id输入框 IDstring
aria-controls a11y 2.7.2aria-controls 相同,在 indeterminatetrue 时生效string
aria-label 无障碍原生 aria-label 属性string
true-label 已弃用选中时的值string / number
false-label 已弃用未选中时的值string / number
controls a11y 已弃用aria-controls 相同,在 indeterminatetrue 时生效string

Checkbox 事件

名称描述类型
change当绑定值变化时触发的事件Function

Checkbox 插槽

名称描述
default自定义默认内容

CheckboxGroup API

CheckboxGroup 属性

名称描述类型默认值
model-value / v-model绑定值array[]
size多选框组尺寸枚举
disabled是否禁用所有复选框booleanfalse
min最小选择数量number
max最大选择数量number
aria-label a11y 2.7.2原生 aria-label 属性string
text-color按钮激活时的字体颜色string#ffffff
填充色按钮激活时的填充色和边框色string#409eff
tag多选框组自定义元素标签stringdiv
validate-event是否触发表单验证booleantrue
label a11y 已废弃原生 aria-label 属性string
options 2.11.2选项数据,其中 `value` 和 `label` 和 `disabled` 的键名可以通过 `props` 自定义array
props 2.11.2配置选项object{value: 'value', label: 'label', disabled: 'disabled'}
type 2.11.5渲染选项的组件类型(例如:'button'枚举'checkbox'

CheckboxGroup 事件

名称描述类型
change当绑定值变化时触发的事件Function

CheckboxGroup 插槽

名称描述子标签
default自定义默认内容Checkbox / Checkbox-button (默认插槽)

CheckboxButton API

CheckboxButton 属性

名称描述类型默认值
value 2.6.0当在 checkbox-group 中使用时,多选框的值string / number / boolean / object
label当在 checkbox-group 中使用时,多选框的标签。 如果没有 value,label 将作为 value 使用string / number / boolean / object
true-value 2.6.0选中时的值string / number
false-value 2.6.0未选中时的值string / number
disabled是否禁用booleanfalse
名称原生 name 属性string
checked是否选中booleanfalse
true-label 已弃用选中时的值string / number
false-label 已弃用未选中时的值string / number

CheckboxButton 插槽

名称描述
default自定义默认内容

来源

组件样式文档

贡献者