Results Sorts Section

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.

Coveo for Sitecore Specific Rendering This rendering adds a Sorts dynamic placeholder in which you can insert renderings of the Sorts group.

Usage notes

Coveo for Sitecore 5.0.788.5

  • When the Enable sort dropdown data source option is enabled, the Results Sorts Section rendering wraps the inserted Sorts renderings in a <div class="CoveoSortDropdown"> and makes these sorting options elements of a dropdown list (see the Coveo JavaScript Search Framework SortDropdown component).

  • When the Enable sort dropdown data source option is enabled, and an embedded Sorts rendering has the Enable both sort directions options enabled, two <option> elements are created for this Sorts rendering in the dropdown list, one for each sort direction.

  • See List result sort options in a dropdown for more details about managing sort direction captions.

Insertion location

Coveo Hive

The Results Sorts Section rendering is an Allowed Control in the following placeholder(s): Results Footer Section, Results Header Section

Example insertion sequence for the Results Sorts Section rendering.

Coveo Hive SXA

Coveo for Sitecore (September 18, 2020)

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

Example insertion sequence for the Results Sorts Section rendering.

Data source options

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

Option name Description

Coveo for Sitecore 5.0.788.5

Enable sort dropdown

Specifies whether to convert the embedded Sorts renderings into <option> elements of a dropdown list.

Sample Generated HTML in Experience Editor

<div class="coveo-sort-section scEnabledChrome chromeWithDatasource" sc-part-of="placeholder rendering">
  <code ... ></code>
  <span ... ></span>
  <div class="scEnabledChrome scEmptyPlaceholder"
  sc-placeholder-id="_coveo_ui_coveo_ui_content_dynamic_coveoe28f8e99_coveo_ui_main_section_coveo_ui_results_header_dynamic_coveo922518e0_coveo_ui_results_header_section_dynamic_coveob7049613_coveo_ui_sorts_dynamic_coveob4455694"
  sc-part-of="placeholder"></div>
  <code ... ></code>
</div>

The Results Sorts Section rendering floating toolbar code is purposely omitted.