Coveo Settings button

This is for:

Developer System Administrator

In this article

Usage notes
Insertion location
Data source options
Sample generated HTML and corresponding visual output

Legacy feature

This article pertains to the Coveo Hive framework which is now in maintenance mode.

Choose one of Coveo’s more modern, lightweight, and responsive libraries for any future search interface development. See the search interface Implementation guide for more details.

Implements the Coveo JavaScript Search Framework Settings component which renders a Settings button that the end user can click to access a popup menu of contextual actions.

Usage notes

After adding the Coveo Settings Button rendering, you must insert renderings from the Settings Button options group to add options to the popup menu.
You can customize the CSS associated with this rendering.

Insertion location

Coveo Hive

The Coveo Settings Button rendering is an Allowed Control in the following placeholder(s): Searchbox Settings

Example insertion sequence for the Coveo Settings Button rendering.

Coveo Hive SXA

Coveo for Sitecore SXA rendering insertion locations aren’t limited by placeholder Allowed Controls. The Coveo Settings Button rendering may therefore be inserted throughout the partial design, whether in Coveo for Sitecore or Sitecore placeholders.

The usual location of the Settings button on the page is to the right of the search box.

Example insertion sequence for the Coveo Settings Button rendering.

Data source options

Option name	Description
Additional data attributes	Allows use of the Coveo JavaScript Search Framework Settings component options that aren’t directly available in the data source.

Option name

Description

Additional data attributes

Allows use of the Coveo JavaScript Search Framework Settings component options that aren’t directly available in the data source.

Sample generated HTML and corresponding visual output

<div class="CoveoSettings" ></div>