Checkbox 复选框

示例

尺寸

可选的 ui 属性值：small。

<template>
<article>
  <section>
    <veui-checkbox
      v-model="checked"
      :ui="size"
      :indeterminate.sync="indeterminate"
    >
      Checked: {{ checked }}
    </veui-checkbox>
  </section>
  <section>
    <veui-checkbox
      v-model="small"
      ui="small"
    >
      Small
    </veui-checkbox>
    <veui-checkbox
      v-model="indeterminate"
      ui="small"
    >
      Indeterminate
    </veui-checkbox>
  </section>
</article>
</template>

<script>
import { Checkbox } from 'veui'

export default {
  components: {
    'veui-checkbox': Checkbox
  },
  data () {
    return {
      checked: false,
      indeterminate: false,
      small: false
    }
  },
  computed: {
    size () {
      return this.small ? 'small' : ''
    }
  }
}
</script>

值设定

可以通过设置 true-value 和 false-value 来修改选中、非选中状态下 model 属性（v-model）的值。

State: Not confirmed

<template>
<article>
  <veui-checkbox
    v-model="status"
    true-value="CONFIRMED"
    false-value="UNCONFIRMED"
  >
    I've read the agreement
  </veui-checkbox>
  <p>State: {{ statusMap[status] }}</p>
</article>
</template>

<script>
import { Checkbox } from 'veui'

const STATUS_MAP = {
  CONFIRMED: 'Confirmed',
  UNCONFIRMED: 'Not confirmed'
}

export default {
  components: {
    'veui-checkbox': Checkbox
  },
  data () {
    return {
      status: 'UNCONFIRMED',
      statusMap: STATUS_MAP
    }
  }
}
</script>

API

属性

名称类型默认值描述
uistring-

预设样式。

值描述
small小尺寸样式。
model*-

v-model

当前状态的值。选中状态为 true-value 对应值，未选中状态为 false-value 对应值。如果 v-model 绑定到一个数组，则使用 value 属性的值。

checkedbooleanfalse

.sync

是否处于选中状态。

value*-当 v-model 绑定到数组时，代表当前复选框的值。
true-value*true选中状态对应的值。
false-value*false未选状态对应的值。
indeterminatebooleanfalse是否处于半选状态。
disabledbooleanfalse是否为禁用状态。
readonlybooleanfalse是否为只读状态。

插槽

名称描述
default复选框的描述文本，点击时会切换选择状态。无默认内容。

事件

名称描述
change用户切换选中状态时触发，回调参数为 (checked: boolean)。checked 表示当前是否选中。
input

v-model

选中状态变化后触发，回调参数为 (val: *)。val 为当前 model 属性的值。与 change 事件不同，input 事件在数据操作导致状态变化时也会触发。

此外，Checkbox 支持如下的原生事件：

auxclick、click、contextmenu、dblclick、mousedown、mouseenter、mouseleave、mousemove、mouseover、mouseout、mouseup、select、wheel、keydown、keypress、keyup、focus、blur、focusin、focusout。

回调参数均为相应的原生事件对象。

图标

名称描述
checked已选状态。
indeterminate半选状态。