Alert

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

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

これはAndroidとiOSの両方で機能し、静的なアラートを表示できるAPIです。ユーザーに情報の入力を促すアラートはiOSでのみ利用可能です。

使用例

iOS

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

Android

Androidでは、最大3つのボタンを指定できます。Androidには、ニュートラル、ネガティブ、ポジティブなボタンという概念があります。

ボタンを1つ指定した場合、それは「ポジティブ」なもの（例：「OK」）になります。
ボタンが2つの場合は「ネガティブ」、「ポジティブ」（例：「キャンセル」、「OK」）を意味します。
ボタンが3つの場合は「ニュートラル」、「ネガティブ」、「ポジティブ」（例：「後で」、「キャンセル」、「OK」）を意味します。

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

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

使用例
Android

リファレンス

メソッド

`alert()`

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

パラメータ

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

`prompt()`
iOS

tsx
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