Coveo Settings Button

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 include renderings from the Settings Button Options Group in the Searchbox Options placeholder to add options to the popup menu.
  • After adding the Coveo Settings Button rendering, you must insert renderings from the Settings Button Options Group to add options to the popup menu.

Insertion Location

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 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 in 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.

Sample Generated HTML and Corresponding Visual Output

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

Settings Button example output

Recommended Articles