---
title: Coveo Search Interface
slug: '3044'
canonical_url: https://docs.coveo.com/en/3044/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# Coveo Search Interface
> **Legacy feature**
>
> The Coveo Hive Framework is now in maintenance mode and is no longer recommended for new implementations.
> 
> To build new search experiences, use one of Coveo's more modern, lightweight, and responsive libraries.
> To get started, see the [Build search](https://docs.coveo.com/en/2473/) article.

Implements the [Coveo JavaScript Search Framework](https://docs.coveo.com/en/187/) [SearchInterface](https://coveo.github.io/search-ui/components/searchinterface.html) component.
The **SearchInterface** component is the root and main component of a Coveo-powered search page.


[.version.c4sc.enterprise.5-0-822-2.October-30&-2020]
[Coveo for Sitecore 5.0.822.2](https://docs.coveo.com/en/3360#release-notes)


The new `Filter results based on the current Sitecore context database` option lets you control whether to add a filter on the current Sitecore context database in the [constant query expression (`cq`)](https://docs.coveo.com/en/179/).
Prior to the October 30, 2020 release, search results and recommendations were automatically filtered on the current Sitecore context database using a `source==<SITECORE_SOURCE_NAME>` filter in the [advanced query expression (`aq`)](https://docs.coveo.com/en/175/).

## Usage notes

* The **{doctitle}** rendering automatically adds the [Automatic Boosting](https://docs.coveo.com/en/3037/), [Query Filter](https://docs.coveo.com/en/3038/), [Query Ranking](https://docs.coveo.com/en/3039/), and [Sitecore Instance Filter](https://docs.coveo.com/en/2192/) renderings to the page.
These renderings are configured through the **{doctitle}** data source.

* Some features of the **Automatic Boosting**, **Query Filter**, and **Query Ranking** renderings are only available with the Enterprise Edition.

* You can [customize the CSS](https://docs.coveo.com/en/2342/) associated with this rendering.

## Insertion location


<div>
<h3>Coveo Hive</h3>
  <p>The <strong>Coveo Search Interface</strong> rendering is an Allowed Control in the following placeholder(s): <code class="highlighter-rouge">Coveo UI</code>.</p>
  <video width="690" height="335" controls="">
  <source src="{{ site.baseurl }}/assets/images/c4sc-v5/search-interface-hive.mp4" type="video/mp4" />
  Your browser doesn't support the video tag.
</video>
  <div class="figure-caption">Example insertion sequence for the <strong>Coveo Search Interface</strong> rendering.
  </div>
</div>
<div>
<h3>Coveo Hive SXA</h3>
  <p>Coveo for Sitecore SXA rendering insertion locations aren't limited by placeholder Allowed Controls. The <strong>Coveo Search Interface</strong> rendering may therefore be inserted throughout the partial design, whether in Coveo for Sitecore or Sitecore placeholders.</p>
  <video width="690" height="335" controls="">
  <source src="{{ site.baseurl }}/assets/images/c4sc-v5/search-interface-sxa.mp4" type="video/mp4" />
  Your browser doesn't support the video tag.
</video>
  <div class="figure-caption">Example insertion sequence for the <strong>Coveo Search Interface</strong> rendering.
  </div>
</div>

## Data source options

The following table lists the available data source options for this rendering.

[%header,cols="34%,66%"]
|===
|Option name
|Description

a|{empty}
--

[.version.no-link.c4sc.c4sc-edition.enterprise]
Enterprise edition


--
Filter expression rules
|See the [Query Filter](https://docs.coveo.com/en/3038/) rendering.

a|{empty}
--


[.version.c4sc.enterprise.5-0-822-2.October-30&-2020]
[Coveo for Sitecore 5.0.822.2](https://docs.coveo.com/en/3360#release-notes)


--
Filter results based on the current Sitecore context database
|See the [Sitecore Instance Filter](https://docs.coveo.com/en/2192/?c4scV5HiveType=tab-hive#data-source-options) rendering data source options.

|Filter results on the current context language
|See the [Sitecore Instance Filter](https://docs.coveo.com/en/2192/?c4scV5HiveType=tab-hive#data-source-options) rendering data source options.

|Filter results on the latest version
|See the [Sitecore Instance Filter](https://docs.coveo.com/en/2192/?c4scV5HiveType=tab-hive#data-source-options) rendering data source options.

|Exclude bucket folders in results
|See the [Query Filter](https://docs.coveo.com/en/3038/?c4scV5HiveType=tab-hive#data-source-options) rendering data source options.

|Exclude media folders in results
|See the [Query Filter](https://docs.coveo.com/en/3038/?c4scV5HiveType=tab-hive#data-source-options) rendering data source options.

a|{empty}
--

[.version.no-link.c4sc.c4sc-edition.enterprise]
Enterprise edition


--
Boost expression rules
|See the [Query Ranking](https://docs.coveo.com/en/3039/) rendering.

a|{empty}
--

[.version.no-link.c4sc.c4sc-edition.enterprise]
Enterprise edition


--
Enable automatic boosting
|See the [Automatic Boosting](https://docs.coveo.com/en/3037/) rendering.

|Query pipeline
|See the [pipeline](https://coveo.github.io/search-ui/components/searchinterface.html#options.pipeline) component option.

|Results per page
|See the [resultsPerPage](https://coveo.github.io/search-ui/components/searchinterface.html#options.resultsperpage) component option.

|Excerpt length
|See the [excerptLength](https://coveo.github.io/search-ui/components/searchinterface.html#options.excerptlength) component option.

|Maximum age
|See the [maximumAge](https://coveo.github.io/search-ui/components/searchinterface.html#options.maximumage) component option.

|Automatically trigger first query
|See the [autoTriggerQuery](https://coveo.github.io/search-ui/components/searchinterface.html#options.autotriggerquery) component option.

|Hide until first query
|See the [hideUntilFirstQuery](https://coveo.github.io/search-ui/components/searchinterface.html#options.hideuntilfirstquery) component option.

|Enable history
|See the [`enableHistory`](https://coveo.github.io/search-ui/components/searchinterface.html#options.enablehistory) component option.

|Names of external content sources
|See the [External Content](https://docs.coveo.com/en/2190/) rendering.

|Custom CSS classes
|See [Insert Custom CSS](https://docs.coveo.com/en/2342/).

|Initialization file name
|See [Custom Initialization Scripts](https://docs.coveo.com/en/2788/).

|DOM unique ID
a|{empty}
--
Randomly generated HTML element ID.
--

|Additional data attributes
a|{empty}
--
Allows [use of the Coveo JavaScript Search Framework **SearchInterface** component options](https://docs.coveo.com/en/2776/) that aren't directly available in the data source.
--
|===

## Sample generated HTML

```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">
```