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

    Module SSR Search

    SSR Search

    This module provides the React utilities for building server-side rendered search interfaces with @coveo/headless-react/ssr.

    It includes:

    • Engine definition — defineSearchEngine to configure and instantiate a headless search engine for SSR.
    • Controllers — Pre-built React hooks for search controllers such as facets, result lists, query suggestions, breadcrumbs, and more.
    • Actions — Redux action creators to dispatch search-related actions (e.g., executing a search, updating query, managing facet state).
    • Providers — React context providers that supply the engine and controller state to your component tree.

    See Getting started with Search SSR for a setup guide.

    SortBy
    SortOrder
    MissingEngineProviderError
    AddContextActionCreatorPayload
    AddDictionaryFieldContextActionCreatorPayload
    AdvancedSearchQueryActionCreatorPayload
    AnalyticsConfiguration
    AutomaticFacetBreadcrumb
    AutomaticFacetGeneratorDefinition
    AutomaticFacetGeneratorOptions
    AutomaticFacetGeneratorProps
    CategoryFacetBreadcrumb
    CategoryFacetDefinition
    CategoryFacetOptions
    CategoryFacetProps
    CategoryFacetSearch
    CategoryFacetSearchOptions
    CategoryFacetSearchResult
    CategoryFacetSearchState
    CategoryFacetValue
    CategoryFacetValueCommon
    CategoryFacetValueRequest
    CategoryFieldSuggestionsDefinition
    CategoryFieldSuggestionsOptions
    CategoryFieldSuggestionsProps
    CategoryFieldSuggestionsValue
    ClearExpiredInstantResultsActionCreatorPayload
    ClearQuerySuggestActionCreatorPayload
    ContextDefinition
    ContextInitialState
    ContextProps
    Controller
    ControllerDefinitionsMap
    ControllerDefinitionWithoutProps
    ControllerDefinitionWithProps
    CoreBreadcrumbManager
    CoreBreadcrumbManagerState
    CoreEngine
    CoreQuickview
    CoreQuickviewState
    CoreSmartSnippetQuestionsList
    CoreSmartSnippetQuestionsListState
    DateFacetDefinition
    DateFacetOptions
    DateFacetProps
    DateFacetValue
    DateFieldExpression
    DateFilterDefinition
    DateFilterInitialState
    DateFilterOptions
    DateFilterProps
    DateFilterRange
    DateRangeFieldExpression
    DateRangeOptions
    DateRangeRequest
    Delimiters
    DeselectableValue
    DictionaryFieldContextDefinition
    DidYouMeanDefinition
    DocumentWeights
    EngineConfiguration
    EngineDefinition
    ErrorPayload
    ExactMatchExpression
    ExecuteTriggerDefinition
    ExecutionReport
    ExecutionStep
    ExternalEngineOptions
    FacetDefinition
    FacetManagerDefinition
    FacetManagerPayload
    FacetOptions
    FacetProps
    FacetSearch
    FacetSearchOptions
    FacetSearchState
    FacetValue
    FacetValueRequest
    FetchInstantResultsActionCreatorPayload
    FetchQuerySuggestionsActionCreatorPayload
    FetchRedirectUrlActionCreatorPayload
    FieldDescription
    FieldExistsExpression
    FieldSuggestionsDefinition
    FieldSuggestionsOptions
    FieldSuggestionsProps
    FieldSuggestionsValue
    FoldedCollection
    FoldedResult
    FoldedResultListDefinition
    FoldedResultListOptions
    FoldedResultListProps
    FoldingOptions
    FunctionExecutionTrigger
    HighlightKeyword
    HistoryManagerDefinition
    InstantResultOptions
    InstantResultProps
    InstantResultsDefinition
    KeywordExpression
    LogCategoryFacetBreadcrumbActionCreatorPayload
    LogClickEventActionCreatorPayload
    LogCustomEventActionCreatorPayload
    LogDateFacetBreadcrumbActionCreatorPayload
    LogFacetBreadcrumbActionCreatorPayload
    LogFacetDeselectActionCreatorPayload
    LogFacetExcludeActionCreatorPayload
    LogFacetSelectActionCreatorPayload
    LogFacetUnexcludeActionCreatorPayload
    LogFacetUpdateSortActionCreatorPayload
    LoggerOptions
    LogNumericFacetBreadcrumbActionCreatorPayload
    LogQuerySuggestionClickActionCreatorPayload
    LogSearchEventActionCreatorPayload
    LogStaticFilterClearAllActionCreatorPayload
    LogStaticFilterToggleValueActionCreatorPayload
    LogUndoTriggerQueryActionCreatorPayload
    Middleware
    NearExpression
    Negatable
    NotifyTriggerDefinition
    NumericFacetDefinition
    NumericFacetOptions
    NumericFacetProps
    NumericFacetValue
    NumericFieldExpression
    NumericFilterDefinition
    NumericFilterInitialState
    NumericFilterOptions
    NumericFilterProps
    NumericFilterRange
    NumericRangeFieldExpression
    NumericRangeOptions
    NumericRangeRequest
    OtherTerm
    PagerDefinition
    PagerInitialState
    PagerOptions
    PagerProps
    QueryCorrection
    QueryErrorDefinition
    QueryExpression
    QueryExpressions
    QueryExtensionExpression
    QueryRankingExpression
    QueryRankingExpressionWeights
    QuerySummaryDefinition
    QueryTriggerDefinition
    QuestionAnswerDocumentIdentifier
    QuestionAnsweringInlineLinkActionCreatorPayload
    QuestionAnsweringUniqueIdentifierActionCreatorPayload
    QuickviewDefinition
    QuickviewOptions
    QuickviewProps
    RankingInformation
    Raw
    RecentQueriesListDefinition
    RecentQueriesListInitialState
    RecentQueriesListOptions
    RecentQueriesListProps
    RecentResultsListDefinition
    RecentResultsListInitialState
    RecentResultsListOptions
    RecentResultsListProps
    RedirectionTriggerDefinition
    RegisterCategoryFacetActionCreatorPayload
    RegisterDateFacetActionCreatorPayload
    RegisterFacetActionCreatorPayload
    RegisterFoldingActionCreatorPayload
    RegisterInstantResultActionCreatorPayload
    RegisterNumericFacetActionCreatorPayload
    RegisterQuerySetQueryActionCreatorPayload
    RegisterQuerySuggestActionCreatorPayload
    RegisterRecentResultsCreatorPayload
    RegisterStandaloneSearchBoxActionCreatorPayload
    RegisterStaticFilterActionCreatorPayload
    RegisterTabActionCreatorPayload
    RelativeDate
    Relay
    RelevanceInspectorDefinition
    RelevanceInspectorInitialState
    RelevanceInspectorProps
    ResetStandaloneSearchBoxActionCreatorPayload
    Result
    ResultListDefinition
    ResultListOptions
    ResultListProps
    ResultRankingInformation
    ResultsPerPageDefinition
    ResultsPerPageInitialState
    ResultsPerPageProps
    ResultTemplatesManager
    SearchBoxDefinition
    SearchBoxOptions
    SearchBoxProps
    SearchConfigurationOptions
    SearchEngineConfiguration
    SearchEngineDefinition
    SearchParameterManagerBuildProps
    SearchParameterManagerDefinition
    SearchParameterManagerInitialState
    SearchParameters
    SearchStatusDefinition
    SecurityIdentity
    SelectQuerySuggestionActionCreatorPayload
    SetOriginLevel2ActionCreatorPayload
    SetOriginLevel3ActionCreatorPayload
    SmartSnippetCore
    SmartSnippetDefinition
    SmartSnippetOptions
    SmartSnippetProps
    SmartSnippetQuestionsListDefinition
    SmartSnippetQuestionsListOptions
    SmartSnippetQuestionsListProps
    SmartSnippetRelatedQuestion
    SortDefinition
    SortInitialState
    SortProps
    SpecificFacetSearchResult
    StandaloneSearchBoxDefinition
    StandaloneSearchBoxOptions
    StandaloneSearchBoxProps
    StaticFilterBreadcrumb
    StaticFilterDefinition
    StaticFilterOptions
    StaticFilterProps
    StaticFilterValue
    StaticFilterValueMetadata
    StaticFilterValueOptions
    StringFacetFieldExpression
    StringFieldExpression
    Subscribable
    Suggestion
    SuggestionHighlightingOptions
    TabDefinition
    TabInitialState
    TabOptions
    TabProps
    ToggleSelectCategoryFacetValueActionCreatorPayload
    ToggleSelectDateFacetValueActionCreatorPayload
    ToggleSelectFacetValueActionCreatorPayload
    ToggleSelectNumericFacetValueActionCreatorPayload
    ToggleSelectStaticFilterValueActionCreatorPayload
    Unsubscribe
    UpdateAnalyticsConfigurationActionCreatorPayload
    UpdateAnalyticsToOmniboxFromLinkActionCreatorPayload
    UpdateAnalyticsToSearchFromLinkActionCreatorPayload
    UpdateBasicConfigurationActionCreatorPayload
    UpdateCategoryFacetBasePathActionCreatorPayload
    UpdateCategoryFacetNumberOfValuesActionCreatorPayload
    UpdateCategoryFacetSortCriterionActionCreatorPayload
    UpdateDateFacetSortCriterionActionCreatorPayload
    UpdateDateFacetValuesActionCreatorPayload
    UpdateFacetAutoSelectionActionCreatorPayload
    UpdateFacetIsFieldExpandedActionCreatorPayload
    UpdateFacetNumberOfValuesActionCreatorPayload
    UpdateFacetOptionsActionCreatorPayload
    UpdateFacetSortCriterionActionCreatorPayload
    UpdateFreezeCurrentValuesActionCreatorPayload
    UpdateInstantResultQueryActionCreatorPayload
    UpdateNumericFacetSortCriterionActionCreatorPayload
    UpdateNumericFacetValuesActionCreatorPayload
    UpdateQueryActionCreatorPayload
    UpdateQuerySetQueryActionCreatorPayload
    UpdateSearchConfigurationActionCreatorPayload
    UrlManagerBuildProps
    UrlManagerInitialState
    UrlManagerProps
    WordCorrection
    AnalyticsClientSendEventHook
    AnalyticsRuntimeEnvironment
    AnyFacetValueRequest
    Build
    CategoryFacetSortCriterion
    ContextPayload
    ContextValue
    DateFacetBreadcrumb
    DateRangeInput
    DictionaryFieldContextPayload
    DisableFacetActionCreatorPayload
    EnableFacetActionCreatorPayload
    ExecuteTriggerParams
    FacetBreadcrumb
    FacetResultsMustMatch
    FacetSortCriterion
    FacetValueState
    InferBuildResult
    InferControllerFromDefinition
    InferControllersMapFromDefinition
    InferControllerStaticStateFromController
    InferControllerStaticStateMapFromControllers
    InferControllerStaticStateMapFromDefinitions
    InferHydratedState
    InferStaticState
    LogLevel
    NumericFacetBreadcrumb
    PhrasesToHighlight
    PlatformEnvironment
    RangeFacetRangeAlgorithm
    RangeFacetSortCriterion
    ReactSearchEngineDefinition
    RelativeDatePeriod
    RelativeDateUnit
    ResultTemplate
    ResultTemplateCondition
    SearchAppState
    SearchCompletedAction
    SearchParametersState
    SmartSnippetFeedback
    SortByDate
    SortByField
    SortByNoSort
    SortByQRE
    SortByRelevancy
    SortCriterion
    StandaloneSearchBoxAnalytics
    StaticFilterValueState
    TermsToHighlight
    TermWeightReport
    baseFacetResponseSelector
    buildCriterionExpression
    buildDateSortCriterion
    buildFieldSortCriterion
    buildNoSortCriterion
    buildQueryRankingExpressionSortCriterion
    buildRelevanceSortCriterion
    currentPageSelector
    currentPagesSelector
    DefaultFieldsToInclude
    EcommerceDefaultFieldsToInclude
    facetRequestSelector
    facetResponseSelectedValuesSelector
    facetResponseSelector
    maxPageSelector
    MinimumFieldsToInclude
    ResultTemplatesHelpers
    VERSION
    buildDateRange
    buildNumericRange
    buildQueryExpression
    buildResultTemplatesManager
    buildSearchParameterSerializer
    buildSSRSearchParameterSerializer
    buildStaticFilterValue
    defineSearchEngine
    deserializeRelativeDate
    getAnalyticsNextApiBaseUrl
    getOrganizationEndpoint
    getSampleSearchEngineConfiguration
    parseCriterionExpression
    validateRelativeDate
    AdvancedSearchQueryActionCreators
    loadAdvancedSearchQueryActions
    ClickAnalyticsActionCreators
    SearchAnalyticsActionCreators
    loadClickAnalyticsActions
    loadSearchAnalyticsActions
    loadBreadcrumbActions
    CategoryFacetSetActionCreators
    loadCategoryFacetSetActions
    ConfigurationActionCreators
    loadConfigurationActions
    ContextActionCreators
    loadContextActions
    DateFacetSetActionCreators
    loadDateFacetSetActions
    DebugActionCreators
    loadDebugActions
    DictionaryFieldContextActionCreators
    loadDictionaryFieldContextActions
    DidYouMeanActionCreators
    loadDidYouMeanActions
    ExcerptLengthActionCreators
    loadExcerptLengthActions
    FacetOptionsActionCreators
    loadFacetOptionsActions
    FacetSetActionCreators
    loadFacetSetActions
    FieldActionCreators
    loadFieldActions
    FoldingActionCreators
    loadFoldingActions
    GeneratedAnswerActionCreators
    loadGeneratedAnswerActions
    GenericAnalyticsActionCreators
    loadGenericAnalyticsActions
    HistoryActionCreators
    loadHistoryActions
    InstantResultsActionCreators
    loadInstantResultsActions
    NumericFacetSetActionCreators
    loadNumericFacetSetActions
    PaginationActionCreators
    loadPaginationActions
    PipelineActionCreators
    loadPipelineActions
    QueryActionCreators
    loadQueryActions
    QuerySetActionCreators
    loadQuerySetActions
    QuerySuggestActionCreators
    loadQuerySuggestActions
    QuestionAnsweringActionCreators
    loadQuestionAnsweringActions
    RecentQueriesActionCreators
    loadRecentQueriesActions
    RecentResultsActionCreators
    loadRecentResultsActions
    ResultPreviewActionCreators
    loadResultPreviewActions
    SearchActionCreators
    loadSearchActions
    SearchConfigurationActionCreators
    loadSearchConfigurationActions
    SearchHubActionCreators
    loadSearchHubActions
    SortCriteriaActionCreators
    loadSortCriteriaActions
    StandaloneSearchBoxSetActionCreators
    loadStandaloneSearchBoxSetActions
    StaticFilterSetActionCreators
    loadStaticFilterSetActions
    TabSetActionCreators
    loadTabSetActions
    AutomaticFacet
    AutomaticFacetGenerator
    AutomaticFacetGeneratorState
    AutomaticFacetState
    CategoryFacet
    CategoryFacetState
    CoreCategoryFacet
    CoreCategoryFacetState
    CategoryFieldSuggestions
    CategoryFieldSuggestionsState
    Context
    ContextState
    DateFacet
    DateFacetState
    DateFilter
    DateFilterState
    DictionaryFieldContext
    DictionaryFieldContextState
    DidYouMean
    DidYouMeanState
    ExecuteTrigger
    ExecuteTriggerState
    CoreFacet
    CoreFacetState
    Facet
    FacetState
    FacetManager
    FacetManagerState
    FieldSuggestions
    FieldSuggestionsState
    FoldedResultList
    FoldedResultListState
    HistoryManager
    HistoryManagerState
    InstantResults
    InstantResultsState
    NotifyTrigger
    NotifyTriggerState
    NumericFacet
    NumericFacetState
    NumericFilter
    NumericFilterState
    Pager
    PagerState
    QueryError
    QueryErrorState
    QuerySummary
    QuerySummaryState
    QueryTrigger
    QueryTriggerState
    Quickview
    QuickviewState
    RecentQueriesList
    RecentQueriesState
    RecentResultsList
    RecentResultsState
    RedirectionTrigger
    RedirectionTriggerState
    RelevanceInspector
    RelevanceInspectorState
    ResultList
    ResultListState
    ResultsPerPage
    ResultsPerPageState
    SearchBoxState
    SearchParameterManager
    SearchParameterManagerState
    SearchStatus
    SearchStatusState
    SmartSnippet
    SmartSnippetState
    SmartSnippetQuestionsList
    SmartSnippetQuestionsListState
    Sort
    SortState
    StandaloneSearchBox
    StandaloneSearchBoxState
    StaticFilter
    StaticFilterState
    Tab
    TabState
    TabManager
    TabManagerState
    UrlManager
    UrlManagerState
    defineUrlManager
    defineAutomaticFacetGenerator
    defineBreadcrumbManager
    defineCategoryFacet
    defineCategoryFieldSuggestions
    defineContext
    defineDateFacet
    defineDateFilter
    defineDictionaryFieldContext
    defineDidYouMean
    defineExecuteTrigger
    defineFacet
    defineFacetManager
    defineFieldSuggestions
    defineFoldedResultList
    defineHistoryManager
    defineInstantResults
    defineNotifyTrigger
    defineNumericFacet
    defineNumericFilter
    definePager
    defineQueryError
    defineQuerySummary
    defineQueryTrigger
    defineQuickview
    defineRecentQueriesList
    defineRecentResultsList
    defineRedirectionTrigger
    defineRelevanceInspector
    defineResultList
    defineResultsPerPage
    defineSearchBox
    defineSearchParameterManager
    defineSearchStatus
    defineSmartSnippet
    defineSmartSnippetQuestionsList
    defineSort
    defineStandaloneSearchBox
    defineStaticFilter
    defineTab
    defineTabManager
    SearchEngine
    SearchEngineOptions
    SearchEngineDefinitionOptions