Skip to content

Checkbox 复选框

基础用法

通过 v-model 绑定复选框的勾选状态。

html
<template>
  <ACheckbox v-model="checked" label="主要" />
</template>
<template>
  <ACheckbox v-model="checked" label="主要" />
</template>

复选框大小

通过 size 属性设置复选框的大小,可选值为 minismallnormallarge,默认为 normal

html
<template>
  <ACheckbox v-model="checked" label="迷你" size="mini" />
  <ACheckbox v-model="checked" label="小型" size="small" />
  <ACheckbox v-model="checked" label="普通" size="normal" />
  <ACheckbox v-model="checked" label="大型" size="large" />
</template>
<template>
  <ACheckbox v-model="checked" label="迷你" size="mini" />
  <ACheckbox v-model="checked" label="小型" size="small" />
  <ACheckbox v-model="checked" label="普通" size="normal" />
  <ACheckbox v-model="checked" label="大型" size="large" />
</template>

自定义文字位置

使用 flex-direction: row-reverse 可以轻松实现

html
<template>
  <ACheckbox v-model="checked" type="primary" label="" />
  <ACheckbox v-model="checked" type="primary" label="" custom-class="flex-row-reverse justify-end space-x-0!" ccc="ml-2" />
</template>
<template>
  <ACheckbox v-model="checked" type="primary" label="" />
  <ACheckbox v-model="checked" type="primary" label="" custom-class="flex-row-reverse justify-end space-x-0!" ccc="ml-2" />
</template>

禁用文本点击

设置 label-disabled 属性后,点击图标以外的内容不会触发复选框切换。

html
<template>
  <ACheckbox v-model="checked" type="success" label-disabled label="禁用文本点击" />
</template>
<template>
  <ACheckbox v-model="checked" type="success" label-disabled label="禁用文本点击" />
</template>

禁用状态

通过 disabled 属性禁用复选框。

html
<template>
  <ACheckbox v-model="checked" label="主要" disabled />
</template>
<template>
  <ACheckbox v-model="checked" label="主要" disabled />
</template>

复选框类型

通过 type 属性设置复选框的选项类型,可选值为 primarysuccessinfowarningdanger

html
<template>
  <ACheckbox v-model="checked" label="主要" type="primary" />
  <ACheckbox v-model="checked" label="成功" type="success" />
  <ACheckbox v-model="checked" label="信息" type="info" />
  <ACheckbox v-model="checked" label="警告" type="warning" />
  <ACheckbox v-model="checked" label="危险" type="danger" />
</template>
<template>
  <ACheckbox v-model="checked" label="主要" type="primary" />
  <ACheckbox v-model="checked" label="成功" type="success" />
  <ACheckbox v-model="checked" label="信息" type="info" />
  <ACheckbox v-model="checked" label="警告" type="warning" />
  <ACheckbox v-model="checked" label="危险" type="danger" />
</template>

复选框组

通过 v-model 绑定复选框组的勾选状态。

html
<script setup lang="ts">
import { ref } from 'vue'
const checkedList = ref(['a'])
</script>

<template>
  <ACheckboxGroup v-model="checkedList">
    <ACheckbox value="a" label="A" />
    <ACheckbox value="b" label="B" />
    <ACheckbox value="c" label="C" />
  </ACheckboxGroup>
</template>
<script setup lang="ts">
import { ref } from 'vue'
const checkedList = ref(['a'])
</script>

<template>
  <ACheckboxGroup v-model="checkedList">
    <ACheckbox value="a" label="A" />
    <ACheckbox value="b" label="B" />
    <ACheckbox value="c" label="C" />
  </ACheckboxGroup>
</template>

限制勾选数量

通过 minmax 属性限制复选框组的勾选数量。

html
<script setup lang="ts">
import { ref } from 'vue'
const checkedList = ref(['a'])
</script>

<template>
  <ACheckboxGroup v-model="checkedList" :min="1" :max="2">
    <ACheckbox value="a" label="A" />
    <ACheckbox value="b" label="B" />
    <ACheckbox value="c" label="C" />
  </ACheckboxGroup>
</template>
<script setup lang="ts">
import { ref } from 'vue'
const checkedList = ref(['a'])
</script>

<template>
  <ACheckboxGroup v-model="checkedList" :min="1" :max="2">
    <ACheckbox value="a" label="A" />
    <ACheckbox value="b" label="B" />
    <ACheckbox value="c" label="C" />
  </ACheckboxGroup>
</template>

API

CheckboxGroup Props

参数说明类型默认值
v-model绑定值Array-
min最小可选数,0 表示不限制number-1
max最大可选数,0 表示不限制number-1
disabled是否禁用booleanfalse
label-disabled是否禁用文本点击booleanfalse
size大小,可选值为 minismallnormallargestringnormal
direction排列方向,可选值为 horizontalstringvertical

Checkbox Props

参数说明类型默认值
v-model绑定值string | Array | object-
label选项的标签值string | number | boolean | object-
disabled是否禁用booleanfalse
label-disabled是否禁用文本点击booleanfalse
size大小,可选值为 minismallnormallargestringnormal
type选项类型,可选值为 primarysuccessinfowarningdangerstringprimary

CheckboxGroup Events

事件名说明回调参数
change当绑定值变化时触发的事件value: string | Array | object

Checkbox Events

事件名说明回调参数
change当绑定值变化时触发的事件value: string | Array | object

Checkbox Slots

名称说明
label自定义复选框的内容
icon自定义图标类名

MIT Licensed