对话框

Dialog 组件会在主应用内容上方的一层显示弹出消息或请求用户输入。它可以打造干扰性界面体验，以吸引用户的注意力。

对话框的用例如下：

• 确认用户操作，例如删除文件时。
• 请求用户输入，例如在待办事项列表应用中。
• 显示用于用户选择的选项列表，例如在个人资料设置中选择国家/地区。

图 1. 填充文本和图标的对话框示例。

提醒对话框

AlertDialog 可组合项提供了一个便捷的 API，用于创建 Material Design 主题对话框。AlertDialog 具有用于处理对话框特定元素的特定参数。其中包括：

• title：沿对话框顶部显示的文本。
• text：显示在对话框中心的文本。
• icon：显示在对话框顶部的图形。
• onDismissRequest：当用户关闭对话框（例如点按对话框外面）时调用的函数。
• dismissButton：用作关闭按钮的可组合项。
• confirmButton：充当“确认”按钮的可组合项。

以下示例在提醒对话框中实现了两个按钮，一个用于关闭对话框，另一个用于确认其请求。

@OptIn(ExperimentalMaterial3Api::class)
@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.包含按钮的提醒对话框。

注意 ：当用户点击其中任一按钮时，该对话框会关闭。当用户点击“确认”时，系统会调用一个同样处理确认的函数。在此示例中，这些函数为 onDismissRequest() 和 onConfirmRequest()。

注意 ：如果您的对话框需要一组更复杂的按钮，您可以使用 Dialog 可组合项并以更自由的形式进行填充。

对话框可组合项

Dialog 是一个基本的可组合项，不提供任何样式设置或预定义的内容槽。它是一个相对简单的容器，您应该使用 Card 等容器填充该容器。以下是对话框的一些关键参数：

• onDismissRequest：用户关闭对话框时调用的 lambda。
• properties：DialogProperties 的实例，提供一些额外的自定义范围。

注意 ：与上一部分中的 AlertDialog 示例不同，您需要手动指定 Dialog 的大小和形状。您还需要提供内部容器。

基本示例

以下示例是 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

此实现如下所示。请注意，该对话框打开时，其下方的主要应用内容会变暗并灰显：

图 3.最小对话框。

高级示例

以下是 Dialog 可组合项的更高级实现。在这种情况下，该组件会手动实现与上述 AlertDialog 示例类似的接口。

注意 ：如果您只需要按此示例显示双按钮对话框，则应使用 AlertDialog 及其更方便的 API。但是，如果您想创建更复杂的对话框（可能具有表单和多个按钮），则应将 Dialog 用于自定义内容，如以下示例所示。

@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.包含图片的对话框。

其他资源

• Material 界面文档