Module SSR Search

Headless React Utils for SSR

@coveo/headless-react/ssr provides React utilities for server-side rendering with headless controllers.

Learn more

Checkout our Documentation for SSR Search
Refer to samples/headless-ssr for examples.

Engine

SearchEngine
SearchEngineOptions
SearchEngineDefinitionOptions

Definers

Controllers - AutomaticFacetGenerator

AutomaticFacet
AutomaticFacetGenerator
AutomaticFacetGeneratorState
AutomaticFacetState

Controllers - BreadcrumbManager

BreadcrumbManager
BreadcrumbManagerState

Controllers - CategoryFacet

CategoryFacet
CategoryFacetState
CoreCategoryFacet
CoreCategoryFacetState

Controllers - CategoryFieldSuggestions

CategoryFieldSuggestions
CategoryFieldSuggestionsState

Controllers - Context

Context
ContextState

Controllers - DateFacet

DateFacet
DateFacetState

Controllers - DateFilter

DateFilter
DateFilterState

Controllers - DictionaryFieldContext

DictionaryFieldContext
DictionaryFieldContextState

Controllers - DidYouMean

DidYouMean
DidYouMeanState

Controllers - ExecuteTrigger

ExecuteTrigger
ExecuteTriggerState

Controllers - Facet

CoreFacet
CoreFacetState
Facet
FacetState

Controllers - FacetManager

FacetManager
FacetManagerState

Controllers - FieldSuggestions

FieldSuggestions
FieldSuggestionsState

Controllers - FoldedResultList

FoldedResultList
FoldedResultListState

Controllers - HistoryManager

HistoryManager
HistoryManagerState

Controllers - InstantResults

InstantResults
InstantResultsState

Controllers - NotifyTrigger

NotifyTrigger
NotifyTriggerState

Controllers - NumericFacet

NumericFacet
NumericFacetState

Controllers - NumericFilter

NumericFilter
NumericFilterState

Controllers - Pager

Pager
PagerState

Controllers - QueryError

QueryError
QueryErrorState

Controllers - QuerySummary

QuerySummary
QuerySummaryState

Controllers - QueryTrigger

QueryTrigger
QueryTriggerState

Controllers - Quickview

Quickview
QuickviewState

Controllers - RecentQueriesList

RecentQueriesList
RecentQueriesState

Controllers - RecentResultsList

RecentResultsList
RecentResultsState

Controllers - RedirectionTrigger

RedirectionTrigger
RedirectionTriggerState

Controllers - RelevanceInspector

RelevanceInspector
RelevanceInspectorState

Controllers - ResultList

ResultList
ResultListState

Controllers - ResultsPerPage

ResultsPerPage
ResultsPerPageState

Controllers - SearchBox

SearchBox
SearchBoxState

Controllers - SearchParameterManager

SearchParameterManager
SearchParameterManagerState

Controllers - SearchStatus

SearchStatus
SearchStatusState

Controllers - SmartSnippet

SmartSnippet
SmartSnippetState

Controllers - SmartSnippetQuestionsList

SmartSnippetQuestionsList
SmartSnippetQuestionsListState

Controllers - Sort

Sort
SortState

Controllers - StandaloneSearchBox

StandaloneSearchBox
StandaloneSearchBoxState

Controllers - StaticFilter

StaticFilter
StaticFilterState

Controllers - Tab

Tab
TabState

Controllers - TabManager

TabManager
TabManagerState

Controllers - UrlManager

UrlManager
UrlManagerState

Actions - AdvancedSearchQueries

AdvancedSearchQueryActionCreators
loadAdvancedSearchQueryActions

Actions - Analytics

ClickAnalyticsActionCreators
SearchAnalyticsActionCreators
loadClickAnalyticsActions
loadSearchAnalyticsActions

Actions - Breadcrumb

BreadcrumbActionCreators
loadBreadcrumbActions

Actions - CategoryFacetSet

CategoryFacetSetActionCreators
loadCategoryFacetSetActions

Actions - Configuration

ConfigurationActionCreators
loadConfigurationActions

Actions - Context

ContextActionCreators
loadContextActions

Actions - DateFacetSet

DateFacetSetActionCreators
loadDateFacetSetActions

Actions - Debug

