Checkbox 复选框
示例
尺寸
可供选用的 ui
属性值:s
/ m
。
可以使用 indeterminate
属性来设置半选状态。
<template>
<article>
<section>
<veui-checkbox
v-model="checked"
class="checkbox"
:ui="size"
:indeterminate.sync="indeterminate"
>
Checked: {{ checked }}
</veui-checkbox>
</section>
<section>
<veui-checkbox
v-model="small"
class="checkbox"
ui="s"
>
Small
</veui-checkbox>
<veui-checkbox
v-model="indeterminate"
class="checkbox"
ui="s"
>
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 ? 's' : ''
}
}
}
</script>
<style lang="less" scoped>
.checkbox {
& + & {
margin-left: 20px;
}
}
</style>
值设定
可以通过设置 true-value
和 false-value
属性 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
属性
名称 | 类型 | 默认值 | 描述 | ||||||
---|---|---|---|---|---|---|---|---|---|
ui | string | - | 预设样式。
| ||||||
checked | boolean | false |
是否处于选中状态。 | ||||||
value | * | - | 当 v-model 绑定到数组时,代表当前复选框的值。 | ||||||
true-value | * | true | 选中状态对应的值。 | ||||||
false-value | * | false | 未选状态对应的值。 | ||||||
indeterminate | boolean | false | 是否处于半选状态。 | ||||||
disabled | boolean | false | 是否为禁用状态。 | ||||||
readonly | boolean | false | 是否为只读状态。 |
插槽
名称 | 描述 |
---|---|
default | 复选框的描述文本,点击时会切换选择状态。无默认内容。 |
事件
名称 | 描述 |
---|---|
change | 用户切换选中状态时触发,回调参数为 (checked: boolean) 。checked 表示当前是否选中。 |
input |
选中状态变化后触发,回调参数为 |
此外,Checkbox
支持如下的原生事件:
auxclick
、click
、contextmenu
、dblclick
、mousedown
、mouseenter
、mouseleave
、mousemove
、mouseover
、mouseout
、mouseup
、select
、wheel
、keydown
、keypress
、keyup
、focus
、blur
、focusin
、focusout
。
回调参数均为相应的原生事件对象。