-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[0.72] Add support for announceForAccessibilityWithOptions (#12255)
* [Win32] Add support for announceForAccessibilityWithOptions (#12237) * initial commit * add NativeAccessibilityInfoWin32.js * update example * Change files * add override and .d.ts file * add another override * add comma * extend options type instead of redefine * try [prop-missing] to fix lint error * fix comment in RNTesterList.win32 * try ignoring AccessibilityInfo.js in .flowconfig * Revert flowconfig version * Lint script runs succesfully locally --------- Co-authored-by: Krystal Kramer <krsiler@microsoft.com> * Change beachball change type --------- Co-authored-by: Krystal Kramer <krsiler@microsoft.com>
- Loading branch information
1 parent
7cb5464
commit 8b51781
Showing
8 changed files
with
291 additions
and
14 deletions.
There are no files selected for viewing
7 changes: 7 additions & 0 deletions
7
change/@office-iss-react-native-win32-22bcae82-8c54-41e1-88f1-6aeb9deafbe3.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "type": "patch", | ||
| "comment": "add support for announceForAccessibilityWithOptions", | ||
| "packageName": "@office-iss/react-native-win32", | ||
| "email": "krsiler@microsoft.com", | ||
| "dependentChangeType": "patch" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
161 changes: 161 additions & 0 deletions
161
...-iss/react-native-win32/src/Libraries/Components/AccessibilityInfo/AccessibilityInfo.d.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| /** | ||
| * Copyright (c) Meta Platforms, Inc. and affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| * | ||
| * @format | ||
| */ | ||
|
|
||
| import type * as React from 'react'; | ||
| import {HostComponent} from '../../../types/public/ReactNativeTypes'; | ||
| import {EmitterSubscription} from '../../vendor/emitter/EventEmitter'; | ||
|
|
||
| type AccessibilityChangeEventName = | ||
| | 'change' // deprecated, maps to screenReaderChanged | ||
| | 'boldTextChanged' // iOS-only Event | ||
| | 'grayscaleChanged' // iOS-only Event | ||
| | 'invertColorsChanged' // iOS-only Event | ||
| | 'reduceMotionChanged' | ||
| | 'screenReaderChanged' | ||
| | 'reduceTransparencyChanged'; // iOS-only Event | ||
|
|
||
| type AccessibilityChangeEvent = boolean; | ||
|
|
||
| type AccessibilityChangeEventHandler = ( | ||
| event: AccessibilityChangeEvent, | ||
| ) => void; | ||
|
|
||
| type AccessibilityAnnouncementEventName = 'announcementFinished'; // iOS-only Event | ||
|
|
||
| type AccessibilityAnnouncementFinishedEvent = { | ||
| announcement: string; | ||
| success: boolean; | ||
| }; | ||
|
|
||
| type AccessibilityAnnouncementFinishedEventHandler = ( | ||
| event: AccessibilityAnnouncementFinishedEvent, | ||
| ) => void; | ||
|
|
||
| type AccessibilityEventTypes = 'click' | 'focus' | 'viewHoverEnter'; | ||
|
|
||
| /** | ||
| * @see https://reactnative.dev/docs/accessibilityinfo | ||
| */ | ||
| export interface AccessibilityInfoStatic { | ||
| /** | ||
| * Query whether bold text is currently enabled. | ||
| * | ||
| * @platform ios | ||
| */ | ||
| isBoldTextEnabled: () => Promise<boolean>; | ||
|
|
||
| /** | ||
| * Query whether grayscale is currently enabled. | ||
| * | ||
| * @platform ios | ||
| */ | ||
| isGrayscaleEnabled: () => Promise<boolean>; | ||
|
|
||
| /** | ||
| * Query whether invert colors is currently enabled. | ||
| * | ||
| * @platform ios | ||
| */ | ||
| isInvertColorsEnabled: () => Promise<boolean>; | ||
|
|
||
| /** | ||
| * Query whether reduce motion is currently enabled. | ||
| */ | ||
| isReduceMotionEnabled: () => Promise<boolean>; | ||
|
|
||
| /** | ||
| * Query whether reduce motion and prefer cross-fade transitions settings are currently enabled. | ||
| * | ||
| * Returns a promise which resolves to a boolean. | ||
| * The result is `true` when prefer cross-fade transitions is enabled and `false` otherwise. | ||
| */ | ||
| prefersCrossFadeTransitions(): Promise<boolean>; | ||
|
|
||
| /** | ||
| * Query whether reduce transparency is currently enabled. | ||
| * | ||
| * @platform ios | ||
| */ | ||
| isReduceTransparencyEnabled: () => Promise<boolean>; | ||
|
|
||
| /** | ||
| * Query whether a screen reader is currently enabled. | ||
| */ | ||
| isScreenReaderEnabled: () => Promise<boolean>; | ||
|
|
||
| /** | ||
| * Query whether Accessibility Service is currently enabled. | ||
| * | ||
| * Returns a promise which resolves to a boolean. | ||
| * The result is `true` when any service is enabled and `false` otherwise. | ||
| * | ||
| * @platform android | ||
| */ | ||
| isAccessibilityServiceEnabled(): Promise<boolean>; | ||
|
|
||
| /** | ||
| * Add an event handler. Supported events: | ||
| * - announcementFinished: iOS-only event. Fires when the screen reader has finished making an announcement. | ||
| * The argument to the event handler is a dictionary with these keys: | ||
| * - announcement: The string announced by the screen reader. | ||
| * - success: A boolean indicating whether the announcement was successfully made. | ||
| * - AccessibilityEventName constants other than announcementFinished: Fires on accessibility feature change. | ||
| * The argument to the event handler is a boolean. | ||
| * The boolean is true when the related event's feature is enabled and false otherwise. | ||
| * | ||
| */ | ||
| addEventListener( | ||
| eventName: AccessibilityChangeEventName, | ||
| handler: AccessibilityChangeEventHandler, | ||
| ): EmitterSubscription; | ||
| addEventListener( | ||
| eventName: AccessibilityAnnouncementEventName, | ||
| handler: AccessibilityAnnouncementFinishedEventHandler, | ||
| ): EmitterSubscription; | ||
|
|
||
| /** | ||
| * Set accessibility focus to a react component. | ||
| */ | ||
| setAccessibilityFocus: (reactTag: number) => void; | ||
|
|
||
| /** | ||
| * Post a string to be announced by the screen reader. | ||
| */ | ||
| announceForAccessibility: (announcement: string) => void; | ||
|
|
||
| /** | ||
| * Post a string to be announced by the screen reader. | ||
| * - `announcement`: The string announced by the screen reader. | ||
| * - `options`: An object that configures the reading options. | ||
| * - `queue`: The announcement will be queued behind existing announcements. iOS only. | ||
| * - `nativeID`: The nativeID of the element to send the announcement from. win32 only. | ||
| */ | ||
| announceForAccessibilityWithOptions( | ||
| announcement: string, | ||
| options: { | ||
| queue?: boolean | undefined; | ||
| nativeID?: string | undefined; // win32 | ||
| }, | ||
| ): void; | ||
|
|
||
| /** | ||
| * Gets the timeout in millisecond that the user needs. | ||
| * This value is set in "Time to take action (Accessibility timeout)" of "Accessibility" settings. | ||
| * | ||
| * @platform android | ||
| */ | ||
| getRecommendedTimeoutMillis: (originalTimeout: number) => Promise<number>; | ||
| sendAccessibilityEvent: ( | ||
| handle: React.ElementRef<HostComponent<unknown>>, | ||
| eventType: AccessibilityEventTypes, | ||
| ) => void; | ||
| } | ||
|
|
||
| export const AccessibilityInfo: AccessibilityInfoStatic; | ||
| export type AccessibilityInfo = AccessibilityInfoStatic; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.