mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Saad Najmi
76bf71e2cc
Summary: `AlertIOS` was deprecated and removed long ago (https://github.com/facebook/react-native/commit/e2bd7db732602b2c477fe040f2946bd8293df297) but there continues to be a test page with the name `AlertIOS` in RN-Tester. `AlertIOSExample.js` contains valid examples of how to use `Alert.prompt()` so it's worth keeping them around. Let's move those into `AlertExample.js` and remove `AlertIOSExample.js`. While we're here, let's do some extra fixes to the test page: - Remove `showsIndividualExamples = true`. For whatever reason, I needed to remove this to show the examples properly... - Convert all uses of `<TouchableHighlight>` with `<Pressable>`. The latter replaces the former, so I thought that made sense.. Some extra context: In React Native macOS, we had forked `AlertIOS` into `AlertMacOS`, with a corresponding example page. This PR was made while working on removing those (https://github.com/microsoft/react-native-macos/pull/1548/). ## Changelog [INTERNAL] [CHANGED] - Moved `Alert.prompt` examples into common rn-tester test page Pull Request resolved: https://github.com/facebook/react-native/pull/35586 Test Plan: Test page shows up fine on iOS .  Reviewed By: lunaleaps Differential Revision: D41825889 Pulled By: NickGerleman fbshipit-source-id: 82e4405b1f3a1ccb558b5a5038a90416e7a32c29
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. 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,
|
|
) => void;
|
|
}
|
|
|
|
export type AlertType =
|
|
| 'default'
|
|
| 'plain-text'
|
|
| 'secure-text'
|
|
| 'login-password';
|
|
|
|
export const Alert: AlertStatic;
|
|
export type Alert = AlertStatic;
|