Interface OverlayInput

Input used to open one overlay layer.

interface OverlayInput {
    dismissOnEscape?: boolean;
    id: string;
    modal?: boolean;
    restoreFocusId?: string;
}

Properties

dismissOnEscape?: boolean

Whether Escape may dismiss this overlay when it is the top layer.

true

id: string

Stable overlay identifier.

modal?: boolean

Whether this layer blocks interaction with all layers below it.

false

restoreFocusId?: string

Focus identifier restored after the overlay closes.