Dialog 元件會顯示彈出式訊息，或要求使用者在主要應用程式內容上方的圖層上輸入內容。這種設計可以打造幹擾性的 UI 體驗，吸引使用者註意。
以下是對話方塊的用途：
- 確認使用者動作，例如刪除檔案時。
- 要求使用者輸入內容，例如在待辦事項清單應用程式中。
- 列出可供使用者選取的選項清單，例如在設定檔設定中選擇國家/地區。
快訊對話方塊
AlertDialog 可組合項提供便利的 API，可用來建立質感設計主題對話方塊。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")
}
}
)
}
此實作隱含以下列方式將引數傳遞至子項可組合項的父項可組合項：
@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 是基本的可組合項，無法為內容提供任何樣式或預先定義的版位。這是相對簡單的容器，您應填入 Card 等容器。以下是對話方塊的部分重要參數：
onDismissRequest：使用者關閉對話方塊時呼叫的 lambda。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 可組合項的進階實作。在這種情況下，元件會手動實作與上述 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")
}
}
}
}
}
}
實作內容如下所示：
