Preparing search index...
The search index is not available
@coveo/headless-react
@coveo/headless-react
SSR Commerce
index
Module index
Engine
CommerceEngine
CommerceEngineOptions
ReactCommerceEngineDefinition
defineCommerceEngine
Providers
buildProviderWithDefinition
Definers
defineBreadcrumbManager
defineCart
defineContext
defineDidYouMean
defineFacetGenerator
defineFieldSuggestionsGenerator
defineInstantProducts
defineNotifyTrigger
definePagination
defineParameterManager
defineProductList
defineProductView
defineQueryTrigger
defineRecentQueriesList
defineRecommendations
defineRedirectionTrigger
defineSearchBox
defineSort
defineStandaloneSearchBox
defineSummary
Controllers - DidYouMean
DidYouMeanState
Controllers - NotifyTrigger
NotifyTrigger
NotifyTriggerState
Controllers - QueryTrigger
QueryTrigger
QueryTriggerState
Controllers - RedirectionTrigger
RedirectionTrigger
RedirectionTriggerState
Controllers - SearchBox
SearchBoxState
Buildable controllers - Cart
Cart
CartState
Buildable controllers - CategoryFieldSuggestions
CategoryFieldSuggestions
CategoryFieldSuggestionsState
Buildable controllers - Context
Context
ContextState
Buildable controllers - FieldSuggestions
FieldSuggestions
FieldSuggestionsState
Buildable controllers - FieldSuggestionsGenerator
FieldSuggestionsGenerator
Buildable controllers - InstantProducts
InstantProducts
InstantProductsState
Buildable controllers - ProductListing
ProductListing
ProductListState
Buildable controllers - RecentQueriesList
RecentQueriesList
RecentQueriesState
Buildable controllers - Recommendations
Recommendations
Buildable controllers - Search
Search
Buildable controllers - SearchBox
SearchBox
Buildable controllers - StandaloneSearchBox
StandaloneSearchBox
StandaloneSearchBoxState
Sub-controllers - BreadcrumbManager
BreadcrumbManagerState
Sub-controllers - CategoryFacet
CategoryFacet
CategoryFacetState
Sub-controllers - DateFacet
DateFacet
DateFacetState
Sub-controllers - DidYouMean
DidYouMean
Sub-controllers - NumericFacet
NumericFacet
NumericFacetState
Sub-controllers - Pagination
Pagination
PaginationState
Sub-controllers - ParameterManager
ParameterManager
ParameterManagerState
Sub-controllers - RegularFacet
RegularFacet
Sub-controllers - Sort
Sort
SortState
Actions - Cart
CartActionCreators
loadCartActions
Actions - CategoryFacet
CategoryFacetSetActionCreators
CoreFacetActionsCreators
loadCategoryFacetSetActions
loadCoreFacetActions
Actions - Configuration
ConfigurationActionCreators
loadConfigurationActions
Actions - Context
ContextActionCreators
loadContextActions
Actions - DateFacet
DateFacetActionCreators
loadDateFacetActions
Actions - InstantProducts
InstantProductsActionCreators
loadInstantProductsActions
Actions - NumericFacet
NumericFacetActionCreators
loadNumericFacetActions
Actions - Pagination
PaginationActionCreators
loadPaginationActions
Actions - Product
ProductActionCreators
loadProductActions
Actions - ProductListing
ProductListingActionCreators
loadProductListingActions
Actions - ProductListingParameters
ProductListingParametersActionCreators
loadProductListingParametersActions
Actions - Query
QueryActionCreators
loadQueryActions
Actions - QuerySet
QuerySetActionCreators
loadQuerySetActions
Actions - QuerySuggest
QuerySuggestActionCreators
loadQuerySuggestActions
Actions - RecentQueries
RecentQueriesActionCreators
loadRecentQueriesActions
Actions - Recommendations
RecommendationsActionCreator
loadRecommendationsActions
Actions - RegularFacet
RegularFacetActionCreators
loadRegularFacetActions
Actions - Search
SearchActionCreators
loadSearchActions
Actions - SearchParameters
SearchParametersActionCreators
loadSearchParametersActions
Actions - Sort
SortActionCreators
loadSortActions
Actions - StandaloneSearchBoxSet
StandaloneSearchBoxSetActionCreators
loadStandaloneSearchBoxSetActions
Actions - Triggers
TriggersActionCreators
loadTriggersActions
Classes
MissingEngineProviderError
Enumerations
Kind
SolutionType
SortBy
SortOrder
Functions
buildCriterionExpression
buildDateSortCriterion
buildFieldSortCriterion
buildNoSortCriterion
buildParameterSerializer
buildQueryExpression
buildQueryRankingExpressionSortCriterion
buildRelevanceSortCriterion
buildResultTemplatesManager
deserializeRelativeDate
getAnalyticsNextApiBaseUrl
getCommerceApiBaseUrl
getOrganizationEndpoint
getSampleCommerceEngineConfiguration
parseCriterionExpression
updateIgnoreQueryTrigger
validateRelativeDate
Interfaces
AnalyticsConfiguration
ApplyQueryTriggerModificationPayload
BaseFacetSearchResult
BaseProduct
BuildOptions
CartBuildProps
CartDefinition
CartInitialState
CartItem
CartProps
CategoryFacetSearchResult
CategoryFacetValue
CommerceEngineConfiguration
CommerceEngineDefinition
CommerceSearchParameters
ContextDefinition
ContextOptions
ContextProps
Controller
ControllerDefinitionsMap
ControllerWithKind
CoreInstantProductPayload
CoreSearchBox
DateFieldExpression
DateRangeFieldExpression
EngineConfiguration
EngineDefinition
EngineDefinitionBuildResult
EngineStaticState
ExactMatchExpression
ExternalEngineOptions
FacetGenerator
FetchRecommendationsPayload
FetchRedirectUrlPayload
FieldExistsExpression
FieldSuggestionsFacet
FieldSuggestionsGeneratorDefinition
FromBuildResult
FromBuildResultOptions
HighlightKeyword
HydratedState
HydrateStaticStateOptions
InstantProductsDefinition
InstantProductsOptions
InstantProductsProps
InteractiveProduct
InteractiveProductOptions
KeywordExpression
LocationFacetValue
LoggerOptions
Middleware
NavigatorContext
NearExpression
Negatable
NotifyTriggerDefinition
NumericFieldExpression
NumericRangeFieldExpression
OtherTerm
PaginationProps
ParameterManagerProps
Parameters
Product
ProductListingSummaryState
ProductTemplatesManager
ProductView
PromoteChildToParentPayload
QueryExpression
QueryExtensionExpression
QueryTriggerDefinition
RecentQueriesListDefinition
RecentQueriesListInitialState
RecentQueriesListOptions
RecentQueriesListProps
RecommendationsDefinition
RecommendationsState
RecommendationsSummaryState
RedirectionTriggerDefinition
RegisterRecentQueriesCreatorPayload
RegisterStandaloneSearchBoxPayload
RegularFacetValue
RelativeDate
Relay
ResetStandaloneSearchBoxPayload
SearchBoxDefinition
SearchBoxProps
SearchSummaryState
SetContextPayload
SortProps
SSRParameterManagerProps
StandaloneSearchBoxDefinition
StandaloneSearchBoxProps
StringFacetFieldExpression
StringFieldExpression
Subscribable
Suggestion
Summary
SummaryState
Template
ToggleSelectNumericFacetValuePayload
Unsubscribe
UpdateInstantProductQueryPayload
UpdateNumericFacetValuesPayload
UpdateQueryPayload
UserLocation
View
Type Aliases
AnalyticsRuntimeEnvironment
ApplySortPayload
BreadcrumbManager
BrowserNavigatorContextProvider
Build
CartActionPayload
ChildProduct
ClearExpiredInstantProductsPayload
ClearQuerySuggestPayload
CommerceAppState
CommerceEngineDefinitionOptions
CommerceProductListingParametersState
CommerceSearchParametersState
ControllerDefinition
CoreEngineNext
DateFacetValue
DeselectAllValuesInCoreFacetPayload
EngineDefinitionControllersPropsOption
FacetGeneratorState
FacetType
FetchMoreRecommendationsPayload
FetchQuerySuggestionsPayload
FetchStaticState
FetchStaticStateOptions
GeneratedFieldSuggestionsControllers
HydrateStaticState
InferBuildResult
InferControllerFromDefinition
InferControllerPropsMapFromDefinitions
InferControllersMapFromDefinition
InferControllerStaticStateFromController
InferControllerStaticStateMapFromControllers
InferControllerStaticStateMapFromDefinitionsWithSolutionType
InferHydratedState
InferStaticState
InteractiveProductProps
LocationFacetState
LogLevel
MappedFacetState
MappedFacetStates
MappedGeneratedFacetController
NavigatorContextProvider
NextPagePayload
NumericFacetValue
OptionsTuple
PlatformEnvironment
PrepareForSearchWithQueryPayload
PreviousPagePayload
ProductClickPayload
ProductList
ProductListingParameters
ProductTemplate
ProductTemplateCondition
ProductViewPayload
PurchasePayload
ReactEngineDefinition
RegisterInstantProductPayload
RegisterQuerySetQueryPayload
RegisterQuerySuggestPayload
RegisterRecommendationsSlotPaginationPayload
RegisterRecommendationsSlotPayload
RegularFacetState
RelativeDatePeriod
RelativeDateUnit
RestoreProductListingParametersPayload
RestoreSearchParametersPayload
SearchBoxOptions
SelectPagePayload
SelectQuerySuggestionPayload
SetItemsPayload
SetLocationPayload
SetPageSizePayload
SetViewPayload
SortByDate
SortByField
SortByNoSort
SortByQRE
SortByRelevancy
SortCriterion
ToggleExcludeDateFacetValuePayload
ToggleExcludeFacetValuePayload
ToggleExcludeNumericFacetValuePayload
ToggleSelectCategoryFacetValuePayload
ToggleSelectDateFacetValuePayload
ToggleSelectFacetValuePayload
UpdateAnalyticsConfigurationPayload
UpdateAutoSelectionForAllCoreFacetsPayload
UpdateBasicConfigurationPayload
UpdateCategoryFacetNumberOfValuesPayload
UpdateCoreFacetFreezeCurrentValuesPayload
UpdateCoreFacetIsFieldExpandedPayload
UpdateCoreFacetNumberOfValuesPayload
UpdateDateFacetValuesPayload
UpdateIgnoreQueryTriggerPayload
UpdateItemQuantityPayload
UpdateQuerySetQueryPayload
Variables
ProductTemplatesHelpers
VERSION
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Engine
Commerce
Engine
Commerce
Engine
Options
React
Commerce
Engine
Definition
define
Commerce
Engine
Providers
build
Provider
With
Definition
Definers
define
Breadcrumb
Manager
define
Cart
define
Context
define
Did
You
Mean
define
Facet
Generator
define
Field
Suggestions
Generator
define
Instant
Products
define
Notify
Trigger
define
Pagination
define
Parameter
Manager
define
Product
List
define
Product
View
define
Query
Trigger
define
Recent
Queries
List
define
Recommendations
define
Redirection
Trigger
define
Search
Box
define
Sort
define
Standalone
Search
Box
define
Summary
Controllers - DidYouMean
Did
You
Mean
State
Controllers - NotifyTrigger
Notify
Trigger
Notify
Trigger
State
Controllers - QueryTrigger
Query
Trigger
Query
Trigger
State
Controllers - RedirectionTrigger
Redirection
Trigger
Redirection
Trigger
State
Controllers - SearchBox
Search
Box
State
Buildable controllers - Cart
Cart
Cart
State
Buildable controllers - CategoryFieldSuggestions
Category
Field
Suggestions
Category
Field
Suggestions
State
Buildable controllers - Context
Context
Context
State
Buildable controllers - FieldSuggestions
Field
Suggestions
Field
Suggestions
State
Buildable controllers - FieldSuggestionsGenerator
Field
Suggestions
Generator
Buildable controllers - InstantProducts
Instant
Products
Instant
Products
State
Buildable controllers - ProductListing
Product
Listing
Product
List
State
Buildable controllers - RecentQueriesList
Recent
Queries
List
Recent
Queries
State
Buildable controllers - Recommendations
Recommendations
Buildable controllers - Search
Search
Buildable controllers - SearchBox
Search
Box
Buildable controllers - StandaloneSearchBox
Standalone
Search
Box
Standalone
Search
Box
State
Sub-controllers - BreadcrumbManager
Breadcrumb
Manager
State
Sub-controllers - CategoryFacet
Category
Facet
Category
Facet
State
Sub-controllers - DateFacet
Date
Facet
Date
Facet
State
Sub-controllers - DidYouMean
Did
You
Mean
Sub-controllers - NumericFacet
Numeric
Facet
Numeric
Facet
State
Sub-controllers - Pagination
Pagination
Pagination
State
Sub-controllers - ParameterManager
Parameter
Manager
Parameter
Manager
State
Sub-controllers - RegularFacet
Regular
Facet
Sub-controllers - Sort
Sort
Sort
State
Actions - Cart
Cart
Action
Creators
load
Cart
Actions
Actions - CategoryFacet
Category
Facet
Set
Action
Creators
Core
Facet
Actions
Creators
load
Category
Facet
Set
Actions
load
Core
Facet
Actions
Actions - Configuration
Configuration
Action
Creators
load
Configuration
Actions
Actions - Context
Context
Action
Creators
load
Context
Actions
Actions - DateFacet
Date
Facet
Action
Creators
load
Date
Facet
Actions
Actions - InstantProducts
Instant
Products
Action
Creators
load
Instant
Products
Actions
Actions - NumericFacet
Numeric
Facet
Action
Creators
load
Numeric
Facet
Actions
Actions - Pagination
Pagination
Action
Creators
load
Pagination
Actions
Actions - Product
Product
Action
Creators
load
Product
Actions
Actions - ProductListing
Product
Listing
Action
Creators
load
Product
Listing
Actions
Actions - ProductListingParameters
Product
Listing
Parameters
Action
Creators
load
Product
Listing
Parameters
Actions
Actions - Query
Query
Action
Creators
load
Query
Actions
Actions - QuerySet
Query
Set
Action
Creators
load
Query
Set
Actions
Actions - QuerySuggest
Query
Suggest
Action
Creators
load
Query
Suggest
Actions
Actions - RecentQueries
Recent
Queries
Action
Creators
load
Recent
Queries
Actions
Actions - Recommendations
Recommendations
Action
Creator
load
Recommendations
Actions
Actions - RegularFacet
Regular
Facet
Action
Creators
load
Regular
Facet
Actions
Actions - Search
Search
Action
Creators
load
Search
Actions
Actions - SearchParameters
Search
Parameters
Action
Creators
load
Search
Parameters
Actions
Actions - Sort
Sort
Action
Creators
load
Sort
Actions
Actions - StandaloneSearchBoxSet
Standalone
Search
Box
Set
Action
Creators
load
Standalone
Search
Box
Set
Actions
Actions - Triggers
Triggers
Action
Creators
load
Triggers
Actions
Classes
Missing
Engine
Provider
Error
Enumerations
Kind
Solution
Type
Sort
By
Sort
Order
Functions
build
Criterion
Expression
build
Date
Sort
Criterion
build
Field
Sort
Criterion
build
No
Sort
Criterion
build
Parameter
Serializer
build
Query
Expression
build
Query
Ranking
Expression
Sort
Criterion
build
Relevance
Sort
Criterion
build
Result
Templates
Manager
deserialize
Relative
Date
get
Analytics
Next
Api
Base
Url
get
Commerce
Api
Base
Url
get
Organization
Endpoint
get
Sample
Commerce
Engine
Configuration
parse
Criterion
Expression
update
Ignore
Query
Trigger
validate
Relative
Date
Interfaces
Analytics
Configuration
Apply
Query
Trigger
Modification
Payload
Base
Facet
Search
Result
Base
Product
Build
Options
Cart
Build
Props
Cart
Definition
Cart
Initial
State
Cart
Item
Cart
Props
Category
Facet
Search
Result
Category
Facet
Value
Commerce
Engine
Configuration
Commerce
Engine
Definition
Commerce
Search
Parameters
Context
Definition
Context
Options
Context
Props
Controller
Controller
Definitions
Map
Controller
With
Kind
Core
Instant
Product
Payload
Core
Search
Box
Date
Field
Expression
Date
Range
Field
Expression
Engine
Configuration
Engine
Definition
Engine
Definition
Build
Result
Engine
Static
State
Exact
Match
Expression
External
Engine
Options
Facet
Generator
Fetch
Recommendations
Payload
Fetch
Redirect
Url
Payload
Field
Exists
Expression
Field
Suggestions
Facet
Field
Suggestions
Generator
Definition
From
Build
Result
From
Build
Result
Options
Highlight
Keyword
Hydrated
State
Hydrate
Static
State
Options
Instant
Products
Definition
Instant
Products
Options
Instant
Products
Props
Interactive
Product
Interactive
Product
Options
Keyword
Expression
Location
Facet
Value
Logger
Options
Middleware
Navigator
Context
Near
Expression
Negatable
Notify
Trigger
Definition
Numeric
Field
Expression
Numeric
Range
Field
Expression
Other
Term
Pagination
Props
Parameter
Manager
Props
Parameters
Product
Product
Listing
Summary
State
Product
Templates
Manager
Product
View
Promote
Child
To
Parent
Payload
Query
Expression
Query
Extension
Expression
Query
Trigger
Definition
Recent
Queries
List
Definition
Recent
Queries
List
Initial
State
Recent
Queries
List
Options
Recent
Queries
List
Props
Recommendations
Definition
Recommendations
State
Recommendations
Summary
State
Redirection
Trigger
Definition
Register
Recent
Queries
Creator
Payload
Register
Standalone
Search
Box
Payload
Regular
Facet
Value
Relative
Date
Relay
Reset
Standalone
Search
Box
Payload
Search
Box
Definition
Search
Box
Props
Search
Summary
State
Set
Context
Payload
Sort
Props
SSRParameter
Manager
Props
Standalone
Search
Box
Definition
Standalone
Search
Box
Props
String
Facet
Field
Expression
String
Field
Expression
Subscribable
Suggestion
Summary
Summary
State
Template
Toggle
Select
Numeric
Facet
Value
Payload
Unsubscribe
Update
Instant
Product
Query
Payload
Update
Numeric
Facet
Values
Payload
Update
Query
Payload
User
Location
View
Type Aliases
Analytics
Runtime
Environment
Apply
Sort
Payload
Breadcrumb
Manager
Browser
Navigator
Context
Provider
Build
Cart
Action
Payload
Child
Product
Clear
Expired
Instant
Products
Payload
Clear
Query
Suggest
Payload
Commerce
App
State
Commerce
Engine
Definition
Options
Commerce
Product
Listing
Parameters
State
Commerce
Search
Parameters
State
Controller
Definition
Core
Engine
Next
Date
Facet
Value
Deselect
All
Values
In
Core
Facet
Payload
Engine
Definition
Controllers
Props
Option
Facet
Generator
State
Facet
Type
Fetch
More
Recommendations
Payload
Fetch
Query
Suggestions
Payload
Fetch
Static
State
Fetch
Static
State
Options
Generated
Field
Suggestions
Controllers
Hydrate
Static
State
Infer
Build
Result
Infer
Controller
From
Definition
Infer
Controller
Props
Map
From
Definitions
Infer
Controllers
Map
From
Definition
Infer
Controller
Static
State
From
Controller
Infer
Controller
Static
State
Map
From
Controllers
Infer
Controller
Static
State
Map
From
Definitions
With
Solution
Type
Infer
Hydrated
State
Infer
Static
State
Interactive
Product
Props
Location
Facet
State
Log
Level
Mapped
Facet
State
Mapped
Facet
States
Mapped
Generated
Facet
Controller
Navigator
Context
Provider
Next
Page
Payload
Numeric
Facet
Value
Options
Tuple
Platform
Environment
Prepare
For
Search
With
Query
Payload
Previous
Page
Payload
Product
Click
Payload
Product
List
Product
Listing
Parameters
Product
Template
Product
Template
Condition
Product
View
Payload
Purchase
Payload
React
Engine
Definition
Register
Instant
Product
Payload
Register
Query
Set
Query
Payload
Register
Query
Suggest
Payload
Register
Recommendations
Slot
Pagination
Payload
Register
Recommendations
Slot
Payload
Regular
Facet
State
Relative
Date
Period
Relative
Date
Unit
Restore
Product
Listing
Parameters
Payload
Restore
Search
Parameters
Payload
Search
Box
Options
Select
Page
Payload
Select
Query
Suggestion
Payload
Set
Items
Payload
Set
Location
Payload
Set
Page
Size
Payload
Set
View
Payload
Sort
By
Date
Sort
By
Field
Sort
By
No
Sort
Sort
ByQRE
Sort
By
Relevancy
Sort
Criterion
Toggle
Exclude
Date
Facet
Value
Payload
Toggle
Exclude
Facet
Value
Payload
Toggle
Exclude
Numeric
Facet
Value
Payload
Toggle
Select
Category
Facet
Value
Payload
Toggle
Select
Date
Facet
Value
Payload
Toggle
Select
Facet
Value
Payload
Update
Analytics
Configuration
Payload
Update
Auto
Selection
For
All
Core
Facets
Payload
Update
Basic
Configuration
Payload
Update
Category
Facet
Number
Of
Values
Payload
Update
Core
Facet
Freeze
Current
Values
Payload
Update
Core
Facet
Is
Field
Expanded
Payload
Update
Core
Facet
Number
Of
Values
Payload
Update
Date
Facet
Values
Payload
Update
Ignore
Query
Trigger
Payload
Update
Item
Quantity
Payload
Update
Query
Set
Query
Payload
Variables
Product
Templates
Helpers
VERSION
@coveo/headless-react
Loading...