Checkbox 多选框

一组备选项中进行多选

基础用法

单独使用可以表示两种状态之间的切换,写在标签中的内容为 checkbox 按钮后的介绍。

Checkbox 多选框 - 图1

el-checkbox元素中定义v-model绑定变量,单一的checkbox中,默认绑定变量的值会是Boolean,选中为true

  1. <template>
  2. <!-- `checked` 为 true 或 false -->
  3. <el-checkboxv-model="checked">备选项</el-checkbox>
  4. </template>
  5. <script>
  6. exportdefault{
  7. data(){
  8. return{
  9. checked:true
  10. };
  11. }
  12. };
  13. </script>

禁用状态

多选框不可用状态。

Checkbox 多选框 - 图2

设置disabled属性即可。

  1. <template>
  2. <el-checkboxv-model="checked1"disabled>备选项1</el-checkbox>
  3. <el-checkboxv-model="checked2"disabled>备选项</el-checkbox>
  4. </template>
  5. <script>
  6. exportdefault{
  7. data(){
  8. return{
  9. checked1:false,
  10. checked2:true
  11. };
  12. }
  13. };
  14. </script>

多选框组

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

Checkbox 多选框 - 图3

checkbox-group元素能把多个 checkbox 管理为一组,只需要在 Group 中使用v-model绑定Array类型的变量即可。 el-checkboxlabel属性是该 checkbox 对应的值,若该标签中无内容,则该属性也充当 checkbox 按钮后的介绍。label与数组中的元素值相对应,如果存在指定的值则为选中状态,否则为不选中。

  1. <template>
  2. <el-checkbox-groupv-model="checkList">
  3. <el-checkboxlabel="复选框 A"></el-checkbox>
  4. <el-checkboxlabel="复选框 B"></el-checkbox>
  5. <el-checkboxlabel="复选框 C"></el-checkbox>
  6. <el-checkboxlabel="禁用"disabled></el-checkbox>
  7. <el-checkboxlabel="选中且禁用"disabled></el-checkbox>
  8. </el-checkbox-group>
  9. </template>
  10. <script>
  11. exportdefault{
  12. data (){
  13. return{
  14. checkList:['选中且禁用','复选框 A']
  15. };
  16. }
  17. };
  18. </script>

indeterminate 状态

indeterminate 属性用以表示 checkbox 的不确定状态,一般用于实现全选的效果

Checkbox 多选框 - 图4

  1. <template>
  2. <el-checkbox :indeterminate="isIndeterminate"v-model="checkAll" @change="handleCheckAllChange">全选</el-checkbox>
  3. <divstyle="margin:15px0;"></div>
  4. <el-checkbox-groupv-model="checkedCities" @change="handleCheckedCitiesChange">
  5. <el-checkboxv-for="city in cities" :label="city" :key="city">{{city}}</el-checkbox>
  6. </el-checkbox-group>
  7. </template>
  8. <script>
  9. const cityOptions =['上海','北京','广州','深圳'];
  10. exportdefault{
  11. data(){
  12. return{
  13. checkAll:false,
  14. checkedCities:['上海','北京'],
  15. cities: cityOptions,
  16. isIndeterminate:true
  17. };
  18. },
  19. methods:{
  20. handleCheckAllChange(val){
  21. this.checkedCities = val ? cityOptions :[];
  22. this.isIndeterminate =false;
  23. },
  24. handleCheckedCitiesChange(value){
  25. let checkedCount = value.length;
  26. this.checkAll = checkedCount ===this.cities.length;
  27. this.isIndeterminate = checkedCount >0&& checkedCount <this.cities.length;
  28. }
  29. }
  30. };
  31. </script>

可选项目数量的限制

使用 minmax 属性能够限制可以被勾选的项目的数量。

Checkbox 多选框 - 图5

<template>
  <el-checkbox-group 
    v-model="checkedCities"
    :min="1"
    :max="2">
    <el-checkbox v-for="city in cities" :label="city" :key="city">{{city}}</el-checkbox>
  </el-checkbox-group>
</template>
<script>
  const cityOptions = ['上海', '北京', '广州', '深圳'];
  export default {
    data() {
      return {
        checkedCities: ['上海', '北京'],
        cities: cityOptions
      };
    }
  };
</script>

按钮样式

按钮样式的多选组合。

Checkbox 多选框 - 图6

只需要把el-checkbox元素替换为el-checkbox-button元素即可。此外,Element 还提供了size属性。

