Interface StandaloneSearchBoxState

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

interface StandaloneSearchBoxState {
    analytics: StandaloneSearchBoxAnalytics;
    isLoading: boolean;
    isLoadingSuggestions: boolean;
    redirectTo: string;
    searchBoxId: string;
    suggestions: Suggestion[];
    value: string;
}

Properties

The analytics data to send when performing the first query on the search page the user is redirected to.

isLoading: boolean

Determines if a search is in progress.

isLoadingSuggestions: boolean

Determines if a query suggest request is in progress.

redirectTo: string

The Url to redirect to.

searchBoxId: string

The search box ID.

suggestions: Suggestion[]

The query suggestions for the search box query.

value: string

The current query in the search box.