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

    Interface HelpOverlayHandle<TItem>

    Imperative handle returned by helpOverlay.

    interface HelpOverlayHandle<TItem extends KeymapHelpItem = KeymapHelpItem> {
        close(): boolean;
        focus(): void;
        isOpen(): boolean;
        open(): boolean;
        query(): string;
        setQuery(query: string): string;
        toggle(): boolean;
        element: BoxElement;
        destroy(): void;
        setData(data: HelpOverlayData): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods