|
| 1 | +/** |
| 2 | + * Copyright (c) Meta Platforms, Inc. and affiliates. |
| 3 | + * |
| 4 | + * This source code is licensed under the MIT license found in the |
| 5 | + * LICENSE file in the root directory of this source tree. |
| 6 | + * |
| 7 | + * @flow strict-local |
| 8 | + * @format |
| 9 | + */ |
| 10 | + |
| 11 | +import type {HostComponent} from '../../Renderer/shims/ReactNativeTypes'; |
| 12 | +import type {EventSubscription} from '../../vendor/emitter/EventEmitter'; |
| 13 | +import type {ElementRef} from 'react'; |
| 14 | + |
| 15 | +// Events that are only supported on Android. |
| 16 | +type AccessibilityEventDefinitionsAndroid = { |
| 17 | + accessibilityServiceChanged: [boolean], |
| 18 | +}; |
| 19 | + |
| 20 | +// Events that are only supported on iOS. |
| 21 | +type AccessibilityEventDefinitionsIOS = { |
| 22 | + announcementFinished: [{announcement: string, success: boolean}], |
| 23 | + boldTextChanged: [boolean], |
| 24 | + grayscaleChanged: [boolean], |
| 25 | + invertColorsChanged: [boolean], |
| 26 | + reduceTransparencyChanged: [boolean], |
| 27 | +}; |
| 28 | + |
| 29 | +type AccessibilityEventDefinitions = { |
| 30 | + ...AccessibilityEventDefinitionsAndroid, |
| 31 | + ...AccessibilityEventDefinitionsIOS, |
| 32 | + change: [boolean], // screenReaderChanged |
| 33 | + reduceMotionChanged: [boolean], |
| 34 | + screenReaderChanged: [boolean], |
| 35 | +}; |
| 36 | + |
| 37 | +type AccessibilityEventTypes = 'click' | 'focus'; |
| 38 | +/** |
| 39 | + * Sometimes it's useful to know whether or not the device has a screen reader |
| 40 | + * that is currently active. The `AccessibilityInfo` API is designed for this |
| 41 | + * purpose. You can use it to query the current state of the screen reader as |
| 42 | + * well as to register to be notified when the state of the screen reader |
| 43 | + * changes. |
| 44 | + * |
| 45 | + * See https://reactnative.dev/docs/accessibilityinfo |
| 46 | + */ |
| 47 | +export type AccessibilityInfoType = { |
| 48 | + /** |
| 49 | + * Query whether bold text is currently enabled. |
| 50 | + * |
| 51 | + * Returns a promise which resolves to a boolean. |
| 52 | + * The result is `true` when bold text is enabled and `false` otherwise. |
| 53 | + * |
| 54 | + * See https://reactnative.dev/docs/accessibilityinfo#isBoldTextEnabled |
| 55 | + */ |
| 56 | + isBoldTextEnabled: () => Promise<boolean>, |
| 57 | + |
| 58 | + /** |
| 59 | + * Query whether grayscale is currently enabled. |
| 60 | + * |
| 61 | + * Returns a promise which resolves to a boolean. |
| 62 | + * The result is `true` when grayscale is enabled and `false` otherwise. |
| 63 | + * |
| 64 | + * See https://reactnative.dev/docs/accessibilityinfo#isGrayscaleEnabled |
| 65 | + */ |
| 66 | + isGrayscaleEnabled: () => Promise<boolean>, |
| 67 | + |
| 68 | + /** |
| 69 | + * Query whether inverted colors are currently enabled. |
| 70 | + * |
| 71 | + * Returns a promise which resolves to a boolean. |
| 72 | + * The result is `true` when invert color is enabled and `false` otherwise. |
| 73 | + * |
| 74 | + * See https://reactnative.dev/docs/accessibilityinfo#isInvertColorsEnabled |
| 75 | + */ |
| 76 | + isInvertColorsEnabled: () => Promise<boolean>, |
| 77 | + |
| 78 | + /** |
| 79 | + * Query whether reduced motion is currently enabled. |
| 80 | + * |
| 81 | + * Returns a promise which resolves to a boolean. |
| 82 | + * The result is `true` when a reduce motion is enabled and `false` otherwise. |
| 83 | + * |
| 84 | + * See https://reactnative.dev/docs/accessibilityinfo#isReduceMotionEnabled |
| 85 | + */ |
| 86 | + isReduceMotionEnabled: () => Promise<boolean>, |
| 87 | + |
| 88 | + /** |
| 89 | + * Query whether reduce motion and prefer cross-fade transitions settings are currently enabled. |
| 90 | + * |
| 91 | + * Returns a promise which resolves to a boolean. |
| 92 | + * The result is `true` when prefer cross-fade transitions is enabled and `false` otherwise. |
| 93 | + * |
| 94 | + * See https://reactnative.dev/docs/accessibilityinfo#prefersCrossFadeTransitions |
| 95 | + */ |
| 96 | + prefersCrossFadeTransitions: () => Promise<boolean>, |
| 97 | + |
| 98 | + /** |
| 99 | + * Query whether reduced transparency is currently enabled. |
| 100 | + * |
| 101 | + * Returns a promise which resolves to a boolean. |
| 102 | + * The result is `true` when a reduce transparency is enabled and `false` otherwise. |
| 103 | + * |
| 104 | + * See https://reactnative.dev/docs/accessibilityinfo#isReduceTransparencyEnabled |
| 105 | + */ |
| 106 | + isReduceTransparencyEnabled: () => Promise<boolean>, |
| 107 | + |
| 108 | + /** |
| 109 | + * Query whether a screen reader is currently enabled. |
| 110 | + * |
| 111 | + * Returns a promise which resolves to a boolean. |
| 112 | + * The result is `true` when a screen reader is enabled and `false` otherwise. |
| 113 | + * |
| 114 | + * See https://reactnative.dev/docs/accessibilityinfo#isScreenReaderEnabled |
| 115 | + */ |
| 116 | + isScreenReaderEnabled: () => Promise<boolean>, |
| 117 | + |
| 118 | + /** |
| 119 | + * Query whether Accessibility Service is currently enabled. |
| 120 | + * |
| 121 | + * Returns a promise which resolves to a boolean. |
| 122 | + * The result is `true` when any service is enabled and `false` otherwise. |
| 123 | + * |
| 124 | + * @platform android |
| 125 | + * |
| 126 | + * See https://reactnative.dev/docs/accessibilityinfo/#isaccessibilityserviceenabled-android |
| 127 | + */ |
| 128 | + isAccessibilityServiceEnabled: () => Promise<boolean>, |
| 129 | + |
| 130 | + /** |
| 131 | + * Add an event handler. Supported events: |
| 132 | + * |
| 133 | + * - `reduceMotionChanged`: Fires when the state of the reduce motion toggle changes. |
| 134 | + * The argument to the event handler is a boolean. The boolean is `true` when a reduce |
| 135 | + * motion is enabled (or when "Transition Animation Scale" in "Developer options" is |
| 136 | + * "Animation off") and `false` otherwise. |
| 137 | + * - `screenReaderChanged`: Fires when the state of the screen reader changes. The argument |
| 138 | + * to the event handler is a boolean. The boolean is `true` when a screen |
| 139 | + * reader is enabled and `false` otherwise. |
| 140 | + * |
| 141 | + * These events are only supported on iOS: |
| 142 | + * |
| 143 | + * - `boldTextChanged`: iOS-only event. Fires when the state of the bold text toggle changes. |
| 144 | + * The argument to the event handler is a boolean. The boolean is `true` when a bold text |
| 145 | + * is enabled and `false` otherwise. |
| 146 | + * - `grayscaleChanged`: iOS-only event. Fires when the state of the gray scale toggle changes. |
| 147 | + * The argument to the event handler is a boolean. The boolean is `true` when a gray scale |
| 148 | + * is enabled and `false` otherwise. |
| 149 | + * - `invertColorsChanged`: iOS-only event. Fires when the state of the invert colors toggle |
| 150 | + * changes. The argument to the event handler is a boolean. The boolean is `true` when a invert |
| 151 | + * colors is enabled and `false` otherwise. |
| 152 | + * - `reduceTransparencyChanged`: iOS-only event. Fires when the state of the reduce transparency |
| 153 | + * toggle changes. The argument to the event handler is a boolean. The boolean is `true` |
| 154 | + * when a reduce transparency is enabled and `false` otherwise. |
| 155 | + * - `announcementFinished`: iOS-only event. Fires when the screen reader has |
| 156 | + * finished making an announcement. The argument to the event handler is a |
| 157 | + * dictionary with these keys: |
| 158 | + * - `announcement`: The string announced by the screen reader. |
| 159 | + * - `success`: A boolean indicating whether the announcement was |
| 160 | + * successfully made. |
| 161 | + * |
| 162 | + * See https://reactnative.dev/docs/accessibilityinfo#addeventlistener |
| 163 | + */ |
| 164 | + addEventListener<K: $Keys<AccessibilityEventDefinitions>>( |
| 165 | + eventName: K, |
| 166 | + handler: (...$ElementType<AccessibilityEventDefinitions, K>) => void, |
| 167 | + ): EventSubscription, |
| 168 | + |
| 169 | + /** |
| 170 | + * Set accessibility focus to a React component. |
| 171 | + * |
| 172 | + * See https://reactnative.dev/docs/accessibilityinfo#setaccessibilityfocus |
| 173 | + */ |
| 174 | + setAccessibilityFocus: (reactTag: number) => void, |
| 175 | + |
| 176 | + /** |
| 177 | + * Send a named accessibility event to a HostComponent. |
| 178 | + */ |
| 179 | + sendAccessibilityEvent: ( |
| 180 | + handle: ElementRef<HostComponent<mixed>>, |
| 181 | + eventType: AccessibilityEventTypes, |
| 182 | + ) => void, |
| 183 | + |
| 184 | + /** |
| 185 | + * Post a string to be announced by the screen reader. |
| 186 | + * |
| 187 | + * See https://reactnative.dev/docs/accessibilityinfo#announceforaccessibility |
| 188 | + */ |
| 189 | + announceForAccessibility: (announcement: string) => void, |
| 190 | + |
| 191 | + /** |
| 192 | + * Post a string to be announced by the screen reader. |
| 193 | + * - `announcement`: The string announced by the screen reader. |
| 194 | + * - `options`: An object that configures the reading options. |
| 195 | + * - `queue`: The announcement will be queued behind existing announcements. iOS only. |
| 196 | + */ |
| 197 | + announceForAccessibilityWithOptions: ( |
| 198 | + announcement: string, |
| 199 | + options: {queue?: boolean}, |
| 200 | + ) => void, |
| 201 | + |
| 202 | + /** |
| 203 | + * Get the recommended timeout for changes to the UI needed by this user. |
| 204 | + * |
| 205 | + * See https://reactnative.dev/docs/accessibilityinfo#getrecommendedtimeoutmillis |
| 206 | + */ |
| 207 | + getRecommendedTimeoutMillis: (originalTimeout: number) => Promise<number>, |
| 208 | +}; |
0 commit comments