circuit-overlay/com.slack.circuit.overlay/OverlayHostData

OverlayHostData

@Stable
interface OverlayHostData<Result : Any>(source)

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

Properties

Link copied to clipboard
abstract val overlay: Overlay<Result>

The Overlay that is currently being shown. Read-only.

Functions

Link copied to clipboard
abstract fun finish(result: Result)

Invoked to finish the current overlay with the given result. This should be called by wherever the OverlayHost is being managed.