跳到主要内容
版本:v4

@capacitor/dialog

Dialog API 提供触发原生对话框窗口的方法,用于警告、确认和输入提示。

安装

npm install @capacitor/dialog
npx cap sync

示例

import { Dialog } from '@capacitor/dialog';

const showAlert = async () => {
await Dialog.alert({
title: '停止',
message: '这是一个错误',
});
};

const showConfirm = async () => {
const { value } = await Dialog.confirm({
title: '确认',
message: '您确定要按下红色按钮吗?',
});

console.log('已确认:', value);
};

const showPrompt = async () => {
const { value, cancelled } = await Dialog.prompt({
title: '你好',
message: '你叫什么名字?',
});

console.log('名字:', value);
console.log('已取消:', cancelled);
};

API

alert(...)

alert(options: AlertOptions) => Promise<void>

显示一个警告对话框。

参数类型
options
AlertOptions

自从: 1.0.0


prompt(...)

prompt(options: PromptOptions) => Promise<PromptResult>

显示一个输入提示对话框。

参数类型
options
PromptOptions

返回:

Promise<PromptResult>

自从: 1.0.0


confirm(...)

confirm(options: ConfirmOptions) => Promise<ConfirmResult>

显示一个确认对话框。

参数类型
options
ConfirmOptions

返回:

Promise<ConfirmResult>

自从: 1.0.0


接口

AlertOptions

属性类型描述默认值自从
titlestring对话框的标题。1.0.0
messagestring在对话框上显示的消息。1.0.0
buttonTitlestring操作按钮上使用的文本。"OK"1.0.0

PromptResult

属性类型描述自从
valuestring在提示框中输入的文本。1.0.0
cancelledboolean提示框是否被取消或接受。1.0.0

PromptOptions

属性类型描述默认值自从
titlestring对话框的标题。1.0.0
messagestring在对话框上显示的消息。1.0.0
okButtonTitlestring肯定操作按钮上使用的文本。"OK"1.0.0
cancelButtonTitlestring否定操作按钮上使用的文本。"Cancel"1.0.0
inputPlaceholderstring提示占位符文本。1.0.0
inputTextstring预填充的文本。1.0.0

ConfirmResult

属性类型描述自从
valueboolean如果点击了肯定按钮则为 true,否则为 false。1.0.0

ConfirmOptions

属性类型描述默认值自从
titlestring对话框的标题。1.0.0
messagestring在对话框上显示的消息。1.0.0
okButtonTitlestring肯定操作按钮上使用的文本。"OK"1.0.0
cancelButtonTitlestring否定操作按钮上使用的文本。"Cancel"1.0.0