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 来将其排队在现有语音之后。

参数

姓名	类型	描述
公告 必需	字符串	要播报的字符串
选项 必需	对象	queue - 将播报排队在现有语音之后 iOS

---

getRecommendedTimeoutMillis()

Android

tsx

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

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

参数

姓名	类型	描述
originalTimeout 必需	数字	如果未设置“辅助功能超时”，则返回的超时时间。以毫秒为单位。

---

isAccessibilityServiceEnabled()

Android

tsx

static isAccessibilityServiceEnabled(): Promise<boolean>;

检查是否启用了任何辅助功能服务。这包括 TalkBack 以及可能安装的任何第三方辅助功能应用。要仅检查 TalkBack 是否启用，请使用 isScreenReaderEnabled。返回一个 Promise，该 Promise 解析为布尔值。当启用某些辅助功能服务时，结果为 true，否则为 false。

注意

如果您只想检查 TalkBack 的状态，请使用 isScreenReaderEnabled。

---

isBoldTextEnabled()

iOS

tsx

static isBoldTextEnabled(): Promise<boolean>:

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

---

isGrayscaleEnabled()

iOS

tsx

static isGrayscaleEnabled(): Promise<boolean>;

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

---

isInvertColorsEnabled()

iOS

tsx

static isInvertColorsEnabled(): Promise<boolean>;

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

---

isReduceMotionEnabled()

tsx

static isReduceMotionEnabled(): Promise<boolean>;

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

---

isReduceTransparencyEnabled()

iOS

tsx

static isReduceTransparencyEnabled(): Promise<boolean>;

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

---

isScreenReaderEnabled()

tsx

static isScreenReaderEnabled(): Promise<boolean>;

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

---

prefersCrossFadeTransitions()

iOS

tsx

static prefersCrossFadeTransitions(): Promise<boolean>;

查询当前是否启用了减弱动画和偏好交叉淡入淡出过渡设置。启用偏好交叉淡入淡出过渡时，结果为 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）。