1# CheckboxGroup 2 3多选框群组，用于控制多选框全选或者不全选状态。 4 5> **说明：** 6> 7> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9## 子组件 10 11无 12 13## 接口 14 15CheckboxGroup(options?: { group?: string }) 16 17创建多选框群组，可以控制群组内的Checkbox全选或者不全选，group值相同的Checkbox和CheckboxGroup为同一群组。 18 19从API version 9开始，该接口支持在ArkTS卡片中使用。 20 21**参数:** 22 23| 参数名 | 参数类型 | 必填 | 参数描述 | 24| -------- | -------- | -------- | -------- | 25| group | string | 否 | 群组名称。| 26 27## 属性 28 29除支持[通用属性](ts-universal-attributes-size.md)外，还支持以下属性： 30 31| 名称 | 参数类型 | 描述 | 32| -------- | -------- | -------- | 33| selectAll | boolean | 设置是否全选。<br/>默认值：false，若同组的[Checkbox](ts-basic-components-checkbox.md)设置了select属性，则Checkbox的优先级高。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。<br/>**说明：** <br/>若同组的[Checkbox](ts-basic-components-checkbox.md)显式设置了select属性，则Checkbox的优先级高。 | 34| selectedColor | [ResourceColor](ts-types.md#resourcecolor) | 设置被选中或部分选中状态的颜色。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 | 35 36## 事件 37 38除支持[通用事件](ts-universal-events-click.md)外，还支持以下事件： 39 40| 名称 | 功能描述 | 41| -------- | -------- | 42| onChange (callback: (event: [CheckboxGroupResult](#checkboxgroupresult对象说明)) => void ) |CheckboxGroup的选中状态或群组内的Checkbox的选中状态发生变化时，触发回调。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。| 43 44## CheckboxGroupResult对象说明 45 46从API version 9开始，该接口支持在ArkTS卡片中使用。 47 48| 名称 | 类型 | 描述 | 49| ------ | ------ | ------- | 50| name | Array<string> | 群组内所有被选中的多选框名称。 | 51| status | [SelectStatus](#selectstatus枚举说明) | 选中状态。 | 52 53## SelectStatus枚举说明 54 55从API version 9开始，该接口支持在ArkTS卡片中使用。 56 57| 名称 | 描述 | 58| ----- | -------------------- | 59| All | 群组多选择框全部选择。 | 60| Part | 群组多选择框部分选择。 | 61| None | 群组多选择框全部没有选择。 | 62 63 64## 示例 65 66```ts 67// xxx.ets 68@Entry 69@Component 70struct CheckboxExample { 71 build() { 72 Scroll() { 73 Column() { 74 // 全选按钮 75 Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) { 76 CheckboxGroup({ group: 'checkboxGroup' }) 77 .selectedColor('#007DFF') 78 .onChange((itemName: CheckboxGroupResult) => { 79 console.info("checkbox group content" + JSON.stringify(itemName)) 80 }) 81 Text('Select All').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500) 82 } 83 84 // 选项1 85 Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) { 86 Checkbox({ name: 'checkbox1', group: 'checkboxGroup' }) 87 .selectedColor('#007DFF') 88 .onChange((value: boolean) => { 89 console.info('Checkbox1 change is' + value) 90 }) 91 Text('Checkbox1').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500) 92 }.margin({ left: 36 }) 93 94 // 选项2 95 Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) { 96 Checkbox({ name: 'checkbox2', group: 'checkboxGroup' }) 97 .selectedColor('#007DFF') 98 .onChange((value: boolean) => { 99 console.info('Checkbox2 change is' + value) 100 }) 101 Text('Checkbox2').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500) 102 }.margin({ left: 36 }) 103 104 // 选项3 105 Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) { 106 Checkbox({ name: 'checkbox3', group: 'checkboxGroup' }) 107 .selectedColor('#007DFF') 108 .onChange((value: boolean) => { 109 console.info('Checkbox3 change is' + value) 110 }) 111 Text('Checkbox3').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500) 112 }.margin({ left: 36 }) 113 } 114 } 115 } 116} 117``` 118 119
