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