Dialog

คอมโพเนนต์ Dialog จะแสดงข้อความป๊อปอัปหรือขอข้อมูลจากผู้ใช้ในเลเยอร์เหนือเนื้อหาหลักของแอป ซึ่งจะสร้างประสบการณ์ UI ที่รบกวนเพื่อดึงดูดความสนใจของผู้ใช้

กรณีการใช้งานของกล่องโต้ตอบมีดังนี้

  • ยืนยันการดำเนินการของผู้ใช้ เช่น เมื่อลบไฟล์
  • การขอข้อมูลจากผู้ใช้ เช่น ในแอปรายการสิ่งที่ต้องทำ
  • แสดงรายการตัวเลือกสำหรับผู้ใช้ เช่น การเลือกประเทศในการตั้งค่าโปรไฟล์
กล่องโต้ตอบที่มีข้อความและไอคอน
รูปที่ 1 ตัวอย่างกล่องโต้ตอบที่มีข้อความและไอคอน

ช่องโต้ตอบการแจ้งเตือน

คอมโพสิเบิล AlertDialog มี API ที่สะดวกสำหรับการสร้างกล่องโต้ตอบธีม Material Design 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 หลักที่ส่งอาร์กิวเมนต์ไปยัง Composable ย่อยด้วยวิธีนี้

@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 เป็นคอมโพสิชันพื้นฐานที่ไม่มีการจัดสไตล์หรือช่องที่กำหนดไว้ล่วงหน้าสำหรับเนื้อหา ซึ่งเป็นคอนเทนเนอร์ที่ค่อนข้างตรงไปตรงมาซึ่งคุณควรป้อนข้อมูลด้วยคอนเทนเนอร์ เช่น 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.kt

การใช้งานนี้จะปรากฏดังนี้ โปรดทราบว่าเมื่อกล่องโต้ตอบเปิดอยู่ เนื้อหาหลักของแอปที่อยู่ด้านล่างจะมืดลงและเปลี่ยนเป็นสีเทา

กล่องโต้ตอบที่ไม่มีสิ่งใดนอกจากป้ายกำกับ
รูปที่ 3 กล่องโต้ตอบแบบมินิมอล

ตัวอย่างขั้นสูง

ต่อไปนี้เป็นการใช้งาน Dialog composable ที่ขั้นสูงขึ้น ในกรณีนี้ คอมโพเนนต์จะใช้อินเทอร์เฟซที่คล้ายกับ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 กล่องโต้ตอบที่มีรูปภาพ

แหล่งข้อมูลเพิ่มเติม