Interface OverlayStackModel

Headless ordered overlay and modal-layer state.

interface OverlayStackModel {
    close(id?: string): OverlayCloseResult | undefined;
    entries(): OverlayEntry[];
    handleEscape(): OverlayCloseResult | undefined;
    isBlocked(id: string): boolean;
    open(input: OverlayInput): OverlayEntry;
    top(): OverlayEntry | undefined;
}

Index

Methods

close entries handleEscape isBlocked open top

Methods

close

close(id?: string): OverlayCloseResult | undefined
Closes an overlay by id, or the top overlay when no id is supplied.
Parameters
- Optionalid: string
Returns OverlayCloseResult | undefined
- Defined in primitives/overlay/index.ts:61

entries

entries(): OverlayEntry[]
Returns an immutable bottom-to-top stack snapshot.

Returns OverlayEntry[]
- Defined in primitives/overlay/index.ts:64

handleEscape

handleEscape(): OverlayCloseResult | undefined
Handles Escape against only the top layer.

Returns OverlayCloseResult | undefined
- Defined in primitives/overlay/index.ts:67

isBlocked

isBlocked(id: string): boolean
Reports whether a modal layer above an overlay blocks interaction.
Parameters
- id: string
Returns boolean
- Defined in primitives/overlay/index.ts:70

open

open(input: OverlayInput): OverlayEntry
Opens a new top layer.
Parameters
- input: OverlayInput
Returns OverlayEntry
- Defined in primitives/overlay/index.ts:73

top

top(): OverlayEntry | undefined
Returns the current top layer.

Returns OverlayEntry | undefined
- Defined in primitives/overlay/index.ts:76