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

    Interface RenderHelpOverlayOptions<TItem>

    Options accepted by renderHelpOverlay.

    interface RenderHelpOverlayOptions<
        TItem extends KeymapHelpItem = KeymapHelpItem,
    > {
        characters?: HelpOverlayCharacters;
        emptyText?: string;
        height: number;
        noResultsText?: string;
        query?: string;
        sections: readonly HelpOverlaySection<TItem>[];
        title?: string;
        width: number;
    }

    Type Parameters

    Index

    Properties

    characters? emptyText? height noResultsText? query? sections title? width

    Properties

    characters?: HelpOverlayCharacters

    Character tokens used by the renderer.

    emptyText?: string

    Text returned when no shortcuts are provided.

    'No shortcuts'

    height: number

    Maximum rendered height.

    noResultsText?: string

    Text returned when filtering has no matches.

    'No matching shortcuts'

    query?: string

    Search query matched against ids, descriptions, and key chords.

    ''

    sections: readonly HelpOverlaySection<TItem>[]

    Ordered shortcut sections.

    title?: string

    Visible title.

    'Keyboard shortcuts'

    width: number

    Maximum terminal-cell width of each line.

    Settings

    Member Visibility

    On This Page

    Properties