SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface ShowWindowOptions<T, C>

    interface ShowWindowOptions<T = any, C = any> {
        autoFocus?: string | boolean | FocusWindowOptions;
        context?: () => C;
        disableAutoDestroy?: boolean;
        initialValue?: T;
        isModal?: boolean;
        onKeyDown?: (e: KeyboardEvent) => void;
        prewarm?: boolean;
    }

    Type Parameters

    • T = any
    • C = any

    Hierarchy (View Summary)

    Index
    autoFocus? context? disableAutoDestroy? initialValue? isModal? onKeyDown? prewarm?
    autoFocus?: string | boolean | FocusWindowOptions

    Query selector for the element to focus on show.

    context?: () => C
    disableAutoDestroy?: boolean

    If true the window will not be automatically destroyed when closed.

    initialValue?: T

    A value the window can use to display.

    isModal?: boolean

    If true show a backdrop.

    Our movable menu achieves modality without a background by listens to global clicks (and focus)

    false
    onKeyDown?: (e: KeyboardEvent) => void

    Allow for tracking of key down events.

    Type Declaration

      • (e: KeyboardEvent): void

      • Parameters

        • e: KeyboardEvent

        Returns void

    prewarm?: boolean

    Mount the window hidden (do not reveal it) so a later real open is an instant reuse. Implies disableAutoDestroy (a prewarmed window must be kept alive). Use at idle to move the heavy first-mount cost off the user's open. A no-op if an instance already exists.

    false

    Settings
    Member Visibility

    On This Page
    Properties