Optional
autocompletePreact autocomplete main component
Optional
autocompleteMinimal input length to render autocomplete
@default: 2
Optional
autocompleteDefault autocomplete query parameters.
Optional
categoryCategory root component
Optional
categoryCSS selector for category content rendering
Optional
categoryEnable category fallback when service is unavailable (overwrites global fallback
option).
By default it will redirect to original page by disabling new page. If custom function is provided, it will be called with query object.
It's important that this path does not have same path as search page.
categoryFallback: (query) => {
location.replace(`/categories/${query.products.categoryId}`)
}
Optional
categoryreturns current category id, now is used for backward compatibility with categoryQuery
Optional
categoryreturns current category path, now is used for backward compatibility with categoryQuery
Indicates if URL parameters should be compressed
false
Optional
contentCSS selector for search page rendering.
Optional
debounceDebounce delay for search input
Merchant's default Currency.
Optional
dropdownCSS selector for autocomplete dropdown render. Leave undefined for default use (After input element)
Optional
fallbackEnabled fallback for serp & category pages when service is unavailable By default it will redirect to original pages by disabling new pages
@default: false
CSS selector for form to unbind it.
Optional
formForm unbind delay after how long it should delay, default is unbinding without delay ms
Optional
historyHistory component
Optional
historyIndicates if history should be enabled
true
Optional
historyHistory size
5
CSS selector for each input element to bind search events like input change and form submit.
Optional
isDetermine if current page is category Example: return location.pathname.includes('category')
Merchant ID.
Optional
serpPreact search page main component.
Optional
serpEnable search fallback when service is unavailable (overwrites global fallback
option).
By default it will redirect to original page by disabling new page. If custom function is provided, it will be called with query object.
It's important that this path does not have same path as search page.
serpFallback: (query) => {
location.replace(`/search?q=${query.query}`)
}
Optional
serpSearch page path, renders in any page if not specified
Optional
serpIndicates if search should redirect to search page or just rewrite history
Optional
serpDefault search page query parameters.
Optional
serpFront end URL both ways mapping, to convert URL param values and keep the request keys { query: 'q' - will map query param to appear as q in URL product.filters: 'ff' - will map to ff.0.field.0: 'brand' and so on.. product.size: 'size' - will map to size: 24 }
Optional
categoryreturns configuration for category request and now is used for backward compatibility Example: return { products: { categoryId: 123456 }}
Generated using TypeDoc
User provided configuration