---
title: Coveo Results Preferences
slug: '3060'
canonical_url: https://docs.coveo.com/en/3060/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# Coveo Results Preferences
> **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/) [ResultsPreferences](https://coveo.github.io/search-ui/components/resultspreferences.html) component which allows website visitors to specify search result related preferences when selecting the **Preferences** option in the Settings popup menu (see [Coveo Preferences Panel](https://docs.coveo.com/en/3058/)).

## Usage notes

* Result preferences are saved in the browser local storage.

## Insertion location


<div>
<h3>Coveo Hive</h3>
  <p>The <strong>Coveo Results Preferences</strong> rendering is an Allowed Control in the following placeholder(s): <code class="highlighter-rouge">Preferences Panel</code></p>
  <video width="690" height="335" controls="">
  <source src="{{ site.baseurl }}/assets/images/c4sc-v5/results-preferences-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 Results Preferences</strong> rendering.
  </div>
</div>
<div>
<h3>Coveo Hive SXA</h3>
  <p>When you add the <strong>Coveo Preferences Panel</strong> SXA rendering, this adds a <code class="highlighter-rouge">Preferences Panel</code> placeholder, accessible by selecting the <strong>Preferences</strong> option in the Settings popup menu. Insert your <strong>Coveo Results Preferences</strong> rendering in this <code class="highlighter-rouge">Preferences Panel</code> placeholder.</p>
  <video width="690" height="335" controls="">
  <source src="{{ site.baseurl }}/assets/images/c4sc-v5/results-preferences-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 Results Preferences</strong> rendering.
  </div>
</div>

## Data source options

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

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

|Enable the 'Open in New Window' option
|See the [enableOpenInNewWindow](https://coveo.github.io/search-ui/components/resultspreferences.html#options.enableopeninnewwindow) component option.

|Enable the 'Open in Outlook' option
|See the [enableOpenInOutlook](https://coveo.github.io/search-ui/components/resultspreferences.html#options.enableopeninoutlook) component option.

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

## Sample Generated HTML and Corresponding Behavior

**Generated HTML**:

```html
<div class="CoveoResultsPreferences">
  <fieldset class="coveo-form-group">
    <span class="coveo-form-group-label">Result links</span>
    <label class="coveo-checkbox-label">
      <input type="checkbox" class="coveo-checkbox" value="Always open results in new window"
      aria-label="Always open results in new window" aria-hidden="true">
      <button type="button" class="coveo-checkbox-button"
      aria-label="Always open results in new window"></button>
      <span class="coveo-checkbox-span-label">Always open results in new window</span>
    </label>
  </fieldset>
</div>
```

When website visitors change their **Always open results in new window** preference in the modal, the new value for this preference is stored in the browser local storage.

![Results Preferences Sample | Coveo for Sitecore 5](https://docs.coveo.com/en/assets/images/c4sc-v5/results-preferences-sample.png)