跳过至主内容

AccessibilityInfo

有时，了解设备是否有当前处于活动状态的屏幕阅读器很有用。AccessibilityInfo API 就是为此目的而设计的。您可以使用它查询屏幕阅读器的当前状态，以及注册以在屏幕阅读器状态更改时接收通知。

示例​

参考

方法​

addEventListener()​

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

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

事件名称描述
accessibilityServiceChanged
安卓
当 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: options: {queue?: boolean},
);

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

参数

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

getRecommendedTimeoutMillis()
安卓
​

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

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

参数

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

isAccessibilityServiceEnabled()
安卓
​

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。

prefersCrossFadeTransitions()
iOS
​

tsx
static prefersCrossFadeTransitions(): Promise<boolean>;

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

setAccessibilityFocus()​

tsx
static setAccessibilityFocus(reactTag: number);

将辅助功能焦点设置为 React 组件。

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

注意：确保您希望接收辅助功能焦点的任何 View 都具有 accessible={true}。