circuitx/overlays/com.slack.circuitx.overlays

Package-level declarations

Types

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.

BasicDialogOverlay

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.

BottomSheetOverlay

class BottomSheetOverlay<Model : Any, Result : Any> : Overlay<Result>

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.

DialogResult

enum DialogResult : Enum<DialogResult>

An enum representing the possible results of an alertDialogOverlay.

OnClick

typealias OnClick = () -> Unit

Functions

alertDialogOverlay

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.

showFullScreenOverlay

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