Overlay

fun interface Overlay<Result : Any>(source)

An Overlay is composable content that can be shown on top of other content via an OverlayHost . Overlays are typically used for one-off request/result flows and should not usually attempt to do any sort of external navigation or make any assumptions about the state of the app. They should only emit a Result to the given OverlayNavigator when they are done.

For common overlays, it's useful to create a common Overlay subtype that can be reused. For example: BottomSheetOverlay, ModalOverlay, TooltipOverlay, etc.

Inheritors

Functions

Link copied to clipboard
abstract fun Content(navigator: OverlayNavigator<Result>)