Interface ResultListState

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

interface ResultListState {
    firstSearchExecuted: boolean;
    hasError: boolean;
    hasResults: boolean;
    isLoading: boolean;
    moreResultsAvailable: boolean;
    results: Result[];
    searchResponseId: string;
}

Properties

firstSearchExecuted: boolean

Determines if a first search has been executed.

hasError: boolean

true if there is an error for the last executed query and false otherwise.

hasResults: boolean

Determines if there are results available for the last executed query.

isLoading: boolean

Determines if a search is in progress.

moreResultsAvailable: boolean

Whether more results are available, using the same parameters as the last successful query.

This property is not compatible with the Pager controller.

results: Result[]

The results of the last executed search.

searchResponseId: string

The unique identifier of the response where the results were fetched, this value does not change when loading more results.