mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Nick Gerleman
8cdc9e7f04
Summary: React Native's TS definitions are currently mostly stored in one monolithic file. This change splits the definitions up to correspond to the source files they came from, and are placed next to the source files. I think this should help inform, and make it easy to update the TS declarations when touching the Flow file. I noticed as part of the change that the typings have not yet removed many APIs that were removed from RN. This is bad, since it means using the removed/non-functional API doesn't cause typechecker errors. Locating typings next to source should prevent that from being able to happen. The organization here means individual TS declarations can declare what will be in the RN entrypoint, which is a little confusing. Seems like a good potential next refactor, beyond the literal translation I did. Changelog: [General][Changed] - Place TS Declarations Alongside Source Files Reviewed By: lunaleaps, rshest Differential Revision: D39796598 fbshipit-source-id: b36366466fd1976bdd2d4c8f7a4104a33c457a07
129 lines
3.8 KiB
TypeScript
129 lines
3.8 KiB
TypeScript
/**
|
|
* 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 '../../Renderer/shims/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';
|
|
|
|
/**
|
|
* @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 transparency is currently enabled.
|
|
*
|
|
* @platform ios
|
|
*/
|
|
isReduceTransparencyEnabled: () => Promise<boolean>;
|
|
|
|
/**
|
|
* Query whether a screen reader is currently enabled.
|
|
*/
|
|
isScreenReaderEnabled: () => 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;
|
|
|
|
/**
|
|
* 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;
|