このページは Cloud Translation API によって翻訳されました。

ダイアログ

Dialog コンポーネントは、ポップアップメッセージを表示するか、メインアプリコンテンツの上のレイヤでユーザー入力をリクエストします。ユーザーの注意を引くために、中断する UI エクスペリエンスを作成します。

ダイアログのユースケースには、次のようなものがあります。

ファイルの削除時など、ユーザーの操作を確認する。
ユーザー入力のリクエスト（ToDo リストアプリなど）。
ユーザーが選択できるオプションのリストを提示する（プロファイルの設定で国を選択するなど）。

テキストとアイコンが入力されたダイアログ。 — **図 1.** テキストとアイコンが入力されたダイアログの例

通知ダイアログ

AlertDialog コンポーザブルには、マテリアルデザインテーマのダイアログを作成するための便利な API が用意されています。AlertDialog には、ダイアログの特定の要素を処理するための特定のパラメータがあります。たとえば、次のようなものがあります。

title: ダイアログの上部に表示されるテキスト。
text: ダイアログ内に中央に表示されるテキスト。
icon: ダイアログの上部に表示されるグラフィック。
onDismissRequest: ユーザーがダイアログの外側をタップするなどしてダイアログを閉じるときに呼び出される関数。
dismissButton: 閉じるボタンとして機能するコンポーザブル。
confirmButton: 確認ボタンとして機能するコンポーザブル。

次の例では、アラートダイアログに、ダイアログを閉じるボタンとリクエストを確認するボタンの 2 つを実装しています。

@Composable
fun AlertDialogExample(
    onDismissRequest: () -> Unit,
    onConfirmation: () -> Unit,
    dialogTitle: String,
    dialogText: String,
    icon: ImageVector,
) {
    AlertDialog(
        icon = {
            Icon(icon, contentDescription = "Example Icon")
        },
        title = {
            Text(text = dialogTitle)
        },
        text = {
            Text(text = dialogText)
        },
        onDismissRequest = {
            onDismissRequest()
        },
        confirmButton = {
            TextButton(
                onClick = {
                    onConfirmation()
                }
            ) {
                Text("Confirm")
            }
        },
        dismissButton = {
            TextButton(
                onClick = {
                    onDismissRequest()
                }
            ) {
                Text("Dismiss")
            }
        }
    )
}Dialog.kt

この実装では、次のように子コンポーザブルに引数を渡す親コンポーザブルが想定されています。

@Composable
fun DialogExamples() {
    // ...
    val openAlertDialog = remember { mutableStateOf(false) }

    // ...
        when {
            // ...
            openAlertDialog.value -> {
                AlertDialogExample(
                    onDismissRequest = { openAlertDialog.value = false },
                    onConfirmation = {
                        openAlertDialog.value = false
                        println("Confirmation registered") // Add logic here to handle confirmation.
                    },
                    dialogTitle = "Alert dialog example",
                    dialogText = "This is an example of an alert dialog with buttons.",
                    icon = Icons.Default.Info
                )
            }
        }
    }
}Dialog.kt

これを実装すると次のようになります。

閉じるボタンと確認ボタンの両方がある開いているアラートダイアログ。 — **図 2.** ボタン付きのアラートダイアログ。

Dialog コンポーザブル

Dialog は、コンテンツのスタイル設定や事前定義されたスロットを提供しない基本的なコンポーザブルです。これは比較的単純なコンテナで、Card などのコンテナに入力する必要があります。ダイアログの主なパラメータは次のとおりです。

onDismissRequest: ユーザーがダイアログを閉じるときに呼び出されるラムダ。
properties: カスタマイズに追加のスコープを提供する DialogProperties のインスタンス。

基本的な例

次の例は、Dialog コンポーザブルの基本的な実装です。セカンダリコンテナとして Card を使用します。Card がないと、Text コンポーネントはメインアプリコンテンツの上に単独で表示されます。

@Composable
fun MinimalDialog(onDismissRequest: () -> Unit) {
    Dialog(onDismissRequest = { onDismissRequest() }) {
        Card(
            modifier = Modifier
                .fillMaxWidth()
                .height(200.dp)
                .padding(16.dp),
            shape = RoundedCornerShape(16.dp),
        ) {
            Text(
                text = "This is a minimal dialog",
                modifier = Modifier
                    .fillMaxSize()
                    .wrapContentSize(Alignment.Center),
                textAlign = TextAlign.Center,
            )
        }
    }
}Dialog.kt

実装は次のようになります。ダイアログが開いていると、その下のメインのアプリコンテンツは暗くグレー表示されます。

高度な例

以下は、Dialog コンポーザブルのより高度な実装です。この場合、コンポーネントは上記の AlertDialog の例と同様のインターフェースを手動で実装します。

@Composable
fun DialogWithImage(
    onDismissRequest: () -> Unit,
    onConfirmation: () -> Unit,
    painter: Painter,
    imageDescription: String,
) {
    Dialog(onDismissRequest = { onDismissRequest() }) {
        // Draw a rectangle shape with rounded corners inside the dialog
        Card(
            modifier = Modifier
                .fillMaxWidth()
                .height(375.dp)
                .padding(16.dp),
            shape = RoundedCornerShape(16.dp),
        ) {
            Column(
                modifier = Modifier
                    .fillMaxSize(),
                verticalArrangement = Arrangement.Center,
                horizontalAlignment = Alignment.CenterHorizontally,
            ) {
                Image(
                    painter = painter,
                    contentDescription = imageDescription,
                    contentScale = ContentScale.Fit,
                    modifier = Modifier
                        .height(160.dp)
                )
                Text(
                    text = "This is a dialog with buttons and an image.",
                    modifier = Modifier.padding(16.dp),
                )
                Row(
                    modifier = Modifier
                        .fillMaxWidth(),
                    horizontalArrangement = Arrangement.Center,
                ) {
                    TextButton(
                        onClick = { onDismissRequest() },
                        modifier = Modifier.padding(8.dp),
                    ) {
                        Text("Dismiss")
                    }
                    TextButton(
                        onClick = { onConfirmation() },
                        modifier = Modifier.padding(8.dp),
                    ) {
                        Text("Confirm")
                    }
                }
            }
        }
    }
}Dialog.kt

これを実装すると次のようになります。

ビクトリア州のフェザートップ山の写真が掲載されたダイアログ。画像の下には閉じるボタンと確認ボタンがあります。 — **図 4.** 画像を含むダイアログ。

参考情報

マテリアル UI のドキュメント