<template>
  <div>
    <el-checkbox-group v-model="checkboxGroup1">
      <el-checkbox-button v-for="city in cities" :label="city" :key="city">{{city}}</el-checkbox-button>
    </el-checkbox-group>
  </div>
  <div style="margin-top: 20px">
    <el-checkbox-group v-model="checkboxGroup2" size="medium">
      <el-checkbox-button v-for="city in cities" :label="city" :key="city">{{city}}</el-checkbox-button>
    </el-checkbox-group>
  </div>
  <div style="margin-top: 20px">
    <el-checkbox-group v-model="checkboxGroup3" size="small">
      <el-checkbox-button v-for="city in cities" :label="city" :disabled="city === '北京'" :key="city">{{city}}</el-checkbox-button>
    </el-checkbox-group>
  </div>
  <div style="margin-top: 20px">
    <el-checkbox-group v-model="checkboxGroup4" size="mini" disabled>
      <el-checkbox-button v-for="city in cities" :label="city" :key="city">{{city}}</el-checkbox-button>
    </el-checkbox-group>
  </div>
</template>
<script>
  const cityOptions = ['上海', '北京', '广州', '深圳'];
  export default {
    data () {
      return {
        checkboxGroup1: ['上海'],
        checkboxGroup2: ['上海'],
        checkboxGroup3: ['上海'],
        checkboxGroup4: ['上海'],
        cities: cityOptions
      };
    }
  }
</script>

带有边框

Checkbox 多选框 - 图7

设置border属性可以渲染为带有边框的多选框。

<template>
  <div>
    <el-checkbox v-model="checked1" label="备选项1" border></el-checkbox>
    <el-checkbox v-model="checked2" label="备选项2" border></el-checkbox>
  </div>
  <div style="margin-top: 20px">
    <el-checkbox v-model="checked3" label="备选项1" border size="medium"></el-checkbox>
    <el-checkbox v-model="checked4" label="备选项2" border size="medium"></el-checkbox>
  </div>
  <div style="margin-top: 20px">
    <el-checkbox-group v-model="checkboxGroup1" size="small">
      <el-checkbox label="备选项1" border></el-checkbox>
      <el-checkbox label="备选项2" border disabled></el-checkbox>
    </el-checkbox-group>
  </div>
  <div style="margin-top: 20px">
    <el-checkbox-group v-model="checkboxGroup2" size="mini" disabled>
      <el-checkbox label="备选项1" border></el-checkbox>
      <el-checkbox label="备选项2" border></el-checkbox>
    </el-checkbox-group>
  </div>
</template>

<script>
  export default {
    data () {
      return {
        checked1: true,
        checked2: false,
        checked3: false,
        checked4: true,
        checkboxGroup1: [],
        checkboxGroup2: []
      };
    }
  }
</script>

Checkbox Attributes

参数说明类型可选值默认值
value / v-model绑定值string / number / boolean
label选中状态的值(只有在checkbox-group或者绑定对象类型为array时有效)string / number / boolean
true-label选中时的值string / number
false-label没有选中时的值string / number
disabled是否禁用booleanfalse
border是否显示边框booleanfalse
sizeCheckbox 的尺寸,仅在 border 为真时有效stringmedium / small / mini
name原生 name 属性string
checked当前是否勾选booleanfalse
indeterminate设置 indeterminate 状态,只负责样式控制booleanfalse

Checkbox Events

事件名称说明回调参数
change当绑定值变化时触发的事件更新后的值

Checkbox-group Attributes

参数说明类型可选值默认值
value / v-model绑定值array
size多选框组尺寸,仅对按钮形式的 Checkbox 或带有边框的 Checkbox 有效stringmedium / small / mini
disabled是否禁用booleanfalse
min可被勾选的 checkbox 的最小数量number
max可被勾选的 checkbox 的最大数量number
text-color按钮形式的 Checkbox 激活时的文本颜色string#ffffff
fill按钮形式的 Checkbox 激活时的填充色和边框色string#409EFF

Checkbox-group Events

事件名称说明回调参数
change当绑定值变化时触发的事件更新后的值

Checkbox-button Attributes

参数说明类型可选值默认值
label选中状态的值(只有在checkbox-group或者绑定对象类型为array时有效)string / number / boolean
true-label选中时的值string / number
false-label没有选中时的值string / number
disabled是否禁用booleanfalse
name原生 name 属性string
checked当前是否勾选booleanfalse