AlertDialogContent

Component in Wear Material 3 Compose

This [AlertDialogContent] overload provides the content for an [AlertDialog] with 2 buttons to confirm or dismiss an action. Prefer using [AlertDialog] directly, which provides built-in animations and a streamlined API. This composable may be used to provide the content for an alert dialog if custom animations are required.

Last updated: 2025-02-05 12:19

Installation

dependencies {
   implementation("androidx.wear.compose:compose-material3:1.0.0-alpha32")
}

Overloads

@Composable
fun AlertDialogContent(
    confirmButton: @Composable RowScope.() -> Unit,
    title: @Composable () -> Unit,
    dismissButton: @Composable RowScope.() -> Unit,
    modifier: Modifier = Modifier,
    icon: @Composable (() -> Unit)? = null,
    text: @Composable (() -> Unit)? = null,
    verticalArrangement: Arrangement.Vertical = AlertDialogDefaults.VerticalArrangement,
    contentPadding: PaddingValues = AlertDialogDefaults.confirmDismissContentPadding(),
    content: (ScalingLazyListScope.() -> Unit)? = null
)

Parameters

name	description
confirmButton	A slot for a [Button] indicating positive sentiment. Clicking the button must remove the dialog from the composition hierarchy. It's recommended to use [AlertDialogDefaults.ConfirmButton] in this slot with onClick callback.
title	A slot for displaying the title of the dialog. Title should contain a summary of the dialog's purpose or content and should not exceed 3 lines of text. By default, [TextOverflow.Ellipsis] will be applied when text exceeds 3 lines.
dismissButton	A slot for a [Button] indicating negative sentiment. Clicking the button must remove the dialog from the composition hierarchy. It's recommended to use [AlertDialogDefaults.DismissButton] in this slot with onClick callback.
modifier	Modifier to be applied to the dialog content.
icon	Optional slot for an icon to be shown at the top of the dialog.
text	Optional slot for displaying the message of the dialog below the title. Should contain additional text that presents further details about the dialog's purpose if the title is insufficient.
verticalArrangement	The vertical arrangement of the dialog's children. There is a default padding between icon, title, and text, which will be added to the spacing specified in this [verticalArrangement] parameter.
contentPadding	The padding to apply around the entire dialog's contents.
content	A slot for additional content, displayed within a scrollable [ScalingLazyColumn].

@Composable
fun AlertDialogContent(
    title: @Composable () -> Unit,
    modifier: Modifier = Modifier,
    icon: @Composable (() -> Unit)? = null,
    text: @Composable (() -> Unit)? = null,
    verticalArrangement: Arrangement.Vertical = AlertDialogDefaults.VerticalArrangement,
    contentPadding: PaddingValues = AlertDialogDefaults.contentPadding(),
    content: (ScalingLazyListScope.() -> Unit)? = null
)

Parameters

name	description
title	A slot for displaying the title of the dialog. Title should contain a summary of the dialog's purpose or content and should not exceed 3 lines of text. By default, [TextOverflow.Ellipsis] will be applied when text exceeds 3 lines.
modifier	Modifier to be applied to the dialog content.
icon	Optional slot for an icon to be shown at the top of the dialog.
text	Optional slot for displaying the message of the dialog below the title. Should contain additional text that presents further details about the dialog's purpose if the title is insufficient.
verticalArrangement	The vertical arrangement of the dialog's children. There is a default padding between icon, title, and text, which will be added to the spacing specified in this [verticalArrangement] parameter.
contentPadding	The padding to apply around the entire dialog's contents.
content	A slot for additional content, displayed within a scrollable [ScalingLazyColumn].

@Composable
fun AlertDialogContent(
    edgeButton: (@Composable BoxScope.() -> Unit),
    title: @Composable () -> Unit,
    modifier: Modifier = Modifier,
    icon: @Composable (() -> Unit)? = null,
    text: @Composable (() -> Unit)? = null,
    verticalArrangement: Arrangement.Vertical = AlertDialogDefaults.VerticalArrangement,
    contentPadding: PaddingValues = AlertDialogDefaults.contentPadding(),
    content: (ScalingLazyListScope.() -> Unit)? = null
)

Parameters

name	description
edgeButton	Slot for an [EdgeButton] indicating positive sentiment. Clicking the button must remove the dialog from the composition hierarchy. It's recommended to use [AlertDialogDefaults.EdgeButton] in this slot with onClick callback. Note that when using an [EdgeButton] which is not Medium size, the contentPadding parameters should be specified.
title	A slot for displaying the title of the dialog. Title should contain a summary of the dialog's purpose or content and should not exceed 3 lines of text. By default, [TextOverflow.Ellipsis] will be applied when text exceeds 3 lines.
modifier	Modifier to be applied to the dialog content.
icon	Optional slot for an icon to be shown at the top of the dialog.
text	Optional slot for displaying the message of the dialog below the title. Should contain additional text that presents further details about the dialog's purpose if the title is insufficient.
verticalArrangement	The vertical arrangement of the dialog's children. There is a default padding between icon, title, and text, which will be added to the spacing specified in this [verticalArrangement] parameter.
contentPadding	The padding to apply around the entire dialog's contents. Bottom padding will be ignored and default spacing for the [EdgeButton] will be used.
content	A slot for additional content, displayed within a scrollable [ScalingLazyColumn].