Coveo Facet Value Suggestions

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 FacetValueSuggestions which provides query suggestions scoped to distinct categories based on a faceted field (that is, the Field data source option value).

Selecting a facet value suggestion from the list of query suggestions triggers a query to the Search API with an advanced query expression (aq) which reflects the selected facet value (that is, @<FIELD> == <SELECTED_FACET_VALUE>).

Usage notes

In the March 2019 and April 2019 releases of Coveo for Sitecore, there’s an issue with the ID of the Coveo for Sitecore SXA Coveo Facet Value Suggestions rendering which may cause a Coveo Hive page containing the Coveo Facet Value Suggestions rendering to break (see SXA Coveo Facet Value Suggestions rendering item overwriting Hive item at installation). This issue was fixed in the May 17, 2019 release.
To get facet value suggestions added to Coveo Machine Learning-powered query completion suggestions, you must first enable query suggestions and ensure your search interface generates query suggestions.
Alternatively, you can have facet value suggestions added to the current content of the search box by enabling the Use value from search box option.
You can customize the CSS associated with this rendering.

Insertion location

Coveo Hive

The Coveo Facet Value Suggestions rendering is an Allowed Control in the following placeholder(s): Searchbox Components

Example insertion sequence for the Coveo Facet Value Suggestions rendering.

Coveo Hive SXA

When you add the Coveo Searchbox SXA rendering, this adds a coveouisearchboxcomponentssxa placeholder. Insert your Coveo Facet Value Suggestions rendering in this coveouisearchboxcomponentssxa placeholder.

Example insertion sequence for the Coveo Facet Value Suggestions rendering.

Data source options

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

Option name	Description
Field	Sitecore field whose values will be used in the facet value suggestions.
Number of values to display in the suggestions list	See the numberOfSuggestions component option.
Display the estimated number of results	See the displayEstimateNumberOfResults component option.
Use value from search box	See the useValueFromSearchbox component option.
DOM unique ID	Randomly generated HTML element ID.
Additional data attributes	Allows use of the Coveo JavaScript Search Framework FacetValueSuggestions component options that aren’t directly available in the data source.

Option name

Description

Field

Sitecore field whose values will be used in the facet value suggestions.

Number of values to display in the suggestions list

See the numberOfSuggestions component option.

Display the estimated number of results

See the displayEstimateNumberOfResults component option.

Use value from search box

See the useValueFromSearchbox component option.

DOM unique ID

Randomly generated HTML element ID.

Additional data attributes

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

Sample generated HTML and corresponding visual output

<div>
  <div id="coveocaf18e11" class="CoveoFacetValueSuggestions" data-prebind-field="fieldTranslator"
  data-field="@manufacturer" data-applied-prebind="true">
  </div>
</div>

Facet value suggestions | Coveo for Sitecore 5