zent
Version:
一套前端设计语言和基于React的实现
43 lines (30 loc) • 2.17 kB
Markdown
# zent-checkbox
[](https://www.npmjs.com/package/zent-checkbox) [](https://www.npmjs.com/package/zent-checkbox)
多选框组件
## 使用场景
在一组可选项中进行**多项选择**时
## 使用指南
- Checkbox 表现为一个[受控组件][controlled-components], 需要设置 `onChange` 回调在组件外部处理其 `value` 属性的变化.
- `value` 支持任意类型的值, 包括引用类型.
## Checkbox API
| 参数 | 说明 | 类型 | 默认值 |
| ------------- | --------- | ------------- | -------- |
| checked | 指定当前是否选中 | bool | `false` |
| value | 组件对应的值 | any | |
| disabled | 使组件不可用 | bool | |
| readOnly | 使组件只读 | bool | |
| indeterminate | 展示部分选中的模式 | bool | `false` |
| onChange | 变化时回调函数 | func(e:Event) | |
| className | 自定义额外类名 | string | |
| prefix | 自定义前缀 | string | `'zent'` |
## Checkbox Group API
| 参数 | 说明 | 类型 | 默认值 |
| ------------ | --------------- | ------------------ | --------------- |
| value | 必填,指定选中的选项 | array<any> | `[]` |
| isValueEqual | 可选,判断value值是否相等 | func(a, b) | `() => a === b` |
| disabled | 使组件不可用 | bool | |
| readOnly | 使组件只读 | bool | |
| onChange | 变化时回调函数 | func(checkedValue) | |
| className | 自定义额外类名 | string | |
| prefix | 自定义前缀 | string | `'zent'` |
[controlled-components]: https://facebook.github.io/react/docs/forms.html#controlled-components