Compose Component

Dialog

Dialog displays a full-screen dialog, layered over any other content.

Dialog

Source set: Android

Added in 1.7.0-alpha01

@Composable
public fun Dialog(
    showDialog: Boolean,
    onDismissRequest: () -> Unit,
    modifier: Modifier = Modifier,
    scrollState: ScalingLazyListState? = rememberScalingLazyListState(),
    properties: DialogProperties = DialogProperties(),
    content: @Composable () -> Unit,
)

Parameters
showDialog Controls whether to display the Dialog. Set to true initially to trigger an 'intro' animation and display the Dialog. Subsequently, setting to false triggers an 'outro' animation, then Dialog hides itself.
onDismissRequest Executes when the user dismisses the dialog. Must remove the dialog from the composition.
modifier Modifier to be applied to the dialog.
scrollState The scroll state for the dialog so that the scroll position can be displayed.
properties Typically platform specific properties to further configure the dialog.
content Slot for dialog content such as Alert or Confirmation.

Dialog

Deprecated

This overload is provided for backwards compatibility with Compose for Wear OS 1.1.A newer overload is available which uses ScalingLazyListState from wear.compose.foundation.lazy package

Source set: Android

Added in 1.7.0-alpha01

Deprecated in 1.7.0-alpha01

@Composable
public fun Dialog(
    showDialog: Boolean,
    onDismissRequest: () -> Unit,
    modifier: Modifier = Modifier,
    scrollState: androidx.wear.compose.material.ScalingLazyListState? =
        androidx.wear.compose.material.rememberScalingLazyListState(),
    properties: DialogProperties = DialogProperties(),
    content: @Composable () -> Unit,
)

Parameters
showDialog Controls whether to display the Dialog. Set to true initially to trigger an 'intro' animation and display the Dialog. Subsequently, setting to false triggers an 'outro' animation, then Dialog hides itself.
onDismissRequest Executes when the user dismisses the dialog. Must remove the dialog from the composition.
modifier Modifier to be applied to the dialog.
scrollState The scroll state for the dialog so that the scroll position can be displayed.
properties Typically platform specific properties to further configure the dialog.
content Slot for dialog content such as Alert or Confirmation.

Last updated: