# checkbox (w-checkbox)

- **Import**: `WCheckbox` from `win-design-next`
- **Tag**: `<w-checkbox>`
- **说明**: Checkbox 多选框
- **分类**: data-entry
- **Skill 版本**: V1.1.0
- **适配组件库**: win-design-next 1.2.2
- **API 来源**: `docs/zh-CN/component/checkbox.md`

## API

## Checkbox API

### Attributes

| 属性名                         | 说明                                                                                                                                                 | 类型                                           | 默认值 |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ------ |
| model-value / v-model          | 选中项绑定值                                                                                                                                         | ^[string] / ^[number] / ^[boolean]             | —      |
| value                          | 选中状态的值（只有在`checkbox-group`或者绑定对象类型为`array`时有效）                                                                                | ^[string] / ^[number] / ^[boolean] / ^[object] | —      |
| label                          | 选中状态的值，只有在绑定对象类型为 `array` 时有效。 如果没有 value， `label`则作为`value`使用                                                        | ^[string] / ^[number] / ^[boolean] / ^[object] | —      |
| true-value                     | 选中时的值                                                                                                                                           | ^[string] / ^[number]                          | —      |
| false-value                    | 没有选中时的值                                                                                                                                       | ^[string] / ^[number]                          | —      |
| disabled                       | 是否禁用                                                                                                                                             | ^[boolean]                                     | false  |
| border                         | 是否显示边框                                                                                                                                         | ^[boolean]                                     | false  |
| size                           | Checkbox 的尺寸                                                                                                                                      | ^[enum]`'large' \| 'default' \| 'small'`       | —      |
| name                           | 原生 name 属性                                                                                                                                       | ^[string]                                      | —      |
| checked                        | 当前是否勾选                                                                                                                                         | ^[boolean]                                     | false  |
| indeterminate                  | 设置不确定状态，仅负责样式控制                                                                                                                       | ^[boolean]                                     | false  |
| validate-event                 | 输入时是否触发表单的校验                                                                                                                             | ^[boolean]                                     | true   |
| tabindex                       | 输入框的 tabindex                                                                                                                                    | ^[string] / ^[number]                          | —      |
| id                             | input id                                                                                                                                             | ^[string]                                      | —      |
| aria-controls ^(a11y)          | 与 [aria-control](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-controls)一致, 当 `indeterminate`为 `true`时生效   | ^[string]                                      | —      |
| true-label ^(deprecated)       | 选中时的值                                                                                                                                           | ^[string] / ^[number]                          | —      |
| false-label ^(deprecated)      | 没有选中时的值                                                                                                                                       | ^[string] / ^[number]                          | —      |
| controls ^(a11y) ^(deprecated) | 和 [aria-control](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-controls)一致。当 `indeterminate` 为 `true` 时生效 | ^[string]                                      | —      |

### Events

| 事件名 | 说明                     | 类型                                                      |
| ------ | ------------------------ | --------------------------------------------------------- |
| change | 当绑定值变化时触发的事件 | ^[Function]`(value: string \| number \| boolean) => void` |

### Slots

| 插槽名  | 说明           |
| ------- | -------------- |
| default | 自定义默认内容 |
