circuit-overlay/com.slack.circuit.overlay

Package-level declarations

Types

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.

OverlayHost

@Stable

interface OverlayHost

An OverlayHost can be used overlaysOverlay with content on top of other content. This is useful for one-off request/result flows such as:

OverlayHostData

@Stable

interface OverlayHostData<Result : Any>

Data managed by an OverlayHost to track the current overlay state. This should rarely be implemented by consumers!

OverlayNavigator

@Stable

fun interface OverlayNavigator<Result : Any>

An OverlayNavigator is a simple API offered to overlays to call finish with a result when they are done.

Properties

LocalOverlayHost

val LocalOverlayHost: ProvidableCompositionLocal<OverlayHost>

A ProvidableCompositionLocal to expose the current OverlayHost in the composition tree.

Functions

ContentWithOverlays

@Composable

fun ContentWithOverlays(modifier: Modifier = Modifier, overlayHost: OverlayHost = rememberOverlayHost(), content: @Composable () -> Unit)

Renders the given content with the ability to show overlays on top of it. This works by exposing an OverlayHost via LocalOverlayHost.

rememberOverlayHost

@Composable

fun rememberOverlayHost(): OverlayHost

Returns a remembered an OverlayHost that can be used to show overlays.