Skip to main content
‹ Overlays
Types

Types

The types of overlays.

SectionOverlaysDraftDocumented, not reviewed yet: the API can change.

OverlayConfig​

Interface

How showOverlay shows a screen; its background is transparent. Touches outside its views reach the app under it.

interface OverlayConfig
MemberTypeDescription
blockTouchesboolean

Touches outside the overlay's views don't reach the app: a small overlay that still stops it.

optionsScreenOptionsInput<object>

Options of the screen for this show, over those of its definition.

Defined in src/api/commands/presentation.ts ↗