• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Checkbox
2
3提供多选框组件,通常用于某选项的打开或关闭。
4
5>  **说明:**
6>
7>  该组件从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
8
9## 权限列表
10
1112
13## 子组件
14
1516
17## 接口
18
19Checkbox( options?: {name?: string,  group?: string} )
20
21**参数:**
22
23| 参数名   | 参数类型   | 必填   | 默认值  | 参数描述      |
24| ----- | ------ | ---- | ---- | --------- |
25| name  | string | 否    | -    | 多选框名称。    |
26| group | string | 否    | -    | 多选框的群组名称。 |
27
28## 属性
29
30| 名称            | 参数类型  | 默认值   | 描述           |
31| ------------- | ----- | ----- | ------------ |
32| select        | boolean  | false | 设置多选框是否选中。   |
33| selectedColor | [ResourceColor](ts-types.md#resourcecolor8) | -     | 设置多选框选中状态颜色。 |
34
35## 事件
36
37| 名称                                       | 功能描述                                     |
38| ---------------------------------------- | ---------------------------------------- |
39| onChange(callback: (value: boolean) => void) | 当选中状态发生变化时,触发该回调。<br>- value为true时,表示已选中。<br>- value为false时,表示未选中。 |
40
41## 示例
42
43```ts
44// xxx.ets
45@Entry
46@Component
47struct CheckboxExample {
48
49  build() {
50    Row() {
51      Checkbox({name: 'checkbox1',  group: 'checkboxGroup'})
52        .select(true)
53        .selectedColor(0xed6f21)
54        .onChange((value: boolean) => {
55          console.info('Checkbox1 change is'+ value)
56        })
57      Checkbox({name: 'checkbox2',  group: 'checkboxGroup'})
58        .select(false)
59        .selectedColor(0x39a2db)
60        .onChange((value: boolean) => {
61          console.info('Checkbox2 change is'+ value)
62        })
63    }
64  }
65}
66```
67
68
69![](figures/checkbox.gif)