跳到主要内容
版本:v6

@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操作按钮文本"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,否则为 false1.0.0

ConfirmOptions

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