Package-level declarations

Types

Link copied to clipboard
class BasicAlertDialogOverlay<Model : Any, Result : Any>(model: Model, onDismissRequest: () -> Result, properties: DialogProperties = DialogProperties(), content: @Composable (Model, OverlayNavigator<Result>) -> Unit) : Overlay<Result>

An overlay that shows an basic AlertDialog.

Link copied to clipboard
class BasicDialogOverlay<Model : Any, Result : Any>(model: Model, onDismissRequest: () -> Result, properties: DialogProperties = DialogProperties(), content: @Composable (Model, OverlayNavigator<Result>) -> Unit) : Overlay<Result>

An overlay that shows a Dialog.

Link copied to clipboard

An Overlay that shows a ModalBottomSheet with the given model and content. When the sheet is dismissed, it emits a Result type to the OverlayNavigator. This is useful for showing temporary content in a sheet that you want to return back to the calling UI, such as a picker UI or user input prompt.

Link copied to clipboard

An enum representing the possible results of an alertDialogOverlay.

Link copied to clipboard
typealias OnClick = () -> Unit

Functions

Link copied to clipboard
fun alertDialogOverlay(confirmButton: @Composable (OnClick) -> Unit, icon: @Composable () -> Unit? = null, title: @Composable () -> Unit? = null, text: @Composable () -> Unit? = null, dismissButton: @Composable (OnClick) -> Unit?, properties: DialogProperties = DialogProperties()): BasicAlertDialogOverlay<*, DialogResult>

An overlay that shows an AlertDialog with configurable inputs.

Link copied to clipboard
actual suspend fun OverlayHost.showFullScreenOverlay(screen: Screen): PopResult?
expect suspend fun OverlayHost.showFullScreenOverlay(screen: Screen): PopResult?

Shows a full screen overlay with the given screen. As the name suggests, this overlay takes over the entire available screen space available to the current OverlayHost.

actual suspend fun OverlayHost.showFullScreenOverlay(screen: Screen): PopResult?
actual suspend fun OverlayHost.showFullScreenOverlay(screen: Screen): PopResult?
actual suspend fun OverlayHost.showFullScreenOverlay(screen: Screen): PopResult?
actual suspend fun OverlayHost.showFullScreenOverlay(screen: Screen): PopResult?