DebugActionCreators
loadDebugActions

Actions - DictionaryFieldContext

DictionaryFieldContextActionCreators
loadDictionaryFieldContextActions

Actions - DidYouMean

DidYouMeanActionCreators
loadDidYouMeanActions

Actions - ExcerptLength

ExcerptLengthActionCreators
loadExcerptLengthActions

Actions - FacetOptions

FacetOptionsActionCreators
loadFacetOptionsActions

Actions - FacetSet

FacetSetActionCreators
loadFacetSetActions

Actions - Field

FieldActionCreators
loadFieldActions

Actions - Folding

FoldingActionCreators
loadFoldingActions

Actions - GeneratedAnswer

GeneratedAnswerActionCreators
loadGeneratedAnswerActions

Actions - GenericAnalytics

GenericAnalyticsActionCreators
loadGenericAnalyticsActions

Actions - History

HistoryActionCreators
loadHistoryActions

Actions - InsightResults

InstantResultsActionCreators
loadInstantResultsActions

Actions - NumericFacetSet

NumericFacetSetActionCreators
loadNumericFacetSetActions

Actions - Pagination

PaginationActionCreators
loadPaginationActions

Actions - Pipeline

PipelineActionCreators
loadPipelineActions

Actions - Query

QueryActionCreators
loadQueryActions

Actions - QuerySet

QuerySetActionCreators
loadQuerySetActions

Actions - QuerySuggest

QuerySuggestActionCreators
loadQuerySuggestActions

Actions - QuestionAnswering

QuestionAnsweringActionCreators
loadQuestionAnsweringActions

Actions - RecentQueries

RecentQueriesActionCreators
loadRecentQueriesActions

Actions - RecentResults

RecentResultsActionCreators
loadRecentResultsActions

Actions - ResultPreview

ResultPreviewActionCreators
loadResultPreviewActions

Actions - Search

SearchActionCreators
loadSearchActions

Actions - SearchConfiguration

SearchConfigurationActionCreators
loadSearchConfigurationActions

Actions - SearchHub

SearchHubActionCreators
loadSearchHubActions

Actions - SortCriteria

SortCriteriaActionCreators
loadSortCriteriaActions

Actions - StandaloneSearchBoxSet

StandaloneSearchBoxSetActionCreators
loadStandaloneSearchBoxSetActions

Actions - StaticFilterSet

StaticFilterSetActionCreators
loadStaticFilterSetActions

Actions - TabSet

TabSetActionCreators
loadTabSetActions

Classes

MissingEngineProviderError

Enumerations

SortBy
SortOrder

Functions

Interfaces

AddContextActionCreatorPayload
AddDictionaryFieldContextActionCreatorPayload
AdvancedSearchQueryActionCreatorPayload
AnalyticsConfiguration
AutomaticFacetBreadcrumb
AutomaticFacetGeneratorDefinition
AutomaticFacetGeneratorOptions
AutomaticFacetGeneratorProps
Breadcrumb
BreadcrumbManagerDefinition
BreadcrumbValue
Build
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
InlineLink
InstantResultOptions
InstantResultProps
InstantResultsDefinition
KeywordExpression
LogCategoryFacetBreadcrumbActionCreatorPayload
LogClickEventActionCreatorPayload
LogCustomEventActionCreatorPayload
LogDateFacetBreadcrumbActionCreatorPayload
LogFacetBreadcrumbActionCreatorPayload
LogFacetDeselectActionCreatorPayload
LogFacetExcludeActionCreatorPayload
LogFacetSelectActionCreatorPayload
LogFacetUnexcludeActionCreatorPayload
LogFacetUpdateSortActionCreatorPayload
LoggerOptions
LogNumericFacetBreadcrumbActionCreatorPayload
LogQuerySuggestionClickActionCreatorPayload
LogSearchEventActionCreatorPayload
LogStaticFilterClearAllActionCreatorPayload
LogStaticFilterToggleValueActionCreatorPayload
LogUndoTriggerQueryActionCreatorPayload
Middleware
NavigatorContext
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

Type Aliases

Variables

DefaultFieldsToInclude
EcommerceDefaultFieldsToInclude
MinimumFieldsToInclude
ResultTemplatesHelpers
VERSION