@capacitor/dialog

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	文字列	アクションボタンに使用するテキスト。	"OK"	1.0.0

PromptResult

プロパティ	型	説明	追加日時
value	文字列	プロンプトに入力されたテキスト。	1.0.0
cancelled	ブール値	プロンプトがキャンセルされたか、承認されたか。	1.0.0

PromptOptions

プロパティ	型	説明	デフォルト	追加日時
title	文字列	ダイアログのタイトル。		1.0.0
message	文字列	ダイアログに表示するメッセージ。		1.0.0
okButtonTitle	文字列	肯定的なアクションボタンに使用するテキスト。	"OK"	1.0.0
cancelButtonTitle	文字列	否定的アクションボタンに使用するテキスト。	"Cancel"	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	文字列	肯定的なアクションボタンに使用するテキスト。	"OK"	1.0.0
cancelButtonTitle	文字列	否定的アクションボタンに使用するテキスト。	"Cancel"	1.0.0