AccessibilityInfo

有时，了解设备当前是否启用了屏幕阅读器会很有用。AccessibilityInfo API 就是为此而设计的。你可以用它来查询屏幕阅读器的当前状态，也可以注册监听，以便在屏幕阅读器状态发生变化时收到通知。

示例

---

参考

方法

addEventListener()

React TSX

static addEventListener(
  eventName: AccessibilityChangeEventName | AccessibilityAnnouncementEventName,
  handler: (
    event: AccessibilityChangeEvent | AccessibilityAnnouncementFinishedEvent,
  ) => void,
): EmitterSubscription;

添加事件处理器。支持的事件：

事件名称	描述
accessibilityServiceChanged Android	当某些服务（例如 TalkBack、其他 Android 辅助技术以及第三方无障碍服务）启用时触发。传递给事件处理器的参数是一个布尔值。当某些无障碍服务已启用时，该布尔值为 true，否则为 false。
announcementFinished iOS	当屏幕阅读器完成播报时触发。传递给事件处理器的参数是一个包含以下键的字典： announcement：屏幕阅读器播报的字符串。 success：一个布尔值，表示播报是否成功完成。
boldTextChanged iOS	当粗体文本开关状态变化时触发。传递给事件处理器的参数是一个布尔值。当粗体文本已启用时，该布尔值为 true，否则为 false。
grayscaleChanged iOS	当灰度开关状态变化时触发。传递给事件处理器的参数是一个布尔值。当灰度已启用时，该布尔值为 true，否则为 false。
invertColorsChanged iOS	当反转颜色开关状态变化时触发。传递给事件处理器的参数是一个布尔值。当反转颜色已启用时，该布尔值为 true，否则为 false。
reduceMotionChanged	当减少动态效果开关状态变化时触发。传递给事件处理器的参数是一个布尔值。当减少动态效果已启用（或“开发者选项”中的“过渡动画缩放”设置为“动画关闭”）时，该布尔值为 true，否则为 false。
reduceTransparencyChanged iOS	当减少透明度开关状态变化时触发。传递给事件处理器的参数是一个布尔值。当减少透明度已启用时，该布尔值为 true，否则为 false。
screenReaderChanged	当屏幕阅读器状态变化时触发。传递给事件处理器的参数是一个布尔值。当屏幕阅读器已启用时，该布尔值为 true，否则为 false。

---

announceForAccessibility()

React TSX

static announceForAccessibility(announcement: string);

发布一段字符串，让屏幕阅读器朗读。

---

announceForAccessibilityWithOptions()

React TSX

static announceForAccessibilityWithOptions(
  announcement: string,
  options: {queue?: boolean},
);

发布一段字符串，让屏幕阅读器朗读，并可附带修改选项。默认情况下，播报会打断任何现有语音；但在 iOS 上，可以通过在选项对象中将 queue 设为 true，让播报排在现有语音之后。

参数：

名称	类型	描述
announcement Required	string	要播报的字符串
options Required	object	queue - 将播报排在现有语音之后 iOS

---

getRecommendedTimeoutMillis()

Android

React TSX

static getRecommendedTimeoutMillis(originalTimeout: number): Promise<number>;

获取用户所需的超时时间（毫秒）。 该值设置在“辅助功能”设置中的“执行操作前的时间（辅助功能超时）”里。

参数：

名称	类型	描述
originalTimeout Required	number	如果未设置“辅助功能超时”，则返回的超时时间。请以毫秒为单位指定。

---

isAccessibilityServiceEnabled()

Android

React TSX

static isAccessibilityServiceEnabled(): Promise<boolean>;

检查是否启用了任何辅助功能服务。这包括 TalkBack，也包括可能已安装的任何第三方辅助功能应用。若只想检查 TalkBack 是否启用，请使用 isScreenReaderEnabled。返回一个会解析为布尔值的 promise。当某些辅助功能服务已启用时，结果为 true，否则为 false。

注意：如果你只想检查 TalkBack 的状态，请使用 isScreenReaderEnabled。

---

isBoldTextEnabled()

iOS

React TSX

static isBoldTextEnabled(): Promise<boolean>:

查询当前是否启用了粗体文本。返回一个会解析为布尔值的 promise。当粗体文本已启用时，结果为 true，否则为 false。

---

isGrayscaleEnabled()

iOS

React TSX

static isGrayscaleEnabled(): Promise<boolean>;

查询当前是否启用了灰度。返回一个会解析为布尔值的 promise。当灰度已启用时，结果为 true，否则为 false。

---

isInvertColorsEnabled()

iOS

React TSX

static isInvertColorsEnabled(): Promise<boolean>;

查询当前是否启用了反转颜色。返回一个会解析为布尔值的 promise。当反转颜色已启用时，结果为 true，否则为 false。

---

isReduceMotionEnabled()

React TSX

static isReduceMotionEnabled(): Promise<boolean>;

查询当前是否启用了减少动态效果。返回一个会解析为布尔值的 promise。当减少动态效果已启用时，结果为 true，否则为 false。

---

isReduceTransparencyEnabled()

iOS

React TSX

static isReduceTransparencyEnabled(): Promise<boolean>;

查询当前是否启用了减少透明度。返回一个会解析为布尔值的 promise。当减少透明度已启用时，结果为 true，否则为 false。

---

isScreenReaderEnabled()

React TSX

static isScreenReaderEnabled(): Promise<boolean>;

查询当前是否启用了屏幕阅读器。返回一个会解析为布尔值的 promise。当屏幕阅读器已启用时，结果为 true，否则为 false。

---

isHighTextContrastEnabled()

Android

React TSX

static isHighTextContrastEnabled(): Promise<boolean>

查询当前是否启用了高文本对比度。返回一个会解析为布尔值的 promise。当高文本对比度已启用时，结果为 true，否则为 false。

---

isDarkerSystemColorsEnabled()

iOS

React TSX

static isDarkerSystemColorsEnabled(): Promise<boolean>

查询当前是否启用了更深的系统颜色。返回一个会解析为布尔值的 promise。当更深的系统颜色已启用时，结果为 true，否则为 false。

---

prefersCrossFadeTransitions()

iOS

React TSX

static prefersCrossFadeTransitions(): Promise<boolean>;

查询当前是否同时启用了减少动态效果和偏好交叉淡入淡出过渡设置。返回一个会解析为布尔值的 promise。当启用了偏好交叉淡入淡出过渡时，结果为 true，否则为 false。

---

setAccessibilityFocus()

Deprecated

建议改为使用带有 focus 事件类型的 sendAccessibilityEvent。

React TSX

static setAccessibilityFocus(reactTag: number);

将辅助功能焦点设置到某个 React 组件。

在 Android 上，这会使用传入的 reactTag 和 UIManager.AccessibilityEventTypes.typeViewFocused 参数调用 UIManager.sendAccessibilityEvent 方法。

备注

请确保任何你希望接收辅助功能焦点的 View 都设置了 accessible={true}。

---

sendAccessibilityEvent()

React TSX

static sendAccessibilityEvent(host: HostInstance, eventType: AccessibilityEventTypes);

以命令式方式在某个 React 组件上触发辅助功能事件，例如更改屏幕阅读器当前聚焦的元素。

备注

请确保任何你希望接收辅助功能焦点的 View 都设置了 accessible={true}。

名称	类型	描述
host Required	HostInstance	用于发送事件的组件引用。
eventType Required	AccessibilityEventTypes	'click'（仅 Android）、'focus'、'viewHoverEnter'（仅 Android）或 'windowStateChange'（仅 Android）之一