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

    Interface SearchFieldHandle

    Imperative handle returned by searchField.

    interface SearchFieldHandle {
        clear(): boolean;
        focus(): void;
        query(): string;
        setQuery(query: string): boolean;
        submit(): boolean;
        element: TextboxElement;
        destroy(): void;
        setData(data: SearchFieldData): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    element: TextboxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Sets an enabled query and reports whether editing occurred.

      Parameters

      • query: string

      Returns boolean