多选框群组,用于控制多选框全选或者不全选状态。
如果要控制多个 Checkbox 的选中状态,可以通过CheckBoxGroup来实现。
说明
该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
无子组件 。
接口
CheckboxGroup(options?: CheckboxGroupOptions)
创建多选框群组,可以控制群组内的Checkbox全选或者不全选,group值相同的Checkbox和CheckboxGroup为同一群组。
在结合带缓存组件使用时(如List),未被创建的Checkbox选中状态需要应用手动控制。
卡片能力: 从API version 9开始,该接口支持在ArkTS卡片中使用。
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
参数说明(CheckboxGroupOptions)
名称 | 类型 | 必填 | 说明 | |
group | string | 否 | 群组名称。 说明: 多个相同群组名称的CheckboxGroup,仅第一个CheckboxGroup生效。 |
常用属性
名称 | 参数类型 | 描述 | ||
selectAll | boolean | 设置是否全选。 默认值: false,若同组的Checkbox设置了select属性,则Checkbox的优先级高。 该属性支持$$,双向绑定变量。 | ||
selectedColor | ResourceColor | 设置被选中或部分选中状态的颜色。 | ||
unselectedColor | ResourceColor | 设置非选中状态边框颜色。 |
代码
@Entry
@Component
struct Index {
fruits: string[] = ['西瓜', '西红柿', '西兰花', '西葫芦']
build() {
Column() {
Text('选中的是:' )
Row() {
CheckboxGroup({
group: 'food'
})
.selectedColor(Color.Red)//选中的颜色
.unselectedColor(Color.Pink)//设置非选中状态边框颜色。
Text('全选')
}
Column() {
ForEach(this.fruits, (item: string) => {
Row() {
Checkbox({
group: 'food'
})
Text(item)
}
})
}
.padding({ left: 20 })
.alignItems(HorizontalAlign.Start)
}
.padding(20)
.alignItems(HorizontalAlign.Start)
}
}