mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Nick Gerleman
7858a2147f
Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/36345 `exactOptionalPropertyTypes` is a TypeScript 4.4+ option set by users which changes behavior of optional properties, to disable accepting explicit `undefined`. This is not enabled when using `--strict`, and is stricter than Flow, leading to most of the typings having an `| undefined` unique to TypeScript (added with https://github.com/DefinitelyTyped/DefinitelyTyped/commit/694c663a9486dbe7794d5eb894a691ee9ded318a). We have not always followed this (I have myself previously assumed the two are equivalent). We can enforce that the convention is followed with a plugin `eslint-plugin-redundant-undefined`. This forces us to declare that every optional property accepts an explicit undefined (which Flow would allow). Alternatively, if we do not want to support this, we can enable the existing dtslint rule `no-redundant-undefined`. Changelog: [General][Fixed] - Enforce compatibility with `exactOptionalPropertyTypes` Reviewed By: lunaleaps Differential Revision: D43700862 fbshipit-source-id: 996094762b28918177521a9471d868ba87f0f263
92 lines
2.5 KiB
TypeScript
92 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 | undefined;
|
|
style?: 'default' | 'cancel' | 'destructive' | undefined;
|
|
}
|
|
|
|
interface AlertOptions {
|
|
/** @platform android */
|
|
cancelable?: boolean | undefined;
|
|
userInterfaceStyle?: 'unspecified' | 'light' | 'dark' | undefined;
|
|
/** @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. On iOS, you can show an alert that prompts the user to enter
|
|
* some information.
|
|
*
|
|
* ## 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,
|
|
options?: AlertOptions,
|
|
) => void;
|
|
}
|
|
|
|
export type AlertType =
|
|
| 'default'
|
|
| 'plain-text'
|
|
| 'secure-text'
|
|
| 'login-password';
|
|
|
|
export const Alert: AlertStatic;
|
|
export type Alert = AlertStatic;
|