Coveo Facet

The Coveo Dynamic Facet is now recommended over the Coveo Facet rendering.

Implements the Coveo JavaScript Search Framework Facet component to allow filtering of results on one or multiple values of a field.

Usage Notes

  • The field selected in the Field data source option must be facetable (see Make a Sitecore Field Facetable).

  • Any change to the facet value selections triggers a new Search API call.

Insertion Location

The Coveo Facet rendering is an Allowed Control in the following placeholder(s): Facets

Example insertion sequence for the Coveo Facet rendering.

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

Example insertion sequence for the Coveo Facet rendering.

Data Source Options

Option name Description
Title See title component option
Field See field component option
Facet name See id component option
Number of values See numberOfValues component option
Sort See sortCriteria component option
Ignore accents in facet search See facetSearchIgnoreAccents component option
Allowed facet values See allowedValues component option
Facet value caption See valueCaption component option
Enable collapse button See enableCollapse component option
Enable settings button See enableSettings component option
Sort criteria displayed in the settings menu See availableSorts component option
Enable search for the facet See enableFacetSearch component option
Number of values to display in the facet search results See numberOfValuesInFacetSearch component option
Enable more/less button See enableMoreLess component option
Number of additional facet values to fetch when 'More' is clicked See pageSize component option
Include facet values in the omnibox Don't use this option. It is only exposed for legacy reasons.
Include facet values in the breadcrumb See includeInBreadcrumb component option
Maximum number of facet values displayed in the breadcrumb See numberOfValuesInBreadcrumb component option
Computed field See computedField component option. Not to be confused with a Sitecore computed index field.
Computed field operation See computedFieldOperation component option
Computed field format See computedFieldFormat component option
Computed field caption See computedFieldCaption component option
Is multi-value field See isMultiValueField component option
Facet uses the AND operator See useAnd component option
Allows user to select the facet operator See enableTogglingOperator component option
Facet accuracy determined by the number of scanned results Sets the injectionDepth component option to a preset value
Enable 'Save Facet State' option in Settings menu See enableSettingsFacetState component option
Preserve facet position under mouse on new facet query See preservePosition component option
DOM unique Id Randomly generated HTML element id.

Additional data attributes

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

Sample Generated HTML and Corresponding Visual Output

<div id="coveo493E5F13" class="CoveoFacet"
data-prebind-field="fieldTranslator" data-field="@z95xtemplatename" data-id="templatename"
data-injection-depth="1000" data-sort-criteria="occurrences" data-title="Template Name"
Image showing text facet in published search page
What's Next for Me?