Coveo Search Interface
Implements the Coveo JavaScript Search Framework SearchInterface component. The SearchInterface component is the root and main component of a Coveo-powered search interface.
Usage Notes
The Coveo Search Interface rendering is required to use any other Coveo JavaScript Search Framework component. The Coveo Search Interface rendering automatically adds the Automatic Boosting, Query Filter, Query Ranking and Sitecore Instance Filter renderings to the page.
Some features of the Automatic Boosting, Query Filter and Query Ranking renderings are only available with the Enterprise Edition.
Insertion Location
The Coveo Search Interface rendering is an Allowed Control in the following placeholder(s): Coveo UI.
Example insertion sequence for the Coveo Search Interface rendering.
Coveo for Sitecore SXA rendering insertion locations aren’t limited by placeholder Allowed Controls. The Coveo Search Interface rendering may therefore be inserted throughout the partial design, whether in Coveo for Sitecore or Sitecore placeholders.
Example insertion sequence for the Coveo Search Interface rendering.
Data Source Options
| Option name | Description |
|---|---|
| Enterprise only Boost expression rules |
See Query Ranking rendering |
| Enterprise only Enable automatic boosting |
See Automatic Boosting rendering |
| Enterprise only Filter expression rules |
See Query Filter rendering |
| Filter results on the current context language | See Sitecore Instance Filter rendering |
| Filter results on the latest version | See Sitecore Instance Filter rendering |
| Exclude bucket folders in results | See Query Filter rendering |
| Exclude media folders in results | See Query Filter rendering |
| Query pipeline | See pipeline component option |
| Results per page | See resultsPerPage component option |
| Excerpt length | See excerptLength component option |
| Maximum age | See maximumAge component option |
| Automatically trigger first query | See autoTriggerQuery component option |
| Hide until first query | See hideUntilFirstQuery component option |
| Enable history | See enableHistory component option |
| Names of external content sources | See External Content rendering |
| Custom CSS classes | See Insert Custom CSS in Coveo for Sitecore article |
| Initialization file name | See Custom Initialization Scripts article |
| DOM unique Id | Randomly generated HTML element id |
| Additional data attributes | Allows use of SearchInterface component options not directly available in the data source (see Passing Non-Fronted JavaScript Framework Properties to Hive Components) |
Sample Generated HTML
<div id="coveo5c7ed6eb" class="CoveoSearchInterface Coveostate CoveoComponentState
CoveoComponentOptions CoveoQueryController CoveoHistoryController CoveoDebug
coveo-after-initialization" data-enable-history="true"
data-prebind-maximum-age="currentMaximumAge" data-applied-prebind="true"
data-maximum-age="0" style="display: block;"
data-coveo-for-sitecore-syntax-event-registered="true"
data-coveo-for-sitecore-event-registered="true">