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
91 lines
2.5 KiB
TypeScript
91 lines
2.5 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
|
|
*/
|
|
|
|
/**
|
|
* @see https://reactnative.dev/docs/alert#content
|
|
*/
|
|
export interface AlertButton {
|
|
text?: string | undefined;
|
|
onPress?: ((value?: string) => void) | undefined;
|
|
isPreferred?: boolean;
|
|
style?: 'default' | 'cancel' | 'destructive' | undefined;
|
|
}
|
|
|
|
interface AlertOptions {
|
|
/** @platform android */
|
|
cancelable?: boolean | undefined;
|
|
userInterfaceStyle?: 'unspecified' | 'light' | 'dark';
|
|
/** @platform android */
|
|
onDismiss?: (() => void) | undefined;
|
|
}
|
|
|
|
/**
|
|
* Launches an alert dialog with the specified title and message.
|
|
*
|
|
* Optionally provide a list of buttons. Tapping any button will fire the
|
|
* respective onPress callback and dismiss the alert. By default, the only
|
|
* button will be an 'OK' button.
|
|
*
|
|
* This is an API that works both on iOS and Android and can show static
|
|
* alerts. To show an alert that prompts the user to enter some information,
|
|
* see `AlertIOS`; entering text in an alert is common on iOS only.
|
|
*
|
|
* ## iOS
|
|
*
|
|
* On iOS you can specify any number of buttons. Each button can optionally
|
|
* specify a style, which is one of 'default', 'cancel' or 'destructive'.
|
|
*
|
|
* ## Android
|
|
*
|
|
* On Android at most three buttons can be specified. Android has a concept
|
|
* of a neutral, negative and a positive button:
|
|
*
|
|
* - If you specify one button, it will be the 'positive' one (such as 'OK')
|
|
* - Two buttons mean 'negative', 'positive' (such as 'Cancel', 'OK')
|
|
* - Three buttons mean 'neutral', 'negative', 'positive' (such as 'Later', 'Cancel', 'OK')
|
|
*
|
|
* ```
|
|
* // Works on both iOS and Android
|
|
* Alert.alert(
|
|
* 'Alert Title',
|
|
* 'My Alert Msg',
|
|
* [
|
|
* {text: 'Ask me later', onPress: () => console.log('Ask me later pressed')},
|
|
* {text: 'Cancel', onPress: () => console.log('Cancel Pressed'), style: 'cancel'},
|
|
* {text: 'OK', onPress: () => console.log('OK Pressed')},
|
|
* ]
|
|
* )
|
|
* ```
|
|
*/
|
|
export interface AlertStatic {
|
|
alert: (
|
|
title: string,
|
|
message?: string,
|
|
buttons?: AlertButton[],
|
|
options?: AlertOptions,
|
|
) => void;
|
|
prompt: (
|
|
title: string,
|
|
message?: string,
|
|
callbackOrButtons?: ((text: string) => void) | AlertButton[],
|
|
type?: AlertType,
|
|
defaultValue?: string,
|
|
keyboardType?: string,
|
|
) => void;
|
|
}
|
|
|
|
export type AlertType =
|
|
| 'default'
|
|
| 'plain-text'
|
|
| 'secure-text'
|
|
| 'login-password';
|
|
|
|
export const Alert: AlertStatic;
|
|
export type Alert = AlertStatic;
|