Coveo Category Facet

Sitecore Ecommerce Website Workplace Developer System Administrator Product Documentation
Tip

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

Implements the Coveo JavaScript Search Framework CategoryFacet component to display a facet that renders values in a hierarchical fashion.

Usage Notes

  • To use the Coveo Category Facet rendering, you first need to:

    • have a content tree structure, such as the one below.

      Content Tree Category Structure

    • create a Single-Line Text (or Multi-Line Text) field, such as the ParentCategories field in the example below, listing the paths to each parent folder of the item. See Insert a Category Facet - Example for more details about the format of values for this field.

      Multi value example

    • index that Single-Line Text or Multi-Line Text field as a Multi-Value Facet.

  • Every time you change the category selection in the facet, a new Search API call is triggered.

Insertion Location

Coveo Hive

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

Example insertion sequence for the Coveo Category Facet rendering.

Coveo Hive SXA

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

Example insertion sequence for the Coveo Category 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
Enable search for the facet See enableFacetSearch component option
Coveo for Sitecore (February 12, 2021)
Display search as a button		 See displaySearchButton component option
Coveo for Sitecore (February 12, 2021)
Display search above the facet values		 See displaySearchOnTop 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
FacetBasePath See basePath component option
Facet accuracy determined by the number of scanned results Sets the injectionDepth component option to a preset value
Maximum number of levels to traverse in the hierarchy Sets the maximumDepth component option
Delimiting character that specifies the hierarchical dependency See delimitingCharacter component option
Delay in milliseconds before a search is sent to the server See facetSearchDelay component option
Depends on See dependsOn component option
DOM unique Id Randomly generated HTML element id.

Additional data attributes

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

Sample Generated HTML and Corresponding Visual Output

<div id="coveodb691f83" class="CoveoCategoryFacet" data-prebind-field="fieldTranslator"
data-field="@parentcategories" data-title="Product Categories" data-injection-depth="1000"
data-applied-prebind="true">
Category Facet sample
What's next for me?