辅助功能信息

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

示例

---

参考

方法

addEventListener()

React TSX

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

添加事件处理程序。支持的事件：

事件名称	描述
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 必需	string	要播报的字符串
options 必需	object	queue - 将播报排在现有语音之后 iOS

---

getRecommendedTimeoutMillis()

Android

React TSX

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

获取用户所需的毫秒级超时时间。 该值在“无障碍”设置中的“执行操作所需时间（无障碍超时）”里设定。

参数：

名称	类型	描述
originalTimeout 必需	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 必需	HostInstance	要向其发送事件的组件 ref。
eventType 必需	AccessibilityEventTypes	'click'（仅 Android）、'focus'、'viewHoverEnter'（仅 Android）或 'windowStateChange'（仅 Android）之一