← Back to Wear Material
AlertDialog
Component
in
Wear Material
. Since 1.0.0-alpha12Overview
Code Examples
Video
AlertDialog is an opinionated, full screen dialog. This overload offers 5 slots for title, negative button, positive button, optional icon and optional content. The buttons are shown side-by-side below the icon, text and content. AlertDialog is scrollable by default if the content is taller than the viewport.
Example of an AlertDialog with an icon, title, body text and buttons:
Overloads
AlertDialog
@Composable
public fun AlertDialog(
title: @Composable () -> Unit,
negativeButton: @Composable () -> Unit,
positiveButton: @Composable () -> Unit,
modifier: Modifier = Modifier,
icon: @Composable (() -> Unit)? = null,
scrollState: ScrollState = rememberScrollState(),
backgroundColor: Color = MaterialTheme.colors.background,
contentColor: Color = contentColorFor(backgroundColor),
titleColor: Color = contentColor,
iconTintColor: Color = contentColor,
contentPadding: PaddingValues = DialogDefaults.ButtonsContentPadding,
content: @Composable (() -> Unit)? = null
)
Parameters
Name | Description |
---|---|
title | A slot for displaying the title of the dialog, expected to be one or two lines of text. |
negativeButton | A slot for a Button indicating negative sentiment (e.g. No). Clicking the button must remove the dialog from the composition hierarchy. |
positiveButton | A slot for a Button indicating positive sentiment (e.g. Yes). Clicking the button must remove the dialog from the composition hierarchy. |
modifier | Modifier to be applied to the dialog. |
icon | Optional slot for an icon to be shown at the top of the dialog. |
scrollState | The scroll state for the dialog so that the scroll position can be displayed e.g. by the PositionIndicator passed to Scaffold. |
backgroundColor | Color representing the background color for the dialog. |
contentColor | Color representing the color for content. |
titleColor | Color representing the color for title. |
iconTintColor | Icon Color that defaults to contentColor, unless specifically overridden. |
contentPadding | The padding to apply around the whole of the dialog's contents. |
content | A slot for additional content, expected to be 2-3 lines of text |
AlertDialog
@Composable
public fun AlertDialog(
title: @Composable () -> Unit,
modifier: Modifier = Modifier,
icon: @Composable (() -> Unit)? = null,
message: @Composable (() -> Unit)? = null,
scrollState: ScrollState = rememberScrollState(),
backgroundColor: Color = MaterialTheme.colors.background,
contentColor: Color = contentColorFor(backgroundColor),
titleColor: Color = contentColor,
messageColor: Color = contentColor,
iconTintColor: Color = contentColor,
contentPadding: PaddingValues = DialogDefaults.ChipsContentPadding,
content: @Composable ColumnScope.() -> Unit
)
Parameters
Name | Description |
---|---|
title | A slot for displaying the title of the dialog, expected to be one or two lines of text. |
modifier | Modifier to be applied to the dialog. |
icon | Optional slot for an icon to be shown at the top of the dialog. |
message | Optional slot for additional message content, expected to be 2-3 lines of text. |
scrollState | The scroll state for the dialog so that the scroll position can be displayed e.g. by the PositionIndicator passed to Scaffold. |
backgroundColor | Color representing the background color for the dialog. |
contentColor | Color representing the color for content. |
titleColor | Color representing the color for title. |
messageColor | Color representing the color for message. |
iconTintColor | Icon Color that defaults to contentColor, unless specifically overridden. |
contentPadding | The padding to apply around the whole of the dialog's contents. |
content | A slot for one or more spaced Chips, stacked vertically |