sard-uniapp/components/checkbox/README.md

sard-uniapp 是一套基于 Uniapp + Vue3 框架开发的兼容多端的 UI 组件库

---
title: Checkbox
subtitle: 复选框
group: 表单组件
---

## 介绍

在一组可选项中进行任意选择。

## 引入

```js
import Checkbox from 'sard-uniapp/components/checkbox/checkbox.vue'
import CheckboxGroup from 'sard-uniapp/components/checkbox-group/checkbox-group.vue'
```

## 代码演示

### 基础使用

使用 `checked` 属性控制是否选中。

<<< @demo/checkbox/demo/Basic.vue

### 只读和禁用

只读或禁用后不可点击。

<<< @demo/checkbox/demo/DisabledReadOnly.vue

### 图标大小

使用 `size` 属性设置图标大小。

<<< @demo/checkbox/demo/Size.vue

### 图标颜色

使用 `checked-color` 属性设置选中时的图标颜色。

<<< @demo/checkbox/demo/Color.vue

### 图标类型

设置 `type` 属性为 `circle` 可以使图标变为圆形。

<<< @demo/checkbox/demo/Type.vue

### 自定义图标

如果内置的图标不满足需求，可以使用 `icon` 插槽设置为任意的图标。
插槽接收`checked`属性表示当前的选中状态。

<<< @demo/checkbox/demo/Icon.vue

### 复选框组

复选框组用于收集选中状态的复选框的值。

<<< @demo/checkbox/demo/Group.vue

### 排列方向

将 `direction` 属性设置为 `horizontal` 后，复选框组会变成水平排列。

<<< @demo/checkbox/demo/Direction.vue

### 自动渲染复选框

使用 `options` 属性设置可选项。

<<< @demo/checkbox/demo/GroupOptions.vue

### 自定义 UI

如果只想使用复选的逻辑，并想自定义 UI，可以使用复选框组的 `custom` 插槽。

这个插槽接收 `toggle`方法和 `value` 属性作为参数。`toggle` 用于切换指定选项的选中状态，`value` 用于判断选中状态。

<<< @demo/checkbox/demo/Custom1.vue

结合 `list` 组件使用：

<<< @demo/checkbox/demo/Custom2.vue

复选框组里面 `checkbox` 组件，会自动判断选中状态；可以给 `checkbox` 组件添加 `readonly` 属性以便将点击操作交给其他组件。

<<< @demo/checkbox/demo/Custom3.vue

### 不确定状态

<<< @demo/checkbox/demo/Indeterminate.vue

## API

### CheckboxProps

| 属性                          | 描述                             | 类型                 | 默认值   |
| ----------------------------- | -------------------------------- | -------------------- | -------- |
| root-class                    | 组件根元素类名                   | string               | -        |
| root-style                    | 组件根元素样式                   | StyleValue           | -        |
| checked (v-model)             | 是否选中                         | boolean              | false    |
| indeterminate <sup>1.6+</sup> | 是否处于不确定状态               | boolean              | false    |
| value                         | 复选框的值，配合复选框组一起使用 | any                  | -        |
| label                         | 复选框标签                       | string               | -        |
| disabled                      | 禁用状态                         | boolean              | -        |
| readonly                      | 只读状态                         | boolean              | -        |
| size                          | 图标的尺寸                       | string               | -        |
| type                          | 图标类型                         | 'square' \| 'circle' | 'square' |
| checked-color                 | 选中时图标的颜色                 | string               | -        |
| validate-event                | 是否触发表单验证                 | boolean              | true     |

### CheckboxSlots

| 插槽    | 描述           | 属性                   |
| ------- | -------------- | ---------------------- |
| default | 自定义默认内容 | -                      |
| icon    | 自定义图标     | `{ checked: boolean }` |

### CheckboxEmits

| 事件           | 描述               | 类型                         |
| -------------- | ------------------ | ---------------------------- |
| click          | 点击时触发         | `(event: any) => void`       |
| update:checked | 选中状态改变时触发 | `(checked: boolean) => void` |
| change         | 选中状态改变时触发 | `(checked: boolean) => void` |

### CheckboxGroupProps

| 属性                  | 描述                                  | 类型                  | 默认值                             |
| --------------------- | ------------------------------------- | --------------------- | ---------------------------------- |
| root-class            | 组件根元素类名                        | string                | -                                  |
| root-style            | 组件根元素样式                        | StyleValue            | -                                  |
| model-value (v-model) | 指定选中的选项                        | any[]                 | -                                  |
| disabled              | 禁用状态                              | boolean               | -                                  |
| readonly              | 只读状态                              | boolean               | -                                  |
| size                  | 图标的尺寸                            | string                | -                                  |
| type                  | 图标类型                              | 'square' \| 'circle'  | 'square'                           |
| checked-color         | 选中时图标的颜色                      | string                | -                                  |
| validate-event        | 是否触发表单验证                      | boolean               | true                               |
| options               | 自动设置复选框                        | CheckboxGroupOption[] | -                                  |
| option-keys           | 自定义 options 的 label、value 的字段 | OptionKeys            | `{label: 'label', value: 'value'}` |

### CheckboxGroupOption

```ts
export type CheckboxGroupOption =
  | {
      [key: PropertyKey]: any
    }
  | string
  | number
  | boolean
```

### OptionKeys

```ts
export interface OptionKeys {
  label?: string
  value?: string
}
```

### CheckboxGroupSlots

| 插槽    | 描述                                                                           | 属性                                             |
| ------- | ------------------------------------------------------------------------------ | ------------------------------------------------ |
| default | 自定义默认内容                                                                 | -                                                |
| custom  | 同默认插槽，额外可以接收 `toggle` 方法切换选中状态，用于自定义复选框结构和样式 | `{ toggle: (value: any) => void, value: any[] }` |

### CheckboxGroupEmits

| 事件               | 描述                 | 类型                     |
| ------------------ | -------------------- | ------------------------ |
| update:model-value | 复选框组值改变时触发 | `(value: any[]) => void` |
| change             | 复选框组值改变时触发 | `(value: any[]) => void` |

## 主题定制

### CSS 变量

<<< @comp/checkbox/variables.scss#variables