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

    Interface KeymapHelpHandle<TCommand>

    Shared imperative contract implemented by Blessed component adapters.

    Adapters own one element but never own the parent screen. Imperative data updates do not call screen.render(), which lets applications batch them before flushing the terminal. Interactive adapters may render after direct keyboard or mouse input so focus and selection feedback is immediately visible.

    interface KeymapHelpHandle<
        TCommand extends KeymapHelpCommand = KeymapHelpCommand,
    > {
        clearQuery(): string;
        focus(): void;
        query(): string;
        setQuery(query: string): string;
        element: BoxElement;
        destroy(): void;
        setData(data: KeymapHelpData): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods