无障碍属性

组件可以设置相应的无障碍属性和事件来更好地使用无障碍能力。

说明：

从API Version 10 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

属性

名称 参数类型 描述
accessibilityGroup boolean 无障碍组，设置为true时表示该组件及其所有子组件为一整个可以选中的组件，无障碍服务将不再关注其子组件内容。
默认值：false
accessibilityText string 无障碍文本，当组件不包含文本属性时，屏幕朗读选中此组件时不播报，使用者无法清楚地知道当前选中了什么组件。为了解决此场景，开发人员可为不包含文字信息的组件设置无障碍文本，当屏幕朗读选中此组件时播报无障碍文本的内容，帮助屏幕朗读的使用者清楚地知道自己选中了什么组件。
默认值：“”
说明：
若组件既拥有文本属性，又拥有无障碍文本属性，则组件被选中时，仅播报无障碍文本内容。
若组件设置了无障碍分组属性为true，但是即没有无障碍文本属性，也没有文本属性，会对其子节点的组件进行文本拼接（深度优先）。
accessibilityDescription string 无障碍说明，用于为用户进一步说明当前组件，开发人员可为组件的该属性设置相对较详细的解释文本，帮助用户理解将要执行的操作。如帮助用户理解将要执行的操作可能导致什么后果，尤其是当这些后果无法从组件本身属性与无障碍文本中了解到时。若组件既拥有文本属性又拥有无障碍说明属性，则组件被选中时，先播报组件的文本属性，再播报无障碍说明属性的内容。
默认值：“”
accessibilityLevel string 无障碍重要性，用于控制某个组件是否可被无障碍辅助服务所识别。
支持的值为:
"auto"：根据组件不同会转换为“yes”或者“no”。
"yes"：当前组件可被无障碍辅助服务所识别。
"no"：当前组件不可被无障碍辅助服务所识别。
"no-hide-descendants"：当前组件及其所有子组件不可被无障碍辅助服务所识别。
默认值："auto"
说明：
以下组件当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.

示例

// xxx.ets
@Entry
@Component
struct Index {

  build() {
    Row() {
      Column() {
        Text("文本1")
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
        Text("文本2")
          .fontSize(50)
          .fontWeight(FontWeight.Bold)
      }
      .width('100%')
      .accessibilityGroup(true)
      .accessibilityLevel("yes")
      .accessibilityText("分组")
      .accessibilityDescription("Column组件可以被选中，播报的内容是“分组”")
    }
    .height('100%')
  }
}