Interface SearchBoxState

A scoped and simplified part of the headless state that is relevant to the SearchBox controller.

interface SearchBoxState {
    isLoading: boolean;
    isLoadingSuggestions: boolean;
    searchBoxId: string;
    suggestions: Suggestion[];
    value: string;
}

Hierarchy (View Summary)

SearchBoxState
- StandaloneSearchBoxState

Index

Properties

isLoading isLoadingSuggestions searchBoxId suggestions value

Properties

isLoading

isLoading: boolean

Determines if a search is in progress.

isLoadingSuggestions

isLoadingSuggestions: boolean

Determines if a query suggest request is in progress.

searchBoxId

searchBoxId: string

The search box ID.

suggestions

suggestions: Suggestion[]

The query suggestions for the search box query.

value

value: string

The current query in the search box.