El componente Dialog
muestra mensajes emergentes o solicita la entrada del usuario en un
sobre el contenido principal de la aplicación. Crea una experiencia de IU disruptiva para
captar la atención del usuario.
Entre los casos de uso para un diálogo, se encuentran los siguientes:
- Confirma la acción del usuario, por ejemplo, cuando se borra un archivo.
- Solicitar entradas del usuario, como en una app de listas de tareas pendientes
- Una lista de opciones para la selección del usuario, como elegir un país en la configuración de un perfil.
Cuadro de diálogo de alerta
El elemento componible AlertDialog
proporciona una API conveniente para crear una
Diálogo con el tema de Material Design. AlertDialog
tiene parámetros específicos para
controlar elementos particulares del diálogo. Entre ellas, se incluyen las siguientes:
title
: Es el texto que aparece en la parte superior del diálogo.text
: Es el texto que aparece centrado dentro del diálogo.icon
: Es el gráfico que aparece en la parte superior del diálogo.onDismissRequest
: Es la función a la que se llama cuando el usuario descarta el diálogo. por ejemplo, si presionas fuera de ella.dismissButton
: Es un elemento componible que funciona como botón para descartar.confirmButton
: Es un elemento componible que funciona como botón de confirmación.
En el siguiente ejemplo, se implementan dos botones en un diálogo de alerta, uno que descarta el diálogo y otro que confirma su solicitud.
@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") } } ) }
Esta implementación implica un elemento superior componible que pasa argumentos al elemento componible secundario de la siguiente manera:
@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 ) } } } }
Esta implementación aparece de la siguiente manera:
![Un diálogo de alerta abierto que tiene un botón para descartar y confirmar](https://developer.android.com/static/develop/ui/compose/images/components/dialog-alert.png?authuser=7&hl=es)
Elemento componible de diálogo
Dialog
es un elemento componible básico que no proporciona ningún estilo ni
espacios predefinidos para el contenido. Es un contenedor relativamente sencillo que
Debes propagar con un contenedor como Card
. Los siguientes son algunos de
los parámetros clave de un diálogo:
onDismissRequest
: Es la expresión lambda a la que se llama cuando el usuario cierra el diálogo.properties
: Es una instancia deDialogProperties
que proporciona algunos un mayor alcance para la personalización.
Ejemplo básico
El siguiente ejemplo es una implementación básica del elemento Dialog
componible. Nota
que usa un Card
como contenedor secundario. Sin Card
, Text
aparecería solo sobre el contenido principal de la aplicación.
@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, ) } } }
Esta implementación aparece de la siguiente manera: Ten en cuenta que cuando el diálogo está abierto, el contenido de la app principal que aparece debajo se verá oscuro y atenuado:
![Un diálogo que solo contiene una etiqueta.](https://developer.android.com/static/develop/ui/compose/images/components/dialog-minimal.png?authuser=7&hl=es)
Ejemplo avanzado
A continuación, se incluye una implementación más avanzada del elemento componible Dialog
. En este
, el componente implementará manualmente una interfaz similar a AlertDialog
ejemplo anterior.
@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") } } } } } }
Esta implementación aparece de la siguiente manera:
![Un cuadro de diálogo con una foto del monte Feathertop, Victoria. Debajo de la imagen, hay un botón para descartar y un botón para confirmar.](https://developer.android.com/static/develop/ui/compose/images/components/dialog-image.png?authuser=7&hl=es)