Dialog

O componente Dialog exibe mensagens pop-up ou solicita entrada do usuário em uma camada acima do conteúdo principal do app. Ele cria uma experiência de interface interruptiva para chamar a atenção do usuário.

Entre os casos de uso para uma caixa de diálogo estão os seguintes:

• Confirmar a ação do usuário, como ao excluir um arquivo.
• Solicitando entrada do usuário, como em um app de lista de tarefas.
• Apresentação de uma lista de opções para seleção do usuário, como escolher um país em uma configuração de perfil.

Figura 1. Exemplo de caixa de diálogo preenchida com texto e ícones.

Caixa de diálogo de alerta

O elemento combinável AlertDialog fornece uma API conveniente para criar uma caixa de diálogo com tema do Material Design. AlertDialog tem parâmetros específicos para processar elementos específicos da caixa de diálogo. Entre elas estão as seguintes:

• title: o texto que aparece na parte de cima da caixa de diálogo.
• text: o texto que aparece centralizado na caixa de diálogo.
• icon: a imagem que aparece na parte de cima da caixa de diálogo.
• onDismissRequest: função chamada quando o usuário dispensa a caixa de diálogo, por exemplo, tocando fora dela.
• dismissButton: um elemento combinável que serve como botão de dispensar.
• confirmButton: um elemento combinável que serve como botão de confirmação.

O exemplo abaixo implementa dois botões em uma caixa de diálogo de alerta, um que dispensa a caixa de diálogo e outro que confirma a solicitação.

@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

Essa implementação implica um elemento combinável pai que transmite argumentos ao elemento combinável desta forma:

@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

Essa implementação aparece da seguinte forma:

Figura 2. Uma caixa de diálogo de alerta com botões.

Observação: quando o usuário clica em um dos botões, a caixa de diálogo é fechada. Quando o usuário clica em "Confirmar", ele chama uma função que também processa a confirmação. Neste exemplo, essas funções são onDismissRequest() e onConfirmRequest().

Observação: nos casos em que a caixa de diálogo exige um conjunto mais complexo de botões, é possível se beneficiar do uso do elemento combinável Dialog e do preenchimento dele de uma forma mais livre.

Elemento combinável de caixa de diálogo

Dialog é um elemento básico combinável que não fornece estilo ou slots predefinidos para o conteúdo. Ele é um contêiner relativamente simples que precisa ser preenchido com um contêiner como Card. Veja a seguir alguns dos principais parâmetros de uma caixa de diálogo:

• onDismissRequest: o lambda chamado quando o usuário fecha a caixa de diálogo.
• properties: uma instância de DialogProperties que fornece um escopo extra para personalização.

Cuidado: ao contrário do exemplo de AlertDialog na seção anterior, é necessário especificar manualmente o tamanho e a forma de Dialog. Você também precisa fornecer um contêiner interno.

Exemplo básico

O exemplo abaixo é uma implementação básica do elemento combinável Dialog. Ele usa um Card como o contêiner secundário. Sem o Card, o componente Text apareceria sozinho acima do conteúdo principal do app.

@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

Essa implementação aparece da seguinte forma: Quando a caixa de diálogo é aberta, o conteúdo principal do app abaixo dela aparece escurecido e esmaecido:

Figura 3. Mínimo de diálogo.

Exemplo avançado

Confira abaixo uma implementação mais avançada do elemento combinável Dialog. Nesse caso, o componente implementa manualmente uma interface semelhante ao exemplo AlertDialog acima.

Cuidado: se você precisar mostrar apenas uma caixa de diálogo de dois botões como neste exemplo, use AlertDialog e a API mais conveniente. No entanto, se você quiser criar uma caixa de diálogo mais complexa, talvez com formulários e vários botões, use Dialog com conteúdo personalizado, como no exemplo abaixo.

@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

Essa implementação aparece da seguinte forma:

Figura 4. Uma caixa de diálogo que inclui uma imagem.

Outros recursos

• Documentação da interface do Material Design (em inglês)