CheckboxGroup 复选框组

优质
小牛编辑
134浏览
2023-12-01

复选框组就是一组复选框,主要用来选择一组可选项;有垂直和水平两种样式。

示例

  • 垂直排列

    默认就是垂直排列样式

    <cube-checkbox-group v-model="checkList" :options="options" />
    
    export default {
      data() {
        return {
          checkList: ['1', '4'],
          options: [
            '1',
            '2',
            {
              label: '3',
              value: '3',
              disabled: true
            },
            {
              label: '4',
              value: '4',
              disabled: true
            }
          ]
        }
      }
    }
    

    checkList 的值是一个数组,代表的是选中的复选框 value 的值的集合。

  • 水平排列、图标形状、镂空样式

    可通过设置 horizontal 改变样式为水平排列,另外,还可以通过 shape 配置图标形状以及通过设置 hollow-styletrue 改变为镂空样式。

    <cube-checkbox-group v-model="checkList" :options="options" :horizontal="true" shape="square" :hollow-style="true" />
    
  • 自定义 label

    <cube-checkbox-group v-model="checkList">
      <cube-checkbox option="1"><i>Checkbox 1</i></cube-checkbox>
      <cube-checkbox option="2"><i>Checkbox 2</i></cube-checkbox>
      <cube-checkbox :option="{value: '3', disabled: true}"><i>Disabled Checkbox</i></cube-checkbox>
      <cube-checkbox :option="{value: '4', disabled: true}"><i>Disabled & Checked Checkbox</i></cube-checkbox>
    </cube-checkbox-group>
    

    可通过默认插槽插入 cube-checkbox 实现自定义每项的结构样子,关于 cube-checkbox,请参考其文档

  • 自定义列数1.12.28

    可通过设计 colNum 控制一行中有几列,colNum 小于1时,按1处理

      <cube-checkbox-group v-model="colCheckList" :options="colOptions" :col-num="3" />
    
    export default {
      data() {
        return {
          colCheckList: [],
          colOptions: ['1', '2', '3', '4', '5', '6', '7', '8']
        }
      }
    }
    

Props 配置

参数说明类型可选值默认值
options选项数组Array--
horizontal是否水平排列Booleantrue/falsefalse
colNum1.12.28一行有几列Number-1
shape图标形状Stringcircle/squarecircle
hollowStyle是否是镂空样式的Booleantrue/falsefalse
min1.11.0最小选择个数Number-0
max1.11.0最大选择个数Number-Infinite
  • options 子配置项
参数说明类型
label复选框显示文字String
value复选框的值String/Number
disabled复选框是否被禁用Boolean

注:如果 options 中的项为字符串也是可以的,此时默认 labelvalue 的值都为该字符串的值。

事件

事件名说明参数
checked勾选复选框组中的某一项时触发当前勾选的复选框值
cancel-checked取消勾选复选框组中的某一项时触发当前取消勾选的复选框值
input当绑定值变化时触发当前选中的复选框值的集合