多选框群组

2024-01-22 17:07 更新

多选框群组,用于控制多选框全选或者不全选状态。

说明

该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。

子组件

接口

CheckboxGroup(options?: { group?: string })

创建多选框群组,可以控制群组内的Checkbox全选或者不全选,group值相同的Checkbox和CheckboxGroup为同一群组。

从API version 9开始,该接口支持在ArkTS卡片中使用。

参数:

参数名

参数类型

必填

参数描述

group

string

群组名称。

说明:

多个相同群组名称的CheckboxGroup,仅第一个CheckboxGroup生效。

属性

除支持通用属性外,还支持以下属性:

名称

参数类型

描述

selectAll

boolean

设置是否全选。

默认值:false,若同组的Checkbox显式设置select,则Checkbox的优先级高。

从API version 9开始,该接口支持在ArkTS卡片中使用。

selectedColor

ResourceColor

设置被选中或部分选中状态的颜色。

从API version 9开始,该接口支持在ArkTS卡片中使用。

事件

除支持通用事件外,还支持以下事件:

名称

功能描述

onChange (callback: (event: CheckboxGroupResult) => void )

CheckboxGroup的选中状态或群组内的Checkbox的选中状态发生变化时,触发回调。

从API version 9开始,该接口支持在ArkTS卡片中使用。

CheckboxGroupResult对象说明

从API version 9开始,该接口支持在ArkTS卡片中使用。

名称

类型

描述

name

Array<string>

群组内所有被选中的多选框名称。

status

SelectStatus

选中状态。

SelectStatus枚举说明

从API version 9开始,该接口支持在ArkTS卡片中使用。

名称

描述

All

群组多选择框全部选择。

Part

群组多选择框部分选择。

None

群组多选择框全部没有选择。

示例

  1. // xxx.ets
  2. @Entry
  3. @Component
  4. struct CheckboxExample {
  5. build() {
  6. Scroll() {
  7. Column() {
  8. // 全选按钮
  9. Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
  10. CheckboxGroup({ group: 'checkboxGroup' })
  11. .selectedColor('#007DFF')
  12. .onChange((itemName: CheckboxGroupResult) => {
  13. console.info("checkbox group content" + JSON.stringify(itemName))
  14. })
  15. Text('Select All').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500)
  16. }
  17. // 选项1
  18. Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
  19. Checkbox({ name: 'checkbox1', group: 'checkboxGroup' })
  20. .selectedColor('#007DFF')
  21. .onChange((value: boolean) => {
  22. console.info('Checkbox1 change is' + value)
  23. })
  24. Text('Checkbox1').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500)
  25. }.margin({ left: 36 })
  26. // 选项2
  27. Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
  28. Checkbox({ name: 'checkbox2', group: 'checkboxGroup' })
  29. .selectedColor('#007DFF')
  30. .onChange((value: boolean) => {
  31. console.info('Checkbox2 change is' + value)
  32. })
  33. Text('Checkbox2').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500)
  34. }.margin({ left: 36 })
  35. // 选项3
  36. Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
  37. Checkbox({ name: 'checkbox3', group: 'checkboxGroup' })
  38. .selectedColor('#007DFF')
  39. .onChange((value: boolean) => {
  40. console.info('Checkbox3 change is' + value)
  41. })
  42. Text('Checkbox3').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500)
  43. }.margin({ left: 36 })
  44. }
  45. }
  46. }
  47. }

以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号