blessed-components - v1.20.0
    Preparing search index...

    Interface LoadingOverlayHandle

    Imperative handle returned by loadingOverlay.

    interface LoadingOverlayHandle {
        running: boolean;
        isOpen: boolean;
        blocked(): boolean;
        close(): boolean;
        focus(): void;
        open(): boolean;
        start(): void;
        stop(): void;
        tick(): void;
        toggle(): boolean;
        element: BoxElement;
        destroy(): void;
        setData(data: LoadingOverlayData): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    running: boolean

    Whether LoadingOverlay currently owns an active interval timer.

    isOpen: boolean

    Current controlled or uncontrolled open state.

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods