跳到主要内容
版本: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


Interfaces

AlertOptions

属性类型描述默认值
titlestring对话框标题1.0.0
messagestring对话框中显示的消息1.0.0
buttonTitlestring操作按钮显示的文本"确定"1.0.0

PromptResult

属性类型描述
valuestring输入框中输入的文本1.0.0
cancelledboolean标识提示框是被取消还是接受1.0.0

PromptOptions

属性类型描述默认值
titlestring对话框标题1.0.0
messagestring对话框中显示的消息1.0.0
okButtonTitlestring确认按钮显示的文本"确定"1.0.0
cancelButtonTitlestring取消按钮显示的文本"取消"1.0.0
inputPlaceholderstring输入框提示文本1.0.0
inputTextstring预填充文本1.0.0

ConfirmResult

属性类型描述
valueboolean如果点击了确认按钮则为 true,否则为 false1.0.0

ConfirmOptions

属性类型描述默认值
titlestring对话框标题1.0.0
messagestring对话框中显示的消息1.0.0
okButtonTitlestring确认按钮显示的文本"确定"1.0.0
cancelButtonTitlestring取消按钮显示的文本"取消"1.0.0