@capacitor/dialog

对话框 API 提供了用于触发原生对话框窗口以进行警报、确认和输入提示的方法

安装

npm install @capacitor/dialog
npx cap sync

示例

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

const showAlert = async () => {
  await Dialog.alert({
    title: 'Stop',
    message: 'this is an error',
  });
};

const showConfirm = async () => {
  const { value } = await Dialog.confirm({
    title: 'Confirm',
    message: `Are you sure you'd like to press the red button?`,
  });

  console.log('Confirmed:', value);
};

const showPrompt = async () => {
  const { value, cancelled } = await Dialog.prompt({
    title: 'Hello',
    message: `What's your name?`,
  });

  console.log('Name:', value);
  console.log('Cancelled:', cancelled);
};

API

• alert(...)
• prompt(...)
• confirm(...)
• 接口

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

属性	类型	描述	默认	自从
title	字符串	对话框标题。		1.0.0
message	字符串	要在对话框上显示的消息。		1.0.0
buttonTitle	字符串	在操作按钮上使用的文本。	"确定"	1.0.0

PromptResult

属性	类型	描述	自从
value	字符串	在提示中输入的文本。	1.0.0
cancelled	布尔值	提示是否被取消或接受。	1.0.0

PromptOptions

属性	类型	描述	默认	自从
title	字符串	对话框标题。		1.0.0
message	字符串	要在对话框上显示的消息。		1.0.0
okButtonTitle	字符串	在正操作按钮上使用的文本。	"确定"	1.0.0
cancelButtonTitle	字符串	在负操作按钮上使用的文本。	"取消"	1.0.0
inputPlaceholder	字符串	提示文本的占位符。		1.0.0
inputText	字符串	预先填充的文本。		1.0.0

ConfirmResult

属性	类型	描述	自从
value	布尔值	如果点击了正按钮则为 true，否则为 false。	1.0.0

ConfirmOptions

属性	类型	描述	默认	自从
title	字符串	对话框标题。		1.0.0
message	字符串	要在对话框上显示的消息。		1.0.0
okButtonTitle	字符串	在正操作按钮上使用的文本。	"确定"	1.0.0
cancelButtonTitle	字符串	在负操作按钮上使用的文本。	"取消"	1.0.0