State of Compose 2023 results are in! Click here to learn more

← Back to Material 3 Compose

AlertDialog

Component
in
Material 3
. Since 1.0.0

Overview

Code Examples

Video

<a href="https://m3.material.io/components/dialogs/overview" class="external" target="_blank">Material Design basic dialog</a>.

Dialogs provide important prompts in a user flow. They can require an action, communicate information, or help users accomplish a task.

!Basic dialog image(https://developer.android.com/images/reference/androidx/compose/material3/basic-dialog.png)

The dialog will position its buttons, typically TextButtons, based on the available space. By default it will try to place them horizontally next to each other and fallback to horizontal placement if not enough space is available.

Simple usage:

Overloads

AlertDialog

@OptIn(ExperimentalMaterial3Api::class)
@Composable
fun AlertDialog(
    onDismissRequest: () -> Unit,
    confirmButton: @Composable () -> Unit,
    modifier: Modifier = Modifier,
    dismissButton: @Composable (() -> Unit)? = null,
    icon: @Composable (() -> Unit)? = null,
    title: @Composable (() -> Unit)? = null,
    text: @Composable (() -> Unit)? = null,
    shape: Shape = AlertDialogDefaults.shape,
    containerColor: Color = AlertDialogDefaults.containerColor,
    iconContentColor: Color = AlertDialogDefaults.iconContentColor,
    titleContentColor: Color = AlertDialogDefaults.titleContentColor,
    textContentColor: Color = AlertDialogDefaults.textContentColor,
    tonalElevation: Dp = AlertDialogDefaults.TonalElevation,
    properties: DialogProperties = DialogProperties()
)

Parameters

NameDescription
onDismissRequestcalled when the user tries to dismiss the Dialog by clicking outside or pressing the back button. This is not called when the dismiss button is clicked.
confirmButtonbutton which is meant to confirm a proposed action, thus resolving what triggered the dialog. The dialog does not set up any events for this button so they need to be set up by the caller.
modifierthe Modifier to be applied to this dialog
dismissButtonbutton which is meant to dismiss the dialog. The dialog does not set up any events for this button so they need to be set up by the caller.
iconoptional icon that will appear above the title or above the text, in case a title was not provided.
titletitle which should specify the purpose of the dialog. The title is not mandatory, because there may be sufficient information inside the text.
texttext which presents the details regarding the dialog's purpose.
shapedefines the shape of this dialog's container
containerColorthe color used for the background of this dialog. Use Color.Transparent to have no color.
iconContentColorthe content color used for the icon.
titleContentColorthe content color used for the title.
textContentColorthe content color used for the text.
tonalElevationwhen containerColor is ColorScheme.surface, a translucent primary color overlay is applied on top of the container. A higher tonal elevation value will result in a darker color in light theme and lighter color in dark theme. See also: Surface.
propertiestypically platform specific properties to further configure the dialog

AlertDialog

@ExperimentalMaterial3Api
@Composable
fun AlertDialog(
    onDismissRequest: () -> Unit,
    modifier: Modifier = Modifier,
    properties: DialogProperties = DialogProperties(),
    content: @Composable () -> Unit
)

Parameters

NameDescription
onDismissRequestcalled when the user tries to dismiss the Dialog by clicking outside or pressing the back button. This is not called when the dismiss button is clicked.
modifierthe Modifier to be applied to this dialog's content.
propertiestypically platform specific properties to further configure the dialog.
contentthe content of the dialo