多選框群組

2024-01-22 17:07 更新

多選框群組,用于控制多選框全選或者不全選狀態(tài)。

說明

該組件從API Version 8開始支持。后續(xù)版本如有新增內(nèi)容,則采用上角標(biāo)單獨(dú)標(biāo)記該內(nèi)容的起始版本。

子組件

接口

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

創(chuàng)建多選框群組,可以控制群組內(nèi)的Checkbox全選或者不全選,group值相同的Checkbox和CheckboxGroup為同一群組。

從API version 9開始,該接口支持在ArkTS卡片中使用。

參數(shù):

參數(shù)名

參數(shù)類型

必填

參數(shù)描述

group

string

群組名稱。

說明:

多個(gè)相同群組名稱的CheckboxGroup,僅第一個(gè)CheckboxGroup生效。

屬性

除支持通用屬性外,還支持以下屬性:

名稱

參數(shù)類型

描述

selectAll

boolean

設(shè)置是否全選。

默認(rèn)值:false,若同組的Checkbox顯式設(shè)置select,則Checkbox的優(yōu)先級(jí)高。

從API version 9開始,該接口支持在ArkTS卡片中使用。

selectedColor

ResourceColor

設(shè)置被選中或部分選中狀態(tài)的顏色。

從API version 9開始,該接口支持在ArkTS卡片中使用。

事件

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

名稱

功能描述

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

CheckboxGroup的選中狀態(tài)或群組內(nèi)的Checkbox的選中狀態(tài)發(fā)生變化時(shí),觸發(fā)回調(diào)。

從API version 9開始,該接口支持在ArkTS卡片中使用。

CheckboxGroupResult對(duì)象說明

從API version 9開始,該接口支持在ArkTS卡片中使用。

名稱

類型

描述

name

Array<string>

群組內(nèi)所有被選中的多選框名稱。

status

SelectStatus

選中狀態(tài)。

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. // 選項(xiàng)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. // 選項(xiàng)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. // 選項(xiàng)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. }

以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)