Alert
启动一个带有指定标题和消息的警告对话框。
可选地提供按钮列表。点击任何按钮将触发相应的 onPress 回调并关闭警告框。默认情况下,唯一的按钮将是 'OK' 按钮。
这是一个在 Android 和 iOS 上都可用的 API,可以显示静态警告框。提示用户输入某些信息的警告框仅在 iOS 上可用。
示例
iOS
在 iOS 上,你可以指定任意数量的按钮。每个按钮可以可选地指定样式或被强调,可用选项由 AlertButtonStyle 枚举和 AlertButton 上的 isPreferred 字段表示。
Android
在 Android 上,最多可以指定三个按钮。Android 有中性、负面和正面按钮的概念:
- 如果你指定一个按钮,它将是 'positive' 按钮(例如 'OK')
- 两个按钮意味着 'negative', 'positive'(例如 'Cancel', 'OK')
- 三个按钮意味着 'neutral', 'negative', 'positive'(例如 'Later', 'Cancel', 'OK')
Android 上的警告框可以通过点击警告框外部来关闭。默认情况下禁用,可以通过提供可选的 AlertOptions 参数并将 cancelable 属性设置为 true 来启用,即。{cancelable: true}。
可以通过在 options 参数中提供 onDismiss 回调属性来处理取消事件。
示例 Android
参考
方法
alert()
tsx
static alert (
title: string,
message?: string,
buttons?: AlertButton[],
options?: AlertOptions,
);
参数:
| 名称 | 类型 | 描述 |
|---|---|---|
| title 必需 | string | 对话框的标题。传递 null 或空字符串将隐藏标题。 |
| message | string | 出现在对话框标题下方的可选消息。 |
| buttons | AlertButton[] | 包含按钮配置的可选数组。 |
| options | AlertOptions | 可选的 Alert 配置。 |
prompt() iOS
tsx
static prompt: (
title: string,
message?: string,
callbackOrButtons?: ((text: string) => void) | AlertButton[],
type?: AlertType,
defaultValue?: string,
keyboardType?: string,
);
创建并显示一个提示框以输入一些文本,形式为 Alert。
参数:
| 名称 | 类型 | 描述 |
|---|---|---|
| title 必需 | string | 对话框的标题。 |
| message | string | 出现在文本输入框上方的可选消息。 |
| callbackOrButtons | function AlertButton[] | 如果传入函数,当用户点击 'OK' 时,它将使用提示框的值被调用(text: string) => void。如果传入数组,按钮将根据数组内容进行配置。 |
| type | AlertType | 这配置了文本输入框。 |
| defaultValue | string | 文本输入框中的默认文本。 |
| keyboardType | string | 第一个文本字段(如果存在)的键盘类型。TextInput keyboardTypes 之一。 |
| options | AlertOptions | 可选的 Alert 配置。 |
类型定义
AlertButtonStyle iOS
一个 iOS Alert 按钮样式。
| 类型 |
|---|
| enum |
常量:
| 值 | 描述 |
|---|---|
'default' | 默认按钮样式。 |
'cancel' | 取消按钮样式。 |
'destructive' | 破坏性按钮样式。 |
AlertType iOS
一个 iOS Alert 类型。
| 类型 |
|---|
| enum |
常量:
| 值 | 描述 |
|---|---|
'default' | 没有输入框的默认警告框 |
'plain-text' | 纯文本输入警告框 |
'secure-text' | 安全文本输入警告框 |
'login-password' | 登录和密码警告框 |
AlertButton
一个描述警告框中按钮配置的对象。
| 类型 |
|---|
| 对象数组 |
对象属性:
| 名称 | 类型 | 描述 |
|---|---|---|
| text | string | 按钮标签。 |
| onPress | function | 按钮被按下时的回调函数。 |
| style iOS | AlertButtonStyle | 按钮样式,在 Android 上此属性将被忽略。 |
| isPreferred iOS | boolean | 按钮是否应该被强调,在 Android 上此属性将被忽略。 |
AlertOptions
| 类型 |
|---|
| object |
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
| cancelable Android | boolean | 定义是否可以通过点击警告框外部来关闭警告框。 |
| userInterfaceStyle iOS | string | 用于警告框的界面样式,可以设置为 light 或 dark,否则将使用默认系统样式。 |
| onDismiss Android | function | 当警告框被关闭时触发的回调函数。 |