Modals

Modals API 提供了触发原生模态窗口的方法，可用于显示警告、确认和输入提示对话框，以及操作菜单（Action Sheets）。

• alert(...)
• prompt(...)
• confirm(...)
• showActions(...)
• 接口
• 枚举

示例

import { Plugins, ActionSheetOptionStyle } from '@capacitor/core';

const { Modals } = Plugins;

async showAlert() {
  let alertRet = await Modals.alert({
    title: 'Stop',
    message: 'this is an error'
  });
}

async showConfirm() {
  let confirmRet = await Modals.confirm({
    title: 'Confirm',
    message: 'Are you sure you\'d like to press the red button?'
  });
  console.log('Confirm ret', confirmRet);
}

async showPrompt() {
  let promptRet = await Modals.prompt({
    title: 'Hello',
    message: 'What\'s your name?'
  });
  console.log('Prompt ret', promptRet);
}

async showActions() {
  let promptRet = await Modals.showActions({
    title: 'Photo Options',
    message: 'Select an option to perform',
    options: [
      {
        title: 'Upload'
      },
      {
        title: 'Share'
      },
      {
        title: 'Remove',
        style: ActionSheetOptionStyle.Destructive
      }
    ]
  })
  console.log('You selected', promptRet);
}

API

alert(...)

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

显示一个警告模态窗

参数	类型
options	AlertOptions

---

prompt(...)

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

显示一个提示输入模态窗

参数	类型
options	PromptOptions

返回值:

Promise<PromptResult>

---

confirm(...)

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

显示一个确认模态窗

参数	类型
options	ConfirmOptions

返回值:

Promise<ConfirmResult>

---

showActions(...)

showActions(options: ActionSheetOptions) => Promise<ActionSheetResult>

显示一个操作菜单（Action Sheet）样式的模态窗，为用户提供多个选项进行选择。

参数	类型
options	ActionSheetOptions

返回值:

Promise<ActionSheetResult>

---

接口

AlertOptions

属性	类型
title	string
message	string
buttonTitle	string

PromptResult

属性	类型
value	string
cancelled	boolean

PromptOptions

属性	类型
title	string
message	string
okButtonTitle	string
cancelButtonTitle	string
inputPlaceholder	string
inputText	string

ConfirmResult

属性	类型
value	boolean

ConfirmOptions

属性	类型
title	string
message	string
okButtonTitle	string
cancelButtonTitle	string

ActionSheetResult

属性	类型
index	number

ActionSheetOptions

属性	类型	描述
title	string
message	string	仅限 iOS
options	ActionSheetOption[]

ActionSheetOption

属性	类型	描述
title	string
style	ActionSheetOptionStyle
icon	string	Web 端图标（遵循 ionicon 命名规范）

枚举

ActionSheetOptionStyle

成员	值
Default	"DEFAULT"
Destructive	"DESTRUCTIVE"
Cancel	"CANCEL"