Alert

指定されたタイトルとメッセージでアラートダイアログを表示します。

ボタンのリストをオプションで指定できます。いずれかのボタンをタップすると、対応するonPressコールバックが実行され、アラートが閉じます。デフォルトでは、「OK」ボタンのみが表示されます。

これはAndroidとiOSの両方で動作するAPIであり、静的なアラートを表示できます。ユーザーに情報を入力させるプロンプトアラートはiOSのみで利用可能です。

例

iOS

iOSでは、任意の数のボタンを指定できます。各ボタンには、オプションでスタイルを指定したり、強調表示したりできます。AlertButtonStyle列挙体とAlertButtonのisPreferredフィールドで利用可能なオプションが表示されます。

Android

Androidでは、最大3つのボタンを指定できます。Androidには、中立、負、正のボタンという概念があります。

1つのボタンを指定すると、「肯定的」なボタン（「OK」など）になります。
2つのボタンは「否定的」、「肯定的」（「キャンセル」、「OK」など）になります。
3つのボタンは「中立」、「否定的」、「肯定的」（「後で」、「キャンセル」、「OK」など）になります。

Androidのアラートは、アラートボックスの外側をタップして閉じることができます。デフォルトでは無効になっており、オプションのAlertOptionsパラメータに`cancelable`プロパティを`true`に設定することで有効にできます。
{cancelable: true}.

`options`パラメータ内に`onDismiss`コールバックプロパティを指定することで、キャンセルイベントを処理できます。

例
Android

リファレンス

メソッド

`alert()`

static alert (
  title: string,
  message?: string,
  buttons?: AlertButton[],
  options?: AlertOptions,
);

パラメータ

名前	型	説明
title 必須	string	ダイアログのタイトル。`null`または空の文字列を渡すと、タイトルは非表示になります。
message	string	ダイアログのタイトルの下に表示されるオプションのメッセージ。
buttons	AlertButton[]	ボタンの設定を含むオプションの配列。
options	AlertOptions	オプションのアラート設定。

`prompt()`
iOS

static prompt: (
  title: string,
  message?: string,
  callbackOrButtons?: ((text: string) => void) | AlertButton[],
  type?: AlertType,
  defaultValue?: string,
  keyboardType?: string,
);

アラート形式でテキストを入力するためのプロンプトを作成して表示します。

パラメータ

名前	型	説明
title 必須	string	ダイアログのタイトル。
message	string	テキスト入力の上に表示されるオプションのメッセージ。
callbackOrButtons	function AlertButton[]	関数を渡すと、ユーザーが「OK」をタップしたときにプロンプトの値で呼び出されます。 `(text: string) => void` 配列を渡すと、配列の内容に基づいてボタンが設定されます。
type	AlertType	テキスト入力を設定します。
defaultValue	string	テキスト入力のデフォルトテキスト。
keyboardType	string	最初のテキストフィールド（存在する場合）のキーボードの種類。TextInputのkeyboardTypesのいずれか。
options	AlertOptions	オプションのアラート設定。

型定義

AlertButtonStyle
iOS

iOSアラートのボタンスタイル。

型
enum

定数

値	説明
`'default'`	デフォルトのボタンスタイル。
`'cancel'`	キャンセルボタンスタイル。
`'destructive'`	破棄ボタンスタイル。

AlertType
iOS

iOSアラートの種類。

型
enum

定数

値	説明
`'default'`	入力のないデフォルトのアラート
`'plain-text'`	プレーンテキスト入力アラート
`'secure-text'`	セキュリティーテキスト入力アラート
`'login-password'`	ログインとパスワードアラート

AlertButton

アラート内のボタンの設定を記述するオブジェクト。

型
オブジェクトの配列

オブジェクトのプロパティ

名前	型	説明
text	string	ボタンラベル。
onPress	function	ボタンを押したときのコールバック関数。
style iOS	AlertButtonStyle	ボタンスタイル。Androidではこのプロパティは無視されます。
isPreferred iOS	boolean	ボタンを強調表示するかどうか。Androidではこのプロパティは無視されます。

AlertOptions

型
object

プロパティ

名前	型	説明
cancelable Android	boolean	アラートボックスの外側をタップしてアラートを閉じることができるかどうかを定義します。
userInterfaceStyle iOS	string	アラートに使用されるインターフェーススタイル。`light`または`dark`に設定できます。それ以外の場合は、デフォルトのシステムスタイルが使用されます。
onDismiss Android	function	アラートが閉じられたときに実行されるコールバック関数。

例​

iOS​

Android​

例Android​

リファレンス

メソッド​

alert()​

prompt() iOS​

型定義​

AlertButtonStyleiOS​

AlertTypeiOS​

AlertButton​

AlertOptions​

例

iOS