CheckboxGroup
多选框群组,用于控制多选框全选或者不全选状态。
说明:
该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
子组件
无
接口
CheckboxGroup( options?: {group?: string} )
创建多选框群组,可以控制群组内的Checkbox全选或者不全选,相同group的Checkbox和CheckboxGroup为同一群组。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
---|---|---|---|
group | string | 否 | 群组名称。 |
属性
名称 | 参数类型 | 默认值 | 描述 |
---|---|---|---|
selectAll | boolean | false | 设置是否全选。 |
selectedColor | ResourceColor | - | 设置被选中或部分选中状态的颜色。 |
事件
onChange
onChange (callback: (event: CheckboxGroupResult ) => void )
CheckboxGroup的选中状态或群组内的Checkbox的选中状态发生变化时,触发回调。
名称 | 参数类型 | 必填 | 描述 |
---|---|---|---|
event | CheckboxGroupResult | 是 | 选中状态的回调结果。 |
CheckboxGroupResult
名称 | 参数类型 | 描述 |
---|---|---|
name | Array<string> | checkBox名称。 |
status | SelectStatus | 选中状态。 |
SelectStatus枚举说明
名称 | 描述 |
---|---|
All | 群组多选择框全部选择。 |
Part | 群组多选择框部分选择。 |
None | 群组多选择框全部没有选择。 |
示例
// xxx.ets
@Entry
@Component
struct CheckboxExample {
build() {
Scroll() {
Column() {
CheckboxGroup({group : 'checkboxGroup'})
.selectedColor(0xed6f21)
.onChange((itemName:CheckboxGroupResult) => {
console.info("TextPicker::dialogResult is" + JSON.stringify(itemName))
})
Checkbox({ name: 'checkbox1', group: 'checkboxGroup' })
.select(true)
.selectedColor(0x39a2db)
.onChange((value: boolean) => {
console.info('Checkbox1 change is' + value)
})
Checkbox({ name: 'checkbox2', group: 'checkboxGroup' })
.select(false)
.selectedColor(0x39a2db)
.onChange((value: boolean) => {
console.info('Checkbox2 change is' + value)
})
Checkbox({ name: 'checkbox3', group: 'checkboxGroup' })
.select(true)
.selectedColor(0x39a2db)
.onChange((value: boolean) => {
console.info('Checkbox3 change is' + value)
})
}
}
}
}