Alert

Functions summary

Unit
@Composable
Alert(
    title: @Composable ColumnScope.() -> Unit,
    modifier: Modifier,
    icon: (@Composable ColumnScope.() -> Unit)?,
    message: (@Composable ColumnScope.() -> Unit)?,
    scrollState: ScalingLazyListState,
    backgroundColor: Color,
    titleColor: Color,
    messageColor: Color,
    iconColor: Color,
    verticalArrangement: Arrangement.Vertical,
    contentPadding: PaddingValues,
    content: ScalingLazyListScope.() -> Unit
)

Alert lays out the content for an opinionated, alert screen.
Unit
@Composable
Alert(
    title: @Composable ColumnScope.() -> Unit,
    negativeButton: @Composable () -> Unit,
    positiveButton: @Composable () -> Unit,
    modifier: Modifier,
    icon: (@Composable ColumnScope.() -> Unit)?,
    scrollState: ScalingLazyListState,
    backgroundColor: Color,
    contentColor: Color,
    titleColor: Color,
    iconColor: Color,
    verticalArrangement: Arrangement.Vertical,
    contentPadding: PaddingValues,
    content: (@Composable ColumnScope.() -> Unit)?
)

Alert lays out the content for an opinionated, alert screen.

Functions

Alert

@Composable
fun Alert(
    title: @Composable ColumnScope.() -> Unit,
    modifier: Modifier = Modifier,
    icon: (@Composable ColumnScope.() -> Unit)? = null,
    message: (@Composable ColumnScope.() -> Unit)? = null,
    scrollState: ScalingLazyListState = rememberScalingLazyListState(),
    backgroundColor: Color = MaterialTheme.colors.background,
    titleColor: Color = contentColorFor(backgroundColor),
    messageColor: Color = contentColorFor(backgroundColor),
    iconColor: Color = contentColorFor(backgroundColor),
    verticalArrangement: Arrangement.Vertical = DialogDefaults.AlertVerticalArrangement,
    contentPadding: PaddingValues = DialogDefaults.ContentPadding,
    content: ScalingLazyListScope.() -> Unit
): Unit

Alert lays out the content for an opinionated, alert screen. This overload offers 4 slots for title, optional icon, optional message text and a content slot expected to be one or more vertically stacked Chips or ToggleChips. Alert is scrollable by default if the content is taller than the viewport.

Alert can be used as a destination in a navigation graph e.g. using SwipeDismissableNavHost. However, for a conventional fullscreen dialog, displayed on top of other content, use Dialog.

Example of an Alert with an icon, title, message text and chips:

import androidx.compose.foundation.layout.Arrangement
import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.layout.wrapContentSize
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.painterResource
import androidx.compose.ui.text.style.TextAlign
import androidx.compose.ui.unit.dp
import androidx.wear.compose.material.Chip
import androidx.wear.compose.material.ChipDefaults
import androidx.wear.compose.material.Icon
import androidx.wear.compose.material.MaterialTheme
import androidx.wear.compose.material.Text
import androidx.wear.compose.material.dialog.Alert

Alert(
    verticalArrangement = Arrangement.spacedBy(4.dp, Alignment.Top),
    contentPadding = PaddingValues(start = 10.dp, end = 10.dp, top = 24.dp, bottom = 52.dp),
    icon = {
        Icon(
            painter = painterResource(id = R.drawable.ic_airplanemode_active_24px),
            contentDescription = "airplane",
            modifier = Modifier.size(24.dp).wrapContentSize(align = Alignment.Center),
        )
    },
    title = { Text(text = "Example Title Text", textAlign = TextAlign.Center) },
    message = {
        Text(
            text = "Message content goes here " + "(swipe right to dismiss)",
            textAlign = TextAlign.Center,
            style = MaterialTheme.typography.body2,
        )
    },
) {
    item {
        Chip(
            label = { Text("Primary") },
            onClick = { /* Do something e.g. navController.popBackStack() */ },
            colors = ChipDefaults.primaryChipColors(),
        )
    }
    item {
        Chip(
            label = { Text("Secondary") },
            onClick = { /* Do something e.g. navController.popBackStack() */ },
            colors = ChipDefaults.secondaryChipColors(),
        )
    }
}
Parameters
title: @Composable ColumnScope.() -> Unit

A slot for displaying the title of the dialog, expected to be one or two lines of text.
modifier: Modifier = Modifier

Modifier to be applied to the dialog.
icon: (@Composable ColumnScope.() -> Unit)? = null

Optional slot for an icon to be shown at the top of the dialog.
message: (@Composable ColumnScope.() -> Unit)? = null

Optional slot for additional message content, expected to be 2-3 lines of text.
scrollState: ScalingLazyListState = rememberScalingLazyListState()

The scroll state for the dialog so that the scroll position can be displayed e.g. by the PositionIndicator passed to Scaffold.
backgroundColor: Color = MaterialTheme.colors.background

Color representing the background color for the dialog.
titleColor: Color = contentColorFor(backgroundColor)

Color representing the color for title.
messageColor: Color = contentColorFor(backgroundColor)

Color representing the color for message.
iconColor: Color = contentColorFor(backgroundColor)

Color representing the color for icon.
verticalArrangement: Arrangement.Vertical = DialogDefaults.AlertVerticalArrangement

The vertical arrangement of the dialog's children. This allows us to add spacing between items and specify the arrangement of the items when we have not enough of them to fill the whole minimum size.
contentPadding: PaddingValues = DialogDefaults.ContentPadding

The padding to apply around the whole of the dialog's contents.
content: ScalingLazyListScope.() -> Unit

A slot for one or more spaced Chips, stacked vertically.

Alert

@Composable
fun Alert(
    title: @Composable ColumnScope.() -> Unit,
    negativeButton: @Composable () -> Unit,
    positiveButton: @Composable () -> Unit,
    modifier: Modifier = Modifier,
    icon: (@Composable ColumnScope.() -> Unit)? = null,
    scrollState: ScalingLazyListState = rememberScalingLazyListState(),
    backgroundColor: Color = MaterialTheme.colors.background,
    contentColor: Color = contentColorFor(backgroundColor),
    titleColor: Color = contentColor,
    iconColor: Color = contentColor,
    verticalArrangement: Arrangement.Vertical = DialogDefaults.AlertVerticalArrangement,
    contentPadding: PaddingValues = DialogDefaults.ContentPadding,
    content: (@Composable ColumnScope.() -> Unit)? = null
): Unit

Alert lays out the content for an opinionated, alert screen. 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. Alert is scrollable by default if the content is taller than the viewport.

Alert can be used as a destination in a navigation graph e.g. using SwipeDismissableNavHost. However, for a conventional fullscreen dialog, displayed on top of other content, use Dialog.

Example of an Alert with an icon, title, body text and buttons:

import androidx.compose.foundation.layout.PaddingValues
import androidx.compose.foundation.layout.size
import androidx.compose.foundation.layout.wrapContentSize
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.painterResource
import androidx.compose.ui.text.style.TextAlign
import androidx.compose.ui.unit.dp
import androidx.wear.compose.material.Button
import androidx.wear.compose.material.ButtonDefaults
import androidx.wear.compose.material.Icon
import androidx.wear.compose.material.Text
import androidx.wear.compose.material.dialog.Alert

Alert(
    icon = {
        Icon(
            painter = painterResource(id = R.drawable.ic_airplanemode_active_24px),
            contentDescription = "airplane",
            modifier = Modifier.size(24.dp).wrapContentSize(align = Alignment.Center),
        )
    },
    title = { Text("Title text displayed here", textAlign = TextAlign.Center) },
    negativeButton = {
        Button(
            colors = ButtonDefaults.secondaryButtonColors(),
            onClick = {
                /* Do something e.g. navController.popBackStack()*/
            },
        ) {
            Text("No")
        }
    },
    positiveButton = {
        Button(
            onClick = {
                /* Do something e.g. navController.popBackStack()*/
            }
        ) {
            Text("Yes")
        }
    },
    contentPadding = PaddingValues(start = 10.dp, end = 10.dp, top = 24.dp, bottom = 32.dp),
) {
    Text(
        text = "Body text displayed here " + "(swipe right to dismiss)",
        textAlign = TextAlign.Center,
    )
}
Parameters
title: @Composable ColumnScope.() -> Unit

A slot for displaying the title of the dialog, expected to be one or two lines of text.
negativeButton: @Composable () -> Unit

A slot for a Button indicating negative sentiment (e.g. No). Clicking the button must remove the dialog from the composition hierarchy.
positiveButton: @Composable () -> Unit

A slot for a Button indicating positive sentiment (e.g. Yes). Clicking the button must remove the dialog from the composition hierarchy.
modifier: Modifier = Modifier

Modifier to be applied to the dialog content.
icon: (@Composable ColumnScope.() -> Unit)? = null

Optional slot for an icon to be shown at the top of the dialog.
scrollState: ScalingLazyListState = rememberScalingLazyListState()

The scroll state for the dialog so that the scroll position can be displayed e.g. by the PositionIndicator passed to Scaffold.
backgroundColor: Color = MaterialTheme.colors.background

Color representing the background color for the dialog.
contentColor: Color = contentColorFor(backgroundColor)

Color representing the color for content.
titleColor: Color = contentColor

Color representing the color for title.
iconColor: Color = contentColor

Icon Color that defaults to contentColor, unless specifically overridden.
verticalArrangement: Arrangement.Vertical = DialogDefaults.AlertVerticalArrangement

The vertical arrangement of the dialog's children. This allows us to add spacing between items and specify the arrangement of the items when we have not enough of them to fill the whole minimum size.
contentPadding: PaddingValues = DialogDefaults.ContentPadding

The padding to apply around the whole of the dialog's contents.
content: (@Composable ColumnScope.() -> Unit)? = null

A slot for additional content, expected to be 2-3 lines of text.