使用场景:复选框允许用户从一个数据集中选择多个选项。
Checkbox 组件使用,分 label 和无 label 两种情况。defaultChecked 属性默认选中,checked 属性选中,disabled 属性不可操作,defaultIndeterminate 属性设置半选状态。
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
id | checkbox id, 挂载在input上 | String | - |
checked | 选中状态 | Boolean | - |
defaultChecked | 默认选中状态 | Boolean | false |
disabled | 禁用 | Boolean | - |
label | 通过属性配置label, | ReactNode | - |
indeterminate | Checkbox 的中间状态,只会影响到 Checkbox 的样式,并不影响其 checked 属性 | Boolean | - |
defaultIndeterminate | Checkbox 的默认中间态,只会影响到 Checkbox 的样式,并不影响其 checked 属性 | Boolean | false |
onChange | 状态变化时触发的事件 签名: Function(checked: Boolean, e: Event) => void 参数: checked: {Boolean} 是否选中 e: {Event} Dom 事件对象 | Function | func.noop |
onMouseEnter | 鼠标进入enter事件 签名: Function(e: Event) => void 参数: e: {Event} Dom 事件对象 | Function | func.noop |
onMouseLeave | 鼠标离开Leave事件 签名: Function(e: Event) => void 参数: e: {Event} Dom 事件对象 | Function | func.noop |
value | checkbox 的value | String/Number | - |
name | name | String | - |
isPreview | 是否为预览态 | Boolean | false |
renderPreview | 预览态模式下渲染的内容 签名: Function(value: number) => void 参数: value: {number} 评分值 | Function | - |
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
disabled | 整体禁用 | Boolean | - |
dataSource | 可选项列表, 数据项可为 String 或者 Object, 如 ['apple', 'pear', 'orange'] 或者 [{value: 'apple', label: '苹果',}, {value: 'pear', label: '梨'}, {value: 'orange', label: '橙子'}] | Array<String>/Array<Object> | [] |
value | 被选中的值列表 | Array/String/Number | - |
defaultValue | 默认被选中的值列表 | Array/String/Number | - |
children | 通过子元素方式设置内部 checkbox | Array<ReactElement> | - |
onChange | 选中值改变时的事件 签名: Function(value: Array, e: Event) => void 参数: value: {Array} 选中项列表 e: {Event} Dom 事件对象 | Function | () => {} |
itemDirection | 子项目的排列方式 - hoz: 水平排列 (default) - ver: 垂直排列 可选值: 'hoz', 'ver' | Enum | 'hoz' |
isPreview | 是否为预览态 | Boolean | false |
renderPreview | 预览态模式下渲染的内容 签名: Function(value: number) => void 参数: value: {number} 评分值 | Function | - |