Skip to content

//workflow/com.squareup.workflow1.ui.container/Overlay

Overlay

[jvm] @WorkflowUiExperimentalApi()

interface Overlay

Marker interface implemented by window-like renderings that map to a layer above a base Screen.

Note that an Overlay is not necessarily a modal window, though that is how they are used in BodyAndModalsScreen. An Overlay can be any part of the UI that visually floats in a layer above the main UI, or above other Overlays. Possible examples include alerts, drawers, and tooltips.

Whether or not an Overlay’s presence indicates that events are blocked from lower layers is a separate concern.

Inheritors

Name
AndroidOverlay
AlertOverlay
ScreenOverlay