Coveo Query Summary

This is for:

Developer System Administrator
Warning
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 QuerySummary component which indicates the currently displayed range of results (for example, Results 1-10 of 123). The component can also be used to show a custom message and search tips when the current query has no matching items.

Insertion location

Coveo Hive

The Coveo Query Summary rendering is an Allowed Control in the following placeholder(s): UI Header, UI Results Header, UI Results Footer, UI Footer, Results Summary Section

Example insertion sequence for the Coveo Query Summary rendering.

Coveo Hive SXA

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

Example insertion sequence for the Coveo Query Summary rendering.

Data source options

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

Option name Description

Enable search tips

See the enableSearchTips component option.

Only display search tips

See the onlyDisplaySearchTips component option.

Display the Cancel Last Action link

See the enableCancelLastAction component option.

Display the No Results Found message

See the enableNoResultsFoundMessage component option.

The custom message to display when there are no search results

See the noResultsFoundMessage component option.

Additional data attributes

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

Sample generated HTML and corresponding visual output

<span class="CoveoQuerySummary" data-no-results-found-message="Oops! No results."></span>

Sample output when query yields results

Query Summary with results example output | Coveo for Sitecore 5

Sample output when query yields no results

Query Summary without results example output | Coveo for Sitecore 5