ISearchState
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
State of the search.
export interface ISearchState
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) The debounced search query. This is the query that is currently being used for the search. It may be different from the query if the user is still typing. | ||
string | (ALPHA) The current search query. This is the query that is currently being typed by the user. It may be different from the debouncedQuery if the user is still typing. | ||
“idle” | “searching” | “completed” | (ALPHA) The current state of the search. - idle - means the user has not typed anything yet - searching - means the user is currently typing - completed - means the user has stopped typing and the search is complete |
Property details
ISearchState.debouncedQuerypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The debounced search query. This is the query that is currently being used for the search. It may be different from the query if the user is still typing.
debouncedQuery: string;
ISearchState.querypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The current search query. This is the query that is currently being typed by the user. It may be different from the debouncedQuery if the user is still typing.
query: string;
ISearchState.statepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The current state of the search. - idle - means the user has not typed anything yet - searching - means the user is currently typing - completed - means the user has stopped typing and the search is complete
state: "idle" | "searching" | "completed";