1# Checkbox 2 3提供多选框组件，通常用于某选项的打开或关闭。 4 5> **说明：** 6> 7> 该组件从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9## 子组件 10 11无 12 13## 接口 14 15Checkbox(options?: CheckboxOptions) 16 17多选框组件。 18 19**卡片能力：** 从API version 9开始，该接口支持在ArkTS卡片中使用。 20 21**系统能力：** SystemCapability.ArkUI.ArkUI.Full 22 23**参数：** 24 25| 参数名 | 类型 | 必填 | 描述 | 26| ------- | ------------------------------------------- | ---- | ------------------ | 27| options | [CheckboxOptions](#checkboxoptions对象说明) | 否 | 配置复选框的参数。 | 28 29## CheckboxOptions对象说明 30 31| 名称 | 类型 | 必填 | 说明 | 32| --------| --------| ------ | -------- | 33| name | [Length](ts-types.md#length) | 否 | 用于指定多选框名称。 | 34| group | [Length](ts-types.md#length) | 否 | 用于指定多选框所属群组的名称（即所属CheckboxGroup的名称）。<br/>**说明：** <br/>未配合使用[CheckboxGroup](ts-basic-components-checkboxgroup.md)组件时，此值无用。 | 35 36## 属性 37 38除支持[通用属性](ts-universal-attributes-size.md)外，还支持以下属性： 39 40 41| 名称 | 参数类型 | 描述 | 42| ------------- | ------- | -------- | 43| select | boolean | 设置多选框是否选中。<br/>默认值：false<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。<br />从API version 10开始，该属性支持[$$](../../quick-start/arkts-two-way-sync.md)双向绑定变量。 | 44| selectedColor | [ResourceColor](ts-types.md#resourcecolor) | 设置多选框选中状态颜色。<br/>**说明：**<br/>默认值：$r('sys.color.ohos_id_color_text_primary_activated')。<br/>异常值按照默认值处理。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 | 45| unselectedColor<sup>10+</sup> | [ResourceColor](ts-types.md#resourcecolor) | 设置多选框非选中状态边框颜色。 | 46| mark<sup>10+</sup> | [MarkStyle](#markstyle10对象说明) | 多选框内部图标样式。 | 47 48## 事件 49 50支持[通用事件](ts-universal-events-click.md)外，还支持以下事件： 51 52| 名称 | 功能描述 | 53| -------------------------------------------- | ------------------------------------------------------------ | 54| onChange(callback: (value: boolean) => void) | 当选中状态发生变化时，触发该回调。<br>- value为true时，表示已选中。<br>- value为false时，表示未选中。<br/>从API version 9开始，该接口支持在ArkTS卡片中使用。 | 55 56## MarkStyle<sup>10+</sup>对象说明 57 58| 名称 | 类型 | 必填 | 默认值 | 描述 | 59| ----------- | ------------------------------------------ | ---- | ----------- | ------------------------------------------------------------ | 60| strokeColor | [ResourceColor](ts-types.md#resourcecolor) | 否 | Color.White | 内部图标颜色。 | 61| size | number \| string | 否 | - | 内部图标大小，单位vp。默认大小与多选框组件宽度设置值一致。<br />不支持百分比形式设置。当设置为非法值时，按照默认值处理。 | 62| strokeWidth | number \| string | 否 | 2 | 内部图标粗细，单位vp。不支持百分比形式设置。当设置为非法值时，按照默认值处理。 | 63 64## 示例 65 66### 示例1 67 68```ts 69// xxx.ets 70@Entry 71@Component 72struct CheckboxExample { 73 74 build() { 75 Row() { 76 Checkbox({name: 'checkbox1', group: 'checkboxGroup'}) 77 .select(true) 78 .selectedColor(0xed6f21) 79 .onChange((value: boolean) => { 80 console.info('Checkbox1 change is'+ value) 81 }) 82 Checkbox({name: 'checkbox2', group: 'checkboxGroup'}) 83 .select(false) 84 .selectedColor(0x39a2db) 85 .onChange((value: boolean) => { 86 console.info('Checkbox2 change is'+ value) 87 }) 88 } 89 } 90} 91``` 92 93 94 95 96### 示例2 97 98```ts 99// xxx.ets 100@Entry 101@Component 102struct Index { 103 104 build() { 105 Row() { 106 Column() { 107 Flex({ justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) { 108 Checkbox({ name: 'checkbox1', group: 'checkboxGroup' }) 109 .selectedColor(0x39a2db) 110 .onChange((value: boolean) => { 111 console.info('Checkbox1 change is'+ value) 112 }) 113 .mark({ 114 strokeColor:Color.Black, 115 size: 50, 116 strokeWidth: 5 117 }) 118 .unselectedColor(Color.Red) 119 .width(30) 120 .height(30) 121 Text('Checkbox1').fontSize(20) 122 } 123 Flex({ justifyContent: FlexAlign.Center, alignItems: ItemAlign.Center }) { 124 Checkbox({ name: 'checkbox2', group: 'checkboxGroup' }) 125 .selectedColor(0x39a2db) 126 .onChange((value: boolean) => { 127 console.info('Checkbox2 change is' + value) 128 }) 129 .width(30) 130 .height(30) 131 Text('Checkbox2').fontSize(20) 132 } 133 } 134 .width('100%') 135 } 136 .height('100%') 137 } 138} 139``` 140 141 142
