CheckboxGroup
多選框群組,用于控制多選框全選或者不全選狀態(tài)。
說明:
開發(fā)前請(qǐng)熟悉鴻蒙開發(fā)指導(dǎo)文檔 :[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]
該組件從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卡片中使用。**說明:**若同組的[Checkbox]顯式設(shè)置了select屬性,則Checkbox的優(yōu)先級(jí)高。 從API version 10開始,該屬性支持[$$]雙向綁定變量。 |
| selectedColor | [ResourceColor] | 設(shè)置被選中或部分選中狀態(tài)的顏色。 從API version 9開始,該接口支持在ArkTS卡片中使用。 |
| unselectedColor10+ | [ResourceColor] | 設(shè)置非選中狀態(tài)邊框顏色。 |
| mark10+ | [MarkStyle] | 多選框內(nèi)部圖標(biāo)樣式。 |
事件
除支持[通用事件]外,還支持以下事件:
| 名稱 | 功能描述 |
|---|---|
| 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 | 群組內(nèi)所有被選中的多選框名稱。 |
| status | [SelectStatus] | 選中狀態(tài)。 |
SelectStatus枚舉說明
從API version 9開始,該接口支持在ArkTS卡片中使用。
| 名稱 | 描述 |
|---|---|
| All | 群組多選擇框全部選擇。 |
| Part | 群組多選擇框部分選擇。 |
| None | 群組多選擇框全部沒有選擇。 |
MarkStyle10+對(duì)象說明
| 名稱 | 類型 | 必填 | 默認(rèn)值 | 描述 |
|---|---|---|---|---|
| strokeColor | [ResourceColor] | 否 | Color.White | 內(nèi)部圖標(biāo)顏色。 |
| size | number | string | 否 | - |
| strokeWidth | number | string | 否 | 2 |
示例
示例1
// xxx.ets
@Entry
@Component
struct CheckboxExample {
build() {
Scroll() {
Column() {
// 全選按鈕
Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
CheckboxGroup({ group: 'checkboxGroup' })
.selectedColor('#007DFF')
.onChange((itemName: CheckboxGroupResult) = > {
console.info("checkbox group content" + JSON.stringify(itemName))
})
Text('Select All').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500)
}
// 選項(xiàng)1
Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
Checkbox({ name: 'checkbox1', group: 'checkboxGroup' })
.selectedColor('#007DFF')
.onChange((value: boolean) = > {
console.info('Checkbox1 change is' + value)
})
Text('Checkbox1').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500)
}.margin({ left: 36 })
// 選項(xiàng)2
Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
Checkbox({ name: 'checkbox2', group: 'checkboxGroup' })
.selectedColor('#007DFF')
.onChange((value: boolean) = > {
console.info('Checkbox2 change is' + value)
})
Text('Checkbox2').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500)
}.margin({ left: 36 })
// 選項(xiàng)3
Flex({ justifyContent: FlexAlign.Start, alignItems: ItemAlign.Center }) {
Checkbox({ name: 'checkbox3', group: 'checkboxGroup' })
.selectedColor('#007DFF')
.onChange((value: boolean) = > {
console.info('Checkbox3 change is' + value)
})
Text('Checkbox3').fontSize(14).lineHeight(20).fontColor('#182431').fontWeight(500)
}.margin({ left: 36 })
}
}
}
}

示例2
// xxx.ets
@Entry
@Component
struct Index {
build() {
Row() {
Column() {
Flex({ justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) {
CheckboxGroup({ group: 'checkboxGroup' })
.selectedColor(Color.Orange)
.onChange((itemName: CheckboxGroupResult) = > {
console.info("checkbox group content" + JSON.stringify(itemName))
})
.mark({
strokeColor:Color.Black,
size: 40,
strokeWidth: 5
})
.unselectedColor(Color.Red)
.width(30)
.height(30)
Text('Select All').fontSize(20)
}.margin({right:15})
Flex({ justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) {
Checkbox({ name: 'checkbox1', group: 'checkboxGroup' })
.selectedColor(0x39a2db)
.onChange((value: boolean) = > {
console.info('Checkbox1 change is'+ value)
})
.mark({
strokeColor:Color.Black,
size: 50,
strokeWidth: 5
})
.unselectedColor(Color.Red)
.width(30)
.height(30)
Text('Checkbox1').fontSize(20)
}
Flex({ justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) {
Checkbox({ name: 'checkbox2', group: 'checkboxGroup' })
.selectedColor(0x39a2db)
.onChange((value: boolean) = > {
console.info('Checkbox2 change is' + value)
})
.width(30)
.height(30)
Text('Checkbox2').fontSize(20)
}
Flex({ justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) {
Checkbox({ name: 'checkbox3', group: 'checkboxGroup' })
.selectedColor(0x39a2db)
.onChange((value: boolean) = > {
console.info('Checkbox3 change is' + value)
})
.width(30)
.height(30)
Text('Checkbox3').fontSize(20)
}
}
.width('100%')
}
.height('100%')
}
}


審核編輯 黃宇
-
組件
+關(guān)注
關(guān)注
1文章
583瀏覽量
19045 -
鴻蒙
+關(guān)注
關(guān)注
60文章
2983瀏覽量
46045
發(fā)布評(píng)論請(qǐng)先 登錄
基于凌羽派的OpenHarmony北向應(yīng)用開發(fā):ArkTS語法-數(shù)據(jù)類型和變量聲明
基于凌羽派的OpenHarmony北向應(yīng)用開發(fā):ArkTS語法-數(shù)據(jù)類型和變量聲明
釘釘正式開源HarmonyOS圖片編輯組件
發(fā)布元服務(wù)配置隱私聲明
鴻蒙非侵入式彈窗新解法,企查查正式開源“QuickDialog”彈窗組件庫
【HarmonyOS 5】鴻蒙頁面和組件生命周期函數(shù)
【HarmonyOS 5】金融應(yīng)用開發(fā)鴻蒙組件實(shí)踐
【 HarmonyOS 5 入門系列 】鴻蒙HarmonyOS示例項(xiàng)目講解
鴻蒙ArkTS聲明式組件:CheckboxGroup
評(píng)論