1# 无障碍属性 2 3组件可以设置相应的无障碍属性和事件来更好地使用无障碍能力。 4 5> **说明：** 6> 7> 从API Version 10 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9## accessibilityGroup 10 11accessibilityGroup(value: boolean) 12 13无障碍组。 14 15**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。 16 17**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 18 19**系统能力：** SystemCapability.ArkUI.ArkUI.Full 20 21**参数：** 22 23| 参数名 | 类型 | 必填 | 说明 | 24| ------ | ------- | ---- | ------------------------------------------------------------ | 25| value | boolean | 是 | 无障碍组，设置为true时表示该组件及其所有子组件为一整个可以选中的组件，无障碍服务将不再关注其子组件内容。<br/>默认值：false | 26 27## accessibilityGroup<sup>14+</sup> 28 29accessibilityGroup(isGroup: boolean, accessibilityOptions: AccessibilityOptions) 30 31无障碍组，支持优先拼接无障碍文本进行朗读。 32 33**卡片能力：** 从API version 14开始，该接口支持在ArkTS卡片中使用。 34 35**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。 36 37**系统能力：** SystemCapability.ArkUI.ArkUI.Full 38 39**参数：** 40 41| 参数名 | 类型 | 必填 | 说明 | 42| -------------------- | ------------------------------------------------------- | ---- | ------------------------------------------------------------ | 43| isGroup | boolean | 是 | 无障碍组，设置为true时表示该组件及其所有子组件为一整个可以选中的组件，无障碍服务将不再关注其子组件内容。<br/>默认值：false | 44| accessibilityOptions | [AccessibilityOptions](#accessibilityoptions14对象说明) | 否 | 设置为true时，使应用优先拼接无障碍文本进行朗读。 | 45 46## AccessibilityOptions<sup>14+</sup>对象说明 47 48**系统能力：** SystemCapability.ArkUI.ArkUI.Full 49 50| 名称 | 类型 | 必填 | 说明 | 51| ---------------------- | ------- | ---- | ------------------------------------------------------------ | 52| accessibilityPreferred | boolean | 否 | 若accessibilityPreferred设置为true，则深度遍历每个子节点时优先选择该子节点的无障碍文本accessibilityText。<br/>若无障碍文本为空则选择本身Text文本，最终将拼接完成的文本设置给accessibilityText与Text都为空的父节点。 | 53 54## accessibilityText 55 56accessibilityText(value: string) 57 58无障碍文本。 59 60**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。 61 62**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 63 64**系统能力：** SystemCapability.ArkUI.ArkUI.Full 65 66**参数：** 67 68| 参数名 | 类型 | 必填 | 说明 | 69| ------ | ------ | ---- | ------------------------------------------------------------ | 70| value | string | 是 | 无障碍文本，当组件不包含文本属性时，屏幕朗读选中此组件时不播报，使用者无法清楚地知道当前选中了什么组件。为了解决此场景，开发人员可为不包含文字信息的组件设置无障碍文本，当屏幕朗读选中此组件时播报无障碍文本的内容，帮助屏幕朗读的使用者清楚地知道自己选中了什么组件。<br/>默认值：“”<br/>**说明：**<br/>若组件既拥有文本属性，又拥有无障碍文本属性，则组件被选中时，仅播报无障碍文本内容。<br/>若组件设置了无障碍分组属性为true，但是即没有无障碍文本属性，也没有文本属性，会对其子节点的组件进行文本拼接（深度优先）。<br/>不对无障碍文本属性进行拼接，如需优先拼接无障碍文本，则需设置accessibilityGroup的accessibilityPreferred。 | 71 72## accessibilityText<sup>12+</sup> 73 74accessibilityText(text: Resource) 75 76无障碍文本，支持通过Resource引用资源文件。 77 78**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。 79 80**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 81 82**系统能力：** SystemCapability.ArkUI.ArkUI.Full 83 84**参数：** 85 86| 参数名 | 类型 | 必填 | 说明 | 87| ------ | ------ | ---- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 88| text | [Resource](ts-types.md#resource) | 是 | 无障碍文本引用资源，当组件不包含文本属性时，屏幕朗读选中此组件时不播报，使用者无法清楚地知道当前选中了什么组件。为了解决此场景，开发人员可为不包含文字信息的组件设置无障碍文本，当屏幕朗读选中此组件时播报无障碍文本的内容，帮助屏幕朗读的使用者清楚地知道自己选中了什么组件。<br/>**说明：**<br/>若组件既拥有文本属性，又拥有无障碍文本属性，则组件被选中时，仅播报无障碍文本内容。<br/>若组件设置了无障碍分组属性为true，但是即没有无障碍文本属性，也没有文本属性，会对其子节点的组件进行文本拼接（深度优先）。<br/>不对无障碍文本属性进行拼接，如需优先拼接无障碍文本，则需设置accessibilityGroup的accessibilityPreferred。 | 89 90 91## accessibilityDescription 92 93accessibilityDescription(value: string) 94 95无障碍说明。 96 97**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。 98 99**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 100 101**系统能力：** SystemCapability.ArkUI.ArkUI.Full 102 103**参数：** 104 105| 参数名 | 类型 | 必填 | 说明 | 106| ------ | ------ | ---- | ------------------------------------------------------------ | 107| value | string | 是 | 无障碍说明，用于为用户进一步说明当前组件，开发人员可为组件的该属性设置相对较详细的解释文本，帮助用户理解将要执行的操作。如帮助用户理解将要执行的操作可能导致什么后果，尤其是当这些后果无法从组件本身属性与无障碍文本中了解到时。若组件既拥有文本属性又拥有无障碍说明属性，则组件被选中时，先播报组件的文本属性，再播报无障碍说明属性的内容。<br/>默认值：“” | 108 109## accessibilityDescription<sup>12+</sup> 110 111accessibilityDescription(description: Resource) 112 113无障碍说明，支持通过Resource引用资源文件。 114 115**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。 116 117**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 118 119**系统能力：** SystemCapability.ArkUI.ArkUI.Full 120 121**参数：** 122 123| 参数名 | 类型 | 必填 | 说明 | 124| ------ | ------ | ---- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 125| description | [Resource](ts-types.md#resource) | 是 | 无障碍说明引用资源，用于为用户进一步说明当前组件，开发人员可为组件的该属性设置相对较详细的解释文本，帮助用户理解将要执行的操作。如帮助用户理解将要执行的操作可能导致什么后果，尤其是当这些后果无法从组件本身属性与无障碍文本中了解到时。若组件既拥有文本属性又拥有无障碍说明属性，则组件被选中时，先播报组件的文本属性，再播报无障碍说明属性的内容。 | 126 127## accessibilityLevel 128 129accessibilityLevel(value: string) 130 131无障碍重要性。 132 133**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。 134 135**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 136 137**系统能力：** SystemCapability.ArkUI.ArkUI.Full 138 139**参数：** 140 141| 参数名 | 类型 | 必填 | 说明 | 142| ------ | ------ | ---- | ------------------------------------------------------------ | 143| value | string | 是 | 无障碍重要性，用于控制某个组件是否可被无障碍辅助服务所识别。<br/>支持的值为:<br/>"auto"：根据组件不同会转换为“yes”或者“no”。<br/>"yes"：当前组件可被无障碍辅助服务所识别。<br/>"no"：当前组件不可被无障碍辅助服务所识别。<br/>"no-hide-descendants"：当前组件及其所有子组件不可被无障碍辅助服务所识别。<br/>默认值："auto"<br/>**说明：**<br/>以下组件当accessibilityLevel设置成"auto"时，当前组件可被无障碍辅助服务所识别：Checkbox, CheckboxGroup, Gauge, Marquee, MenuItem, MenuItemGroup, Menu, Navigation, DatePicker, Progress, Radio, Rating, ScrollBar, Select, Slider, Stepper, Text, TextClock, TextPicker, TextTimer, TimePicker, Toggle, Web. | 144 145## accessibilityVirtualNode<sup>11+</sup> 146 147accessibilityVirtualNode(builder: CustomBuilder) 148 149无障碍虚拟节点。 150 151**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。 152 153**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 154 155**系统能力：** SystemCapability.ArkUI.ArkUI.Full 156 157**参数：** 158 159| 参数名 | 类型 | 必填 | 说明 | 160| ------ | ------ | ---- | ------------------------------------------------------------ | 161| builder | [CustomBuilder](ts-types.md#custombuilder8) | 是 | 无障碍虚拟子节点，使开发者可以对自绘制组件传入一个自定义的CustomBuilder，该CustomBuilder中的组件在后端仅做布局不做显示，辅助应用获取无障碍节点信息时会返回CustomBuilder中的节点信息。 | 162 163## accessibilityChecked<sup>13+</sup> 164 165accessibilityChecked(isCheck: boolean) 166 167无障碍节点是否选中的状态维护，用于支持多选的情况使用。 168 169**卡片能力：** 从API version 13开始，该接口支持在ArkTS卡片中使用。 170 171**原子化服务API：** 从API version 13开始，该接口支持在原子化服务中使用。 172 173**系统能力：** SystemCapability.ArkUI.ArkUI.Full 174 175**参数：** 176 177| 参数名 | 类型 | 必填 | 说明 | 178| ------- | ------- | ---- | ------------------------------------------------------------ | 179| isCheck | boolean | 是 | 用于表示组件是否被选中。<br/>支持的值为:<br/>true:当前组件被选中。<br/>false:当前组件未被选中。<br/>undefined:由组件自行确定选中状态。<br/>默认值:undefined。<br/>**说明：**<br/>1. 使用该接口设置true或false后，会默认修改该组件的checkable属性为true。<br/>2. 使用该接口设置true或false后，如果需要同时使用accessibilitySelected接口则需要将accessibilitySelected接口的参数设置为undefined。 | 180 181## accessibilitySelected<sup>13+</sup> 182 183accessibilitySelected(isSelect: boolean) 184 185无障碍节点是否选中的状态维护，用于支持单选的情况使用。 186 187**卡片能力：** 从API version 13开始，该接口支持在ArkTS卡片中使用。 188 189**原子化服务API：** 从API version 13开始，该接口支持在原子化服务中使用。 190 191**系统能力：** SystemCapability.ArkUI.ArkUI.Full 192 193**参数：** 194 195| 参数名 | 类型 | 必填 | 说明 | 196| -------- | ------- | ---- | ------------------------------------------------------------ | 197| isSelect | boolean | 是 | 用于表示组件是否被选中。<br/>支持的值为:<br/>true:当前组件被选中。<br/>false:当前组件未被选中。<br/>undefined:由组件自行确定选中状态。<br/>默认值:undefined。<br/>**说明：**<br/>1. 使用该接口设置true或false后，如果需要同时使用accessibilityChecked接口则需要将accessibilityChecked接口的参数设置为undefined。 | 198 199 200 201## 示例1（设置无障碍文本和无障碍说明） 202 203该示例主要演示accessibilityText无障碍文本和accessibilityDescription无障碍说明的播报内容。 204 205``` 206// xxx.ets 207@Entry 208@Component 209struct Index { 210 211 @Builder customAccessibilityNode() { 212 Column() { 213 Text(`virtual node`) 214 } 215 .width(10) 216 .height(10) 217 } 218 219 build() { 220 Row() { 221 Column() { 222 Text("文本1") 223 .fontSize(50) 224 .fontWeight(FontWeight.Bold) 225 Text("文本2") 226 .fontSize(50) 227 .fontWeight(FontWeight.Bold) 228 } 229 .width('100%') 230 .accessibilityGroup(true) 231 .accessibilityLevel("yes") 232 .accessibilityText("分组") // 无障碍文本的内容，若组件既拥有文本属性又拥有无障碍文本属性，则组件被选中时，仅播报无障碍文本内容。 233 .accessibilityDescription("Column组件可以被选中，播报的内容是“分组”") 234 .accessibilityVirtualNode(this.customAccessibilityNode) 235 .accessibilityChecked(true) 236 .accessibilitySelected(undefined) 237 } 238 .height('100%') 239 } 240} 241``` 242 243## 示例2（设置无障碍组） 244 245该示例主要演示优先使用子组件的无障碍文本进行朗读。 246 247``` 248// xxx.ets 249@Entry 250@Component 251struct Focus { 252 build() { 253 Column({ space: 10 }) { 254 Text('123456') 255 .focusable(true) 256 .borderRadius(5) 257 .accessibilityText("有accessibility有text优先读accessibility") 258 .accessibilityLevel("yes") 259 Button().accessibilityLevel("yes").accessibilityText("accessibility无text 读accessibility") 260 Button("无accessibility有text 读text").accessibilityLevel("yes") 261 Button() 262 Button('btnl23').accessibilityText("有accessibility有text btn123").accessibilityLevel("yes") 263 Button('btn123').accessibilityLevel("yes") 264 } 265 .accessibilityGroup(true, { accessibilityPreferred: true }) 266 //.accessibilityGroup(true) 267 .borderWidth(5) 268 .width('100%') 269 .height('100%') 270 } 271} 272``` 273 274## 275