category: Components type: UI Views component: Form chinese: 复选框组 english: CheckboxGroupField source: next-checkbox

复选框允许用户从一个数据集中选择多个选项。如果在一个列表中有多个选项，你可以通过使用复选框而不是开/关切换来节省空间。如果你有一个单选项，不要用复选框，使用开/关切换

API

CheckboxGroupField

| 参数 | 说明 | 类型 | 默认值 | | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | -------- | | prefix | 样式类名的品牌前缀 | String | 'next-' | | className | 自定义类名 | String | - | | style | 自定义内敛样式 | Object | - | | value | 被选中的值列表 | Array | - | | defaultValue | 默认被选中的值列表 | Array | - | | onChange | 选中值改变时的事件签名:Function(value: Array, e: Event) => void参数:value: {Array} 选中项列表e: {Event} Dom 事件对象 | Function | () => {} | | disabled | 整体禁用 | Boolean | - | | dataSource | 可选项列表, 数据项可为 String 或者 Object, 如 ['apple', 'pear', 'orange'] 或者 [{value: 'apple', label: '苹果',}, {value: 'pear', label: '梨'}, {value: 'orange', label: '橙子'}] | Array<any> | [] | | children | 通过子元素方式设置内部 checkbox | Array<ReactElement> | - || label | label 标签的文本 | ReactNode | - | | labelCol | label 标签布局，通 <Col> 组件，设置 span offset 值，如 {span: 8, offset: 16}，该项仅在垂直表单有效 | Object | - | | help | 提示信息，如不设置，则会根据校验规则自动生成. 如果设置会受控（ps: 可以利用这点自定义错误位置,详细看demo自定义错误) | ReactNode | - | | validateStatus | 校验状态，如不设置，则会根据校验规则自动生成可选值:'''success'(成功)'error'(失败)'loading'(校验中) | Enum | - | | hasFeedback | 配合 validateStatus 属性使用，是否展示校验状态图标, 目前只有Input支持 | Boolean | false | | wrapperCol | 需要为输入控件设置布局样式时，使用该属性，用法同 labelCol | Object | - | | extra | 额外的提示信息，和 help 类似，当需要错误信息和提示文案同时出现时，可以使用这个。 位于错误信息后面 | ReactNode | - | | inputStyle | 表单输入框自定义内联样式 | Object/String | null | | showValidateType | 应用于Field 类元素后，指定其展示错误的方式，可选值有 help、tooltip 两种| String | help | | name | walle 模式下才支持 可以配合表单Form 收集表单元素的数据，要求表单必须指定 field 属性 | String | '' | | rules | walle 模式下才支持 配置表单规则，可以配置多个规则，可参考：async-validator，注意Form 表单必须配置field 属性才会生效 | Array | null | | x-bind | walle 模式下才支持 双向绑定某一个变量 | state | null |

子标签 Checkbox

| 参数 | 说明 | 类型 | 默认值 | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -------- | -------- | | prefix | 样式类名的品牌前缀 | String | 'next-' | | className | 自定义类名 | String | - | | style | 自定义内敛样式 | Object | - | | onChange | 状态变化时触发的事件签名:Function(checked: Boolean, e: Event) => void参数:checked: {Boolean} 是否选中e: {Event} Dom 事件对象 | Function | () => {} | | checked | 选中状态 | Boolean | - | | defaultChecked | 默认选中状态 | Boolean | false | | disabled | 禁用 | Boolean | - | | indeterminate | Checkbox 的中间状态，只会影响到 Checkbox 的样式，并不影响其 checked 属性 | Boolean | - | | defaultIndeterminate | Checkbox 的默认中间态，只会影响到 Checkbox 的样式，并不影响其 checked 属性 | Boolean | false |