Coveo Breadcrumbs

Implements the Coveo JavaScript Search Framework Breadcrumb component which displays a summary of the active query filters and provides links to remove the currently applied filters.

Usage Notes

  • The Coveo Breadcrumbs rendering provides links to remove applied filters one by one. Each time a user clicks one of these links, a new Search API call is triggered.

  • The Coveo Breadcrumbs rendering also provides a Clear All Filters link which removes all facet filters and triggers a single new Search API call with the current search expression and no facet filtering.

  • The rendering is not displayed when no facet filtering is configured (i.e. the style attribute of the <div> element is set to "display: none;").

Insertion Location

The Coveo Breadcrumbs rendering is an Allowed Control in the following placeholder(s): UI Header, UI Results Header, Results Header

Example insertion sequence for the Coveo Breadcrumbs rendering.

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

Example insertion sequence for the Coveo Breadcrumbs rendering.

Data Source Options

This rendering has no data source.

Sample Generated HTML and Corresponding Visual Output

<div class="CoveoBreadcrumb" style>
Breadcrumbs example output
What's Next for Me?