circuit-overlay/com.slack.circuit.overlay/OverlayScope

OverlayScope

interface OverlayScope : OverlayHost, CoroutineScope(source)

Properties

Link copied to clipboard
Link copied to clipboard
abstract val currentOverlayData: OverlayHostData<Any>?

The current OverlayHostData or null if no overlay is currently showing.

Functions

Link copied to clipboard
abstract suspend fun <Result : Any> show(overlay: Overlay<Result>): Result

Shows the given overlay and suspends until the overlay is finished with a Result. The overlay should always signal a result (even if it's just something like Result.Dismissed) so that the OverlayHost can properly clear its currentOverlayData.