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

    Interface RenderSearchBarOptions

    Options accepted by renderSearchBar.

    interface RenderSearchBarOptions {
        activeTarget?: SearchBarTarget;
        characters?: SearchBarCharacters;
        disabled?: boolean;
        pad?: boolean;
        placeholder?: string;
        query?: string;
        resultCount?: number;
        scopeId?: string;
        scopes?: readonly SearchBarScope[];
        showSubmit?: boolean;
        width: number;
    }
    Index

    Properties

    activeTarget? characters? disabled? pad? placeholder? query? resultCount? scopeId? scopes? showSubmit? width

    Properties

    activeTarget?: SearchBarTarget

    Control currently selected for keyboard interaction.

    characters?: SearchBarCharacters

    Character tokens used by the renderer.

    disabled?: boolean

    Whether interaction is unavailable.

    pad?: boolean

    Whether output is padded to width.

    placeholder?: string

    Placeholder shown for an empty query.

    query?: string

    Current query.

    resultCount?: number

    Optional result metadata.

    scopeId?: string

    Current scope id.

    scopes?: readonly SearchBarScope[]

    Ordered search scopes.

    showSubmit?: boolean

    Whether a submit control is shown.

    true

    width: number

    Available terminal-cell width.

    Settings

    Member Visibility

    On This Page

    Properties