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 | 否 | 群组名称。<br/>**说明：** <br/>多个相同群组名称的CheckboxGroup，仅第一个CheckboxGroup生效。 | 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的优先级高。<br />从API version 10开始，该属性支持[$$](../../quick-start/arkts-two-way-sync.md)双向绑定变量。 | 34| selectedColor | [ResourceColor](ts-types.md#resourcecolor) | 设置被选中或部分选中状态的颜色。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 | 35| unselectedColor<sup>10+</sup> | [ResourceColor](ts-types.md#resourcecolor) | 设置非选中状态边框颜色。 | 36| mark<sup>10+</sup> | [MarkStyle](#markstyle10对象说明) | 多选框内部图标样式。 | 37 38## 事件 39 40除支持[通用事件](ts-universal-events-click.md)外，还支持以下事件： 41 42| 名称 | 功能描述 | 43| -------- | -------- | 44| onChange (callback: (event: [CheckboxGroupResult](#checkboxgroupresult对象说明)) => void ) |CheckboxGroup的选中状态或群组内的Checkbox的选中状态发生变化时，触发回调。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。| 45 46## CheckboxGroupResult对象说明 47 48从API version 9开始，该接口支持在ArkTS卡片中使用。 49 50| 名称 | 类型 | 描述 | 51| ------ | ------ | ------- | 52| name | Array<string> | 群组内所有被选中的多选框名称。 | 53| status | [SelectStatus](#selectstatus枚举说明) | 选中状态。 | 54 55## SelectStatus枚举说明 56 57从API version 9开始，该接口支持在ArkTS卡片中使用。 58 59| 名称 | 描述 | 60| ----- | -------------------- | 61| All | 群组多选择框全部选择。 | 62| Part | 群组多选择框部分选择。 | 63| None | 群组多选择框全部没有选择。 | 64 65## MarkStyle<sup>10+</sup>对象说明 66 67| 名称 | 类型 | 必填 | 默认值 | 描述 | 68| ----------- | ------------------------------------------ | ---- | ----------- | ------------------------------------------------------------ | 69| strokeColor | [ResourceColor](ts-types.md#resourcecolor) | 否 | Color.White | 内部图标颜色。 | 70| size | number \| string | 否 | - | 内部图标大小，单位vp。默认大小与多选框群组组件宽度设置值一致。<br />不支持百分比形式设置。当设置为非法值时，按照默认值处理。 | 71| strokeWidth | number \| string | 否 | 2 | 内部图标粗细，单位vp。不支持百分比形式设置。当设置为非法值时，按照默认值处理。 | 72 73## 示例 74 75### 示例1 76 77```ts 78// xxx.ets 79@Entry 80@Component 81struct CheckboxExample { 82 build() { 83 Scroll() { 84 Column() { 85 // 全选按钮 86 Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) { 87 CheckboxGroup({ group: 'checkboxGroup' }) 88 .selectedColor('#007DFF') 89 .onChange((itemName: CheckboxGroupResult) => { 90 console.info("checkbox group content" + JSON.stringify(itemName)) 91 }) 92 Text('Select All').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500) 93 } 94 95 // 选项1 96 Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) { 97 Checkbox({ name: 'checkbox1', group: 'checkboxGroup' }) 98 .selectedColor('#007DFF') 99 .onChange((value: boolean) => { 100 console.info('Checkbox1 change is' + value) 101 }) 102 Text('Checkbox1').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500) 103 }.margin({ left: 36 }) 104 105 // 选项2 106 Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) { 107 Checkbox({ name: 'checkbox2', group: 'checkboxGroup' }) 108 .selectedColor('#007DFF') 109 .onChange((value: boolean) => { 110 console.info('Checkbox2 change is' + value) 111 }) 112 Text('Checkbox2').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500) 113 }.margin({ left: 36 }) 114 115 // 选项3 116 Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) { 117 Checkbox({ name: 'checkbox3', group: 'checkboxGroup' }) 118 .selectedColor('#007DFF') 119 .onChange((value: boolean) => { 120 console.info('Checkbox3 change is' + value) 121 }) 122 Text('Checkbox3').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500) 123 }.margin({ left: 36 }) 124 } 125 } 126 } 127} 128``` 129 130 131### 示例2 132 133```ts 134// xxx.ets 135@Entry 136@Component 137struct Index { 138 139 build() { 140 Row() { 141 Column() { 142 Flex({ justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) { 143 CheckboxGroup({ group: 'checkboxGroup' }) 144 .selectedColor(Color.Orange) 145 .onChange((itemName: CheckboxGroupResult) => { 146 console.info("checkbox group content" + JSON.stringify(itemName)) 147 }) 148 .mark({ 149 strokeColor:Color.Black, 150 size: 40, 151 strokeWidth: 5 152 }) 153 .unselectedColor(Color.Red) 154 .width(30) 155 .height(30) 156 Text('Select All').fontSize(20) 157 }.margin({right:15}) 158 Flex({ justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) { 159 Checkbox({ name: 'checkbox1', group: 'checkboxGroup' }) 160 .selectedColor(0x39a2db) 161 .onChange((value: boolean) => { 162 console.info('Checkbox1 change is'+ value) 163 }) 164 .mark({ 165 strokeColor:Color.Black, 166 size: 50, 167 strokeWidth: 5 168 }) 169 .unselectedColor(Color.Red) 170 .width(30) 171 .height(30) 172 Text('Checkbox1').fontSize(20) 173 } 174 Flex({ justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) { 175 Checkbox({ name: 'checkbox2', group: 'checkboxGroup' }) 176 .selectedColor(0x39a2db) 177 .onChange((value: boolean) => { 178 console.info('Checkbox2 change is' + value) 179 }) 180 .width(30) 181 .height(30) 182 Text('Checkbox2').fontSize(20) 183 } 184 Flex({ justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) { 185 Checkbox({ name: 'checkbox3', group: 'checkboxGroup' }) 186 .selectedColor(0x39a2db) 187 .onChange((value: boolean) => { 188 console.info('Checkbox3 change is' + value) 189 }) 190 .width(30) 191 .height(30) 192 Text('Checkbox3').fontSize(20) 193 } 194 } 195 .width('100%') 196 } 197 .height('100%') 198 } 199} 200``` 201 202 203 204
