1# 无障碍属性 2 3组件可以设置相应的无障碍属性和事件来更好地使用无障碍能力。 4 5> **说明：** 6> 7> 从API Version 10 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9## accessibilityGroup 10 11accessibilityGroup(value: boolean) 12 13无障碍组。 14 15**系统能力：** SystemCapability.ArkUI.ArkUI.Full 16 17**参数：** 18 19| 参数名 | 类型 | 必填 | 说明 | 20| ------ | ------- | ---- | ------------------------------------------------------------ | 21| value | boolean | 是 | 无障碍组，设置为true时表示该组件及其所有子组件为一整个可以选中的组件，无障碍服务将不再关注其子组件内容。<br/>默认值：false | 22 23## accessibilityText 24 25accessibilityText(value: string) 26 27无障碍文本。 28 29**系统能力：** SystemCapability.ArkUI.ArkUI.Full 30 31**参数：** 32 33| 参数名 | 类型 | 必填 | 说明 | 34| ------ | ------ | ---- | ------------------------------------------------------------ | 35| value | string | 是 | 无障碍文本，当组件不包含文本属性时，屏幕朗读选中此组件时不播报，使用者无法清楚地知道当前选中了什么组件。为了解决此场景，开发人员可为不包含文字信息的组件设置无障碍文本，当屏幕朗读选中此组件时播报无障碍文本的内容，帮助屏幕朗读的使用者清楚地知道自己选中了什么组件。<br/>默认值：“”<br/>**说明：**<br/>若组件既拥有文本属性，又拥有无障碍文本属性，则组件被选中时，仅播报无障碍文本内容。<br/>若组件设置了无障碍分组属性为true，但是即没有无障碍文本属性，也没有文本属性，会对其子节点的组件进行文本拼接（深度优先）。 | 36 37## accessibilityDescription 38 39accessibilityDescription(value: string) 40 41无障碍说明。 42 43**系统能力：** SystemCapability.ArkUI.ArkUI.Full 44 45**参数：** 46 47| 参数名 | 类型 | 必填 | 说明 | 48| ------ | ------ | ---- | ------------------------------------------------------------ | 49| value | string | 是 | 无障碍说明，用于为用户进一步说明当前组件，开发人员可为组件的该属性设置相对较详细的解释文本，帮助用户理解将要执行的操作。如帮助用户理解将要执行的操作可能导致什么后果，尤其是当这些后果无法从组件本身属性与无障碍文本中了解到时。若组件既拥有文本属性又拥有无障碍说明属性，则组件被选中时，先播报组件的文本属性，再播报无障碍说明属性的内容。<br/>默认值：“” | 50 51## accessibilityLevel 52 53accessibilityLevel(value: string) 54 55无障碍重要性。 56 57**系统能力：** SystemCapability.ArkUI.ArkUI.Full 58 59**参数：** 60 61| 参数名 | 类型 | 必填 | 说明 | 62| ------ | ------ | ---- | ------------------------------------------------------------ | 63| 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. | 64 65## accessibilityVirtualNode<sup>11+</sup> 66 67accessibilityVirtualNode(builder: CustomBuilder) 68 69无障碍虚拟节点。 70 71**系统能力：** SystemCapability.ArkUI.ArkUI.Full 72 73**参数：** 74 75| 参数名 | 类型 | 必填 | 说明 | 76| ------ | ------ | ---- | ------------------------------------------------------------ | 77| builder | [CustomBuilder](ts-types.md#custombuilder8) | 是 | 无障碍虚拟子节点，使开发者可以对自绘制组件传入一个自定义的CustomBuilder，该CustomBuilder中的组件在后端仅做布局不做显示，辅助应用获取无障碍节点信息时会返回CustomBuilder中的节点信息。 | 78 79## 示例 80 81```ts 82// xxx.ets 83@Entry 84@Component 85struct Index { 86 87 @Builder customAccessibilityNode() { 88 Column() { 89 Text(`virtual node`) 90 } 91 .width(10) 92 .height(10) 93 } 94 95 build() { 96 Row() { 97 Column() { 98 Text("文本1") 99 .fontSize(50) 100 .fontWeight(FontWeight.Bold) 101 Text("文本2") 102 .fontSize(50) 103 .fontWeight(FontWeight.Bold) 104 } 105 .width('100%') 106 .accessibilityGroup(true) 107 .accessibilityLevel("yes") 108 .accessibilityText("分组") 109 .accessibilityDescription("Column组件可以被选中，播报的内容是“分组”") 110 .accessibilityVirtualNode(this.customAccessibilityNode) 111 } 112 .height('100%') 113 } 114} 115``` 116 117 118