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

    Interface HelpOverlayData<TItem>

    Stateful data accepted by the Blessed helpOverlay adapter.

    interface HelpOverlayData<TItem extends KeymapHelpItem = KeymapHelpItem> {
        characters?: HelpOverlayCharacters;
        dismissOnEscape?: boolean;
        emptyText?: string;
        noResultsText?: string;
        onQueryChange?: (query: string) => void;
        query?: string;
        sections: readonly HelpOverlaySection<TItem>[];
        title?: string;
        defaultOpen?: boolean;
        onOpenChange?: (open: boolean) => void;
        open?: boolean;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    characters? dismissOnEscape? emptyText? noResultsText? onQueryChange? query? sections title? defaultOpen? onOpenChange? open?

    Properties

    characters?: HelpOverlayCharacters

    Character tokens used by the pure renderer.

    dismissOnEscape?: boolean

    Whether Escape requests closing.

    true

    emptyText?: string

    Text displayed when no shortcuts are provided.

    noResultsText?: string

    Text displayed when filtering has no matches.

    onQueryChange?: (query: string) => void

    Called after typing changes the search query.

    query?: string

    Controlled search query.

    sections: readonly HelpOverlaySection<TItem>[]

    Ordered shortcut sections.

    title?: string

    Visible title.

    defaultOpen?: boolean

    Initial state for uncontrolled usage.

    false

    onOpenChange?: (open: boolean) => void

    Called when Dialog requests an open-state change.

    open?: boolean

    Controlled open state.

    Settings

    Member Visibility

    On This Page

    Properties