Alert
指定されたタイトルとメッセージでアラートダイアログを起動します。
オプションでボタンのリストを提供できます。いずれかのボタンをタップすると、それぞれのonPressコールバックが実行され、アラートが閉じます。デフォルトでは、唯一のボタンは「OK」ボタンになります。
これはAndroidとiOSの両方で動作し、静的なアラートを表示できるAPIです。ユーザーに情報の入力を促すアラートはiOSのみで利用可能です。
例
iOS
iOSでは、任意の数のボタンを指定できます。各ボタンはオプションでスタイルを指定したり、強調表示したりできます。利用可能なオプションはAlertButtonStyle enumと、AlertButtonのisPreferredフィールドで表されます。
Android
Androidでは、最大3つのボタンを指定できます。Androidには、ニュートラル、ネガティブ、ポジティブというボタンの概念があります。
- ボタンを1つ指定した場合、それは「ポジティブ」なボタン(例:「OK」)になります。
- 2つのボタンは「ネガティブ」、「ポジティブ」(例:「キャンセル」、「OK」)を意味します。
- 3つのボタンは「ニュートラル」、「ネガティブ」、「ポジティブ」(例:「後で」、「キャンセル」、「OK」)を意味します。
Androidのアラートは、アラートボックスの外をタップすることで閉じることができます。これはデフォルトで無効になっており、cancelableプロパティをtrueに設定したオプションのAlertOptionsパラメータを提供することで有効にできます。例:{cancelable: true}.
キャンセルイベントは、optionsパラメータ内にonDismissコールバックプロパティを提供することで処理できます。
使用例Android
リファレンス
Methods
alert()
tsx
static alert (
title: string,
message?: string,
buttons?: AlertButton[],
options?: AlertOptions,
);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
| title 必須 | string | ダイアログのタイトル。nullまたは空の文字列を渡すとタイトルは非表示になります。 |
| メッセージ | string | ダイアログのタイトルの下に表示されるオプションのメッセージ。 |
| ボタン | 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 | ダイアログのタイトル。 |
| メッセージ | string | テキスト入力の上に表示されるオプションのメッセージ。 |
| callbackOrButtons | function AlertButton[] | 関数が渡された場合、ユーザーが「OK」をタップしたときにプロンプトの値で呼び出されます(text: string) => void。配列が渡された場合、ボタンは配列の内容に基づいて構成されます。 |
| type | AlertType | これにより、テキスト入力が構成されます。 |
| defaultValue | string | テキスト入力のデフォルトテキスト。 |
| keyboardType | string | 最初のテキストフィールド(存在する場合)のキーボードタイプ。TextInputのkeyboardTypesのいずれか。 |
| options | AlertOptions | オプションのアラート設定。 |
型定義
AlertButtonStyleiOS
iOSアラートのボタン スタイル。
| 型 |
|---|
| 列挙型 |
定数
| 値 | 説明 |
|---|---|
'default' | デフォルトのボタン スタイル。 |
'cancel' | キャンセルボタン スタイル。 |
'destructive' | 破棄ボタン スタイル。 |
AlertTypeiOS
iOSアラートタイプ。
| 型 |
|---|
| 列挙型 |
定数
| 値 | 説明 |
|---|---|
'default' | 入力なしのデフォルトのアラート |
'plain-text' | プレーンテキスト入力アラート |
'secure-text' | セキュアテキスト入力アラート |
'login-password' | ログインとパスワードアラート |
AlertButton
アラート内のボタンの構成を記述するオブジェクト。
| 型 |
|---|
| オブジェクトの配列 |
オブジェクトのプロパティ
| 名前 | 型 | 説明 |
|---|---|---|
| text | string | ボタンのラベル。 |
| onPress | function | ボタンが押されたときのコールバック関数。 |
| style iOS | AlertButtonStyle | ボタンのスタイル。Androidではこのプロパティは無視されます。 |
| isPreferred iOS | boolean | ボタンを強調表示するかどうか。Androidではこのプロパティは無視されます。 |
AlertOptions
| 型 |
|---|
| object |
プロパティ
| 名前 | 型 | 説明 |
|---|---|---|
| キャンセル可能 Android | boolean | アラートボックスの外をタップしてアラートを閉じることができるかどうかを定義します。 |
| userInterfaceStyle iOS | string | アラートに使用されるインターフェーススタイル。lightまたはdarkに設定できます。設定しない場合、デフォルトのシステムスタイルが使用されます。 |
| onDismiss Android | function | アラートが閉じられたときに呼び出されるコールバック関数。 |