@coveo/headless-react
    Preparing search index...

    Module index

    Engine

    CommerceEngine
    CommerceEngineOptions
    ReactCommerceEngineDefinition
    defineCommerceEngine

    Providers

    buildProviderWithDefinition

    Definers

    defineBreadcrumbManager
    defineCart
    defineContext
    defineDidYouMean
    defineFacetGenerator
    defineFilterSuggestionsGenerator
    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 - CategoryFilterSuggestions

    CategoryFilterSuggestions
    CategoryFilterSuggestionsState

    Buildable controllers - Context

    Context
    ContextState

    Buildable controllers - FilterSuggestions

    FilterSuggestions
    FilterSuggestionsState

    Buildable controllers - FilterSuggestionsGenerator

    FilterSuggestionsGenerator

    Buildable controllers - InstantProducts

    InstantProducts
    InstantProductsState

    Buildable controllers - ProductListing

    ProductListing
    ProductListState

    Buildable controllers - RecentQueriesList

    RecentQueriesList
    RecentQueriesState

    Buildable controllers - Recommendations

    Recommendations

    Buildable controllers - Search

    Buildable controllers - SearchBox

    Buildable controllers - StandaloneSearchBox

    StandaloneSearchBox
    StandaloneSearchBoxState

    Sub-controllers - BreadcrumbManager

    Sub-controllers - CategoryFacet

    CategoryFacet
    CategoryFacetState

    Sub-controllers - DateFacet

    DateFacet
    DateFacetState

    Sub-controllers - DidYouMean

    DidYouMean

    Sub-controllers - LocationFacet

    LocationFacet
    LocationFacetState

    Sub-controllers - NumericFacet

    NumericFacet
    NumericFacetState

    Sub-controllers - Pagination

    Pagination
    PaginationState

    Sub-controllers - ParameterManager

    ParameterManager
    ParameterManagerState

    Sub-controllers - RegularFacet

    RegularFacet
    RegularFacetState

    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

    buildParameterSerializer
    buildQueryExpression
    buildResultTemplatesManager
    deserializeRelativeDate
    getAnalyticsNextApiBaseUrl
    getCommerceApiBaseUrl
    getOrganizationEndpoint
    getSampleCommerceEngineConfiguration
    parseCriterionExpression
    validateRelativeDate

    Interfaces

    AnalyticsConfiguration
    ApplyQueryTriggerModificationPayload
    BaseFacetSearchResult
    BaseProduct
    BuildOptions
    CartBuildProps
    CartDefinition
    CartInitialState
    CartItem
    CartProps
    CategoryFacetSearchResult
    CategoryFacetValue
    CommerceEngineConfiguration
    CommerceEngineDefinition
    CommerceSearchParameters
    ContextDefinition
    ContextOptions
    ContextProps
    Controller
    ControllerDefinitionsMap
    ControllerWithKind
    CoreInstantProductPayload
    CorePaginationOptions
    CoreSearchBox
    DateFieldExpression
    DateRangeFieldExpression
    EngineConfiguration
    EngineDefinition
    EngineDefinitionBuildResult
    EngineStaticState
    ExactMatchExpression
    ExternalEngineOptions
    FacetGenerator
    FetchRecommendationsPayload
    FetchRedirectUrlPayload
    FieldExistsExpression
    FieldSuggestionsFacet
    FilterSuggestionsGeneratorDefinition
    FromBuildResult
    FromBuildResultOptions
    HighlightKeyword
    HydratedState
    HydrateStaticStateOptions
    InstantProductsDefinition
    InstantProductsOptions
    InstantProductsProps
    InteractiveProduct
    InteractiveProductOptions
    KeywordExpression
    LocationFacetValue
    LoggerOptions
    Middleware
    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
    BrowserNavigatorContextProvider
    Build
    CartActionPayload
    ChildProduct
    ClearExpiredInstantProductsPayload
    ClearQuerySuggestPayload
    CommerceAppState
    CommerceEngineDefinitionOptions
    CommerceProductListingParametersState
    CommerceSearchParametersState
    ControllerDefinition
    CoreCommerceFacet
    CoreEngineNext
    DateFacetValue
    DeselectAllValuesInCoreFacetPayload
    EngineDefinitionControllersPropsOption
    FacetGeneratorState
    FacetType
    FetchMoreRecommendationsPayload
    FetchQuerySuggestionsPayload
    FetchStaticState
    FetchStaticStateOptions
    GeneratedFilterSuggestionsControllers
    HydrateStaticState
    InferBuildResult
    InferControllerFromDefinition
    InferControllerPropsMapFromDefinitions
    InferControllersMapFromDefinition
    InferControllerStaticStateFromController
    InferControllerStaticStateMapFromControllers
    InferControllerStaticStateMapFromDefinitionsWithSolutionType
    InferHydratedState
    InferStaticState
    InteractiveProductProps
    LogLevel
    MappedFacetState
    MappedFacetStates
    MappedGeneratedFacetController
    NextPagePayload
    NumericFacetValue
    OptionsTuple
    PaginationOptions
    PlatformEnvironment
    PrepareForSearchWithQueryPayload
    PreviousPagePayload
    ProductClickPayload
    ProductList
    ProductListingParameters
    ProductTemplate
    ProductTemplateCondition
    ProductViewPayload
    PurchasePayload
    ReactEngineDefinition
    RegisterInstantProductPayload
    RegisterQuerySetQueryPayload
    RegisterQuerySuggestPayload
    RegisterRecommendationsSlotPaginationPayload
    RegisterRecommendationsSlotPayload
    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

    buildCriterionExpression
    buildDateSortCriterion
    buildFieldSortCriterion
    buildNoSortCriterion
    buildQueryRankingExpressionSortCriterion
    buildRelevanceSortCriterion
    ProductTemplatesHelpers
    updateIgnoreQueryTrigger
    VERSION

    Settings

    Member Visibility

    On This Page

    Engine
    Providers
    Definers
    Controllers - DidYouMean
    Controllers - NotifyTrigger
    Controllers - QueryTrigger
    Controllers - RedirectionTrigger
    Controllers - SearchBox
    Buildable controllers - Cart
    Buildable controllers - CategoryFilterSuggestions
    Buildable controllers - Context
    Buildable controllers - FilterSuggestions
    Buildable controllers - FilterSuggestionsGenerator
    Buildable controllers - InstantProducts
    Buildable controllers - ProductListing
    Buildable controllers - RecentQueriesList
    Buildable controllers - Recommendations
    Buildable controllers - Search
    Buildable controllers - SearchBox
    Buildable controllers - StandaloneSearchBox
    Sub-controllers - BreadcrumbManager
    Sub-controllers - CategoryFacet
    Sub-controllers - DateFacet
    Sub-controllers - DidYouMean
    Sub-controllers - LocationFacet
    Sub-controllers - NumericFacet
    Sub-controllers - Pagination
    Sub-controllers - ParameterManager
    Sub-controllers - RegularFacet
    Sub-controllers - Sort
    Actions - Cart
    Actions - CategoryFacet
    Actions - Configuration
    Actions - Context
    Actions - DateFacet
    Actions - InstantProducts
    Actions - NumericFacet
    Actions - Pagination
    Actions - Product
    Actions - ProductListing
    Actions - ProductListingParameters
    Actions - Query
    Actions - QuerySet
    Actions - QuerySuggest
    Actions - RecentQueries
    Actions - Recommendations
    Actions - RegularFacet
    Actions - Search
    Actions - SearchParameters
    Actions - Sort
    Actions - StandaloneSearchBoxSet
    Actions - Triggers
    Classes
    Enumerations
    Functions
    Interfaces
    AnalyticsConfigurationApplyQueryTriggerModificationPayloadBaseFacetSearchResultBaseProductBuildOptionsCartBuildPropsCartDefinitionCartInitialStateCartItemCartPropsCategoryFacetSearchResultCategoryFacetValueCommerceEngineConfigurationCommerceEngineDefinitionCommerceSearchParametersContextDefinitionContextOptionsContextPropsControllerControllerDefinitionsMapControllerWithKindCoreInstantProductPayloadCorePaginationOptionsCoreSearchBoxDateFieldExpressionDateRangeFieldExpressionEngineConfigurationEngineDefinitionEngineDefinitionBuildResultEngineStaticStateExactMatchExpressionExternalEngineOptionsFacetGeneratorFetchRecommendationsPayloadFetchRedirectUrlPayloadFieldExistsExpressionFieldSuggestionsFacetFilterSuggestionsGeneratorDefinitionFromBuildResultFromBuildResultOptionsHighlightKeywordHydratedStateHydrateStaticStateOptionsInstantProductsDefinitionInstantProductsOptionsInstantProductsPropsInteractiveProductInteractiveProductOptionsKeywordExpressionLocationFacetValueLoggerOptionsMiddlewareNavigatorContextNearExpressionNegatableNotifyTriggerDefinitionNumericFieldExpressionNumericRangeFieldExpressionOtherTermPaginationPropsParameterManagerPropsParametersProductProductListingSummaryStateProductTemplatesManagerProductViewPromoteChildToParentPayloadQueryExpressionQueryExtensionExpressionQueryTriggerDefinitionRecentQueriesListDefinitionRecentQueriesListInitialStateRecentQueriesListOptionsRecentQueriesListPropsRecommendationsDefinitionRecommendationsStateRecommendationsSummaryStateRedirectionTriggerDefinitionRegisterRecentQueriesCreatorPayloadRegisterStandaloneSearchBoxPayloadRegularFacetValueRelativeDateRelayResetStandaloneSearchBoxPayloadSearchBoxDefinitionSearchBoxPropsSearchSummaryStateSetContextPayloadSortPropsSSRParameterManagerPropsStandaloneSearchBoxDefinitionStandaloneSearchBoxPropsStringFacetFieldExpressionStringFieldExpressionSubscribableSuggestionSummarySummaryStateTemplateToggleSelectNumericFacetValuePayloadUnsubscribeUpdateInstantProductQueryPayloadUpdateNumericFacetValuesPayloadUpdateQueryPayloadUserLocationView
    Type Aliases
    AnalyticsRuntimeEnvironmentApplySortPayloadBreadcrumbManagerBrowserNavigatorContextProviderBuildCartActionPayloadChildProductClearExpiredInstantProductsPayloadClearQuerySuggestPayloadCommerceAppStateCommerceEngineDefinitionOptionsCommerceProductListingParametersStateCommerceSearchParametersStateControllerDefinitionCoreCommerceFacetCoreEngineNextDateFacetValueDeselectAllValuesInCoreFacetPayloadEngineDefinitionControllersPropsOptionFacetGeneratorStateFacetTypeFetchMoreRecommendationsPayloadFetchQuerySuggestionsPayloadFetchStaticStateFetchStaticStateOptionsGeneratedFilterSuggestionsControllersHydrateStaticStateInferBuildResultInferControllerFromDefinitionInferControllerPropsMapFromDefinitionsInferControllersMapFromDefinitionInferControllerStaticStateFromControllerInferControllerStaticStateMapFromControllersInferControllerStaticStateMapFromDefinitionsWithSolutionTypeInferHydratedStateInferStaticStateInteractiveProductPropsLogLevelMappedFacetStateMappedFacetStatesMappedGeneratedFacetControllerNavigatorContextProviderNextPagePayloadNumericFacetValueOptionsTuplePaginationOptionsPlatformEnvironmentPrepareForSearchWithQueryPayloadPreviousPagePayloadProductClickPayloadProductListProductListingParametersProductTemplateProductTemplateConditionProductViewPayloadPurchasePayloadReactEngineDefinitionRegisterInstantProductPayloadRegisterQuerySetQueryPayloadRegisterQuerySuggestPayloadRegisterRecommendationsSlotPaginationPayloadRegisterRecommendationsSlotPayloadRelativeDatePeriodRelativeDateUnitRestoreProductListingParametersPayloadRestoreSearchParametersPayloadSearchBoxOptionsSelectPagePayloadSelectQuerySuggestionPayloadSetItemsPayloadSetLocationPayloadSetPageSizePayloadSetViewPayloadSortByDateSortByFieldSortByNoSortSortByQRESortByRelevancySortCriterionToggleExcludeDateFacetValuePayloadToggleExcludeFacetValuePayloadToggleExcludeNumericFacetValuePayloadToggleSelectCategoryFacetValuePayloadToggleSelectDateFacetValuePayloadToggleSelectFacetValuePayloadUpdateAnalyticsConfigurationPayloadUpdateAutoSelectionForAllCoreFacetsPayloadUpdateBasicConfigurationPayloadUpdateCategoryFacetNumberOfValuesPayloadUpdateCoreFacetFreezeCurrentValuesPayloadUpdateCoreFacetIsFieldExpandedPayloadUpdateCoreFacetNumberOfValuesPayloadUpdateDateFacetValuesPayloadUpdateIgnoreQueryTriggerPayloadUpdateItemQuantityPayloadUpdateQuerySetQueryPayload
    Variables