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

    Interface SearchFieldData

    Stateful data accepted by the Blessed searchField adapter.

    interface SearchFieldData {
        characters?: SearchFieldCharacters;
        defaultQuery?: string;
        disabled?: boolean;
        error?: string;
        hint?: string;
        label: string;
        onClear?: () => void;
        onQueryChange?: (query: string) => void;
        onSubmit?: (query: string) => void;
        placeholder?: string;
        query?: string;
        required?: boolean;
    }
    Index

    Properties

    characters? defaultQuery? disabled? error? hint? label onClear? onQueryChange? onSubmit? placeholder? query? required?

    Properties

    characters?: SearchFieldCharacters

    Character tokens used by the pure renderer.

    defaultQuery?: string

    Initial query for uncontrolled usage.

    disabled?: boolean

    Whether focus and editing are unavailable.

    error?: string

    Error text. When present it takes precedence over hint.

    hint?: string

    Hint text shown when no error is present.

    label: string

    Field label.

    onClear?: () => void

    Called after a clear request is accepted.

    onQueryChange?: (query: string) => void

    Called after user or imperative edits request a query change.

    onSubmit?: (query: string) => void

    Called when the user or imperative API requests a submitted query.

    placeholder?: string

    Placeholder shown when query is empty.

    query?: string

    Controlled query text.

    required?: boolean

    Whether the label should include a required indicator.

    Settings

    Member Visibility

    On This Page

    Properties