Alert
启动具有指定标题和消息的警报对话框。
¥Launches an alert dialog with the specified title and message.
(可选)提供按钮列表。点击任何按钮都会触发相应的 onPress 回调并消除警报。默认情况下,唯一的按钮是 'OK' 按钮。
¥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.
这是一个适用于 Android 和 iOS 的 API,可以显示静态警报。提示用户输入某些信息的警报仅在 iOS 上可用。
¥This is an API that works both on Android and iOS and can show static alerts. Alert that prompts the user to enter some information is available on iOS only.
示例
¥Example
iOS
在 iOS 上,你可以指定任意数量的按钮。每个按钮都可以选择指定样式或强调,可用选项由 AlertButtonStyle 枚举和 AlertButton 上的 isPreferred
字段表示。
¥On iOS you can specify any number of buttons. Each button can optionally specify a style or be emphasized, available options are represented by the AlertButtonStyle enum and the isPreferred
field on AlertButton.
安卓
¥Android
在 Android 上最多可以指定三个按钮。Android 有中性按钮、消极按钮和积极按钮的概念:
¥On Android at most three buttons can be specified. Android has a concept of a neutral, negative and a positive button:
-
如果指定一个按钮,则为 'positive' 按钮(如 'OK')
¥If you specify one button, it will be the 'positive' one (such as 'OK')
-
两个按钮表示 'negative'、'positive'(如 '取消'、'OK')
¥Two buttons mean 'negative', 'positive' (such as 'Cancel', 'OK')
-
三个按钮分别表示 'neutral'、'negative'、'positive'(如 '之后'、'取消'、'OK')
¥Three buttons mean 'neutral', 'negative', 'positive' (such as 'Later', 'Cancel', 'OK')
Android 上的警报可以通过点击警报框外部来关闭。默认情况下禁用它,可以通过提供可选的 AlertOptions 参数并将可取消属性设置为 true
(即{cancelable: true}
)来启用它。
¥Alerts on Android can be dismissed by tapping outside of the alert box. It is disabled by default and can be enabled by providing an optional AlertOptions parameter with the cancelable property set to true
i.e.{cancelable: true}
.
可以通过在 options
参数内提供 onDismiss
回调属性来处理取消事件。
¥The cancel event can be handled by providing an onDismiss
callback property inside the options
parameter.
示例 Android
¥Example
参考
¥Reference
方法
¥Methods
alert()
static alert (
title: string,
message?: string,
buttons?: AlertButton[],
options?: AlertOptions,
);
参数:
¥Parameters:
名称 | 类型 | 描述 |
---|---|---|
标题 必填 | string | 对话框的标题。传递 null 或空字符串将隐藏标题。 |
message | string | 显示在对话框标题下方的可选消息。 |
buttons | AlertButton[] | 包含按钮配置的可选数组。 |
options | AlertOptions | 可选的警报配置。 |
prompt()
iOS
static prompt: (
title: string,
message?: string,
callbackOrButtons?: ((text: string) => void) | AlertButton[],
type?: AlertType,
defaultValue?: string,
keyboardType?: string,
);
创建并显示提示,以警报的形式输入一些文本。
¥Create and display a prompt to enter some text in form of Alert.
参数:
¥Parameters:
名称 | 类型 | 描述 |
---|---|---|
标题 必填 | string | 对话框的标题。 |
message | string | 显示在文本输入上方的可选消息。 |
callbackOrButtons | 函数 AlertButton[] | 如果传递一个函数,当用户点击 'OK' 时,将使用提示的值(text: string) => void 来调用该函数。如果传递一个数组,将根据数组内容配置按钮。 |
type | AlertType | 这将配置文本输入。 |
defaultValue | string | 文本输入中的默认文本。 |
keyboardType | string | 第一个文本字段的键盘类型(如果存在)。TextInput keyboardTypes 之一。 |
options | AlertOptions | 可选的警报配置。 |
类型定义
¥Type Definitions
AlertButtonStyle iOS
iOS 警报按钮样式。
¥An iOS Alert button style.
类型 |
---|
enum |
常量:
¥Constants:
值 | 描述 |
---|---|
'default' | 默认按钮样式。 |
'cancel' | 取消按钮样式。 |
'destructive' | 破坏性的按钮样式。 |
AlertType iOS
iOS 警报类型。
¥An iOS Alert type.
类型 |
---|
enum |
常量:
¥Constants:
值 | 描述 |
---|---|
'default' | 没有输入的默认警报 |
'plain-text' | 纯文本输入警报 |
'secure-text' | 安全文本输入警报 |
'login-password' | 登录名和密码提醒 |
AlertButton
描述警报中按钮配置的对象。
¥An object describing the configuration of a button in the alert.
类型 |
---|
对象数组 |
对象属性:
¥Objects properties:
名称 | 类型 | 描述 |
---|---|---|
text | string | 按钮标签。 |
onPress | function | 按钮按下时的回调函数。 |
样式 iOS | AlertButtonStyle | 按钮样式,在 Android 上此属性将被忽略。 |
isPreferred iOS | boolean | 是否强调按钮,在 Android 上该属性将被忽略。 |
AlertOptions
类型 |
---|
object |
属性:
¥Properties:
名称 | 类型 | 描述 |
---|---|---|
可取消 Android | boolean | 定义是否可以通过点击警报框外部来消除警报。 |
userInterfaceStyle iOS | string | 用于警报的界面样式,可以设置为 light 或 dark ,否则将使用默认的系统样式。 |
onDismiss Android | function | 当警报被解除时触发回调函数。 |