AccessibilityInfo

有时候知道设备是否当前激活了屏幕阅读器是很有用的。AccessibilityInfo API 就是为此设计的。你可以使用它来查询屏幕阅读器的当前状态，以及注册监听器以便在屏幕阅读器状态变化时收到通知。

示例

---

参考

方法

addEventListener()

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()

tsx

static announceForAccessibility(announcement: string);

发布一个字符串供屏幕阅读器朗读。

---

announceForAccessibilityWithOptions()

tsx

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

发布一个字符串供屏幕阅读器朗读，带有修改选项。默认情况下，朗读会中断任何现有的语音，但在 iOS 上，可以通过在选项对象中将 queue 设置为 true 将其排队在现有语音之后。

参数：

名称	类型	描述
announcement 必需	string	要朗读的字符串
options 必需	object	queue - 将朗读排队在现有语音之后 iOS

---

getRecommendedTimeoutMillis()

Android

tsx

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

获取用户需要的超时时间（毫秒）。 此值在“无障碍”设置的“采取行动时间（无障碍超时）”中设置。

参数：

名称	类型	描述
originalTimeout 必需	number	如果未设置“无障碍超时”则返回的超时时间。以毫秒为单位指定。

---

isAccessibilityServiceEnabled()

Android

tsx

static isAccessibilityServiceEnabled(): Promise<boolean>;

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

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

---

isBoldTextEnabled()

iOS

tsx

static isBoldTextEnabled(): Promise<boolean>:

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

---

isGrayscaleEnabled()

iOS

tsx

static isGrayscaleEnabled(): Promise<boolean>;

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

---

isInvertColorsEnabled()

iOS

tsx

static isInvertColorsEnabled(): Promise<boolean>;

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

---

isReduceMotionEnabled()

tsx

static isReduceMotionEnabled(): Promise<boolean>;

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

---

isReduceTransparencyEnabled()

iOS

tsx

static isReduceTransparencyEnabled(): Promise<boolean>;

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

---

isScreenReaderEnabled()

tsx

static isScreenReaderEnabled(): Promise<boolean>;

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

---

isHighTextContrastEnabled()

Android

tsx

static isHighTextContrastEnabled(): Promise<boolean>

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

---

isDarkerSystemColorsEnabled()

iOS

tsx

static isDarkerSystemColorsEnabled(): Promise<boolean>

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

---

prefersCrossFadeTransitions()

iOS

tsx

static prefersCrossFadeTransitions(): Promise<boolean>;

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

---

setAccessibilityFocus()

已弃用

建议改用 sendAccessibilityEvent 并将 eventType 设为 focus。

tsx

static setAccessibilityFocus(reactTag: number);

将无障碍焦点设置到某个 React 组件。

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

备注

确保任何想要接收无障碍焦点的 View 都设置了 accessible={true}。

---

sendAccessibilityEvent()

tsx

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

命令式地在 React 组件上触发无障碍事件，例如更改屏幕阅读器的聚焦元素。

备注

确保任何想要接收无障碍焦点的 View 都设置了 accessible={true}。

名称	类型	描述
host 必需	HostInstance	要发送事件的组件 ref。
eventType 必需	AccessibilityEventTypes	'click'（仅 Android）、'focus'、'viewHoverEnter'（仅 Android）或 'windowStateChange'（仅 Android）之一