SearchProvider should be used as a wrapper for the entire application to provide a way to share application state between hooks, for example, the current query, active filters or the search response.
It must wrap any components where you are using hooks, usually this is done in an
index file. You must also specify the pipeline you wish to query.
- Replace the placeholders with your account and collection IDs from the collection crendentials section in the console.
- Replace the pipeline name placeholder with the pipeline you'd like to use to query.
syncURLState prop to synchronize the state of your search UI with the browser URL. By default, it works out of the box for syncing the state of
resultsPerPage while providing a support for external params.
It is recommended that you only need to use
SearchProvider once at the root of your application, if you find the need to use multiple collections then having multiple
SearchProviders would be okay too. You shouldn't nest
SearchProviders because each provider will create a separate new context which makes components beneath it (
Sorting) not behaving as they should.
|A pipeline configuration for search requests.|
|A pipeline configuration for autocomplete and typeahead requests. This is optional, by default we'll use an |
|Whether to search on initial load. Note: if you're also calling the |
|An initial search response in JSON format, useful for server-side rendering.|
|A default filter to apply to all search requests.|
|false||Allow to synchronize the state of your search UI with the browser URL.|
|Config which pipeline to use for search queries.|
|A simple key -> value pair object used for every search request. It includes critical data such as the query, results per page, current page, etc.|
|Define mapping between key/value pair params to be sent with each and every request.|
|A configuration is used to map fields in your data to the required fields to display in the UI.|
|A list of filters is used to navigate and find relevant results.|
|500||The delay time to synchronize the param to URL|
|false||The extend params to be synchronized with the URL query params|
|The names of the URL query params|
|Key of the param|
|Callback when the URL param changes|
|Default value of the param|
|Current value of the param|
|'q'||The name of the search query URL param|
|'show'||The name of the total results per page URL param|
|'page'||The name of the current page URL param|
|'sort'||The name of the sort URL param|