Accessibility in Coveo Hive

This is for:

Developer System Administrator
Important

The Coveo Hive framework is based on the Coveo JavaScript Search 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.

In the Build Search phase of the Coveo for Sitecore deployment journey, you create Coveo-powered search interfaces in Sitecore in one of two ways:

  • By referencing a classic hosted search page.

  • By building a Coveo for Sitecore search interface from the ground up using Coveo Hive renderings.

Using either of these methods, your search interfaces draws upon the Coveo JavaScript Search Framework.

For example, the .cshtml view file of a Coveo Hive rendering typically outputs the base HTML markup of a Coveo JavaScript Search Framework component. The Framework JavaScript code then expands the base HTML markup to a full-blown multi-element widget during initialization (see JavaScript Search Framework Core Concepts). Whether in the Sitecore Experience Editor or in a published page, the Framework automatically adds ARIA landmarks to the component HTML element(s).

WCAG Conformance

In all releases of Coveo for Sitecore 5, the Coveo JavaScript Search Framework components meet WCAG 2.0 AA requirements. From the August 10, 2020 release of Coveo for Sitecore 5 onwards, these components meet WCAG 2.1 A and AA requirements.

Adding ARIA Landmarks in Coveo for Sitecore Search Interfaces

Coveo provides generic guidelines for adding ARIA landmark role and aria-label attributes to the HTML elements of a Coveo-powered search page, should you deem this necessary.

When referencing a classic hosted search page in a Sitecore item, add ARIA landmark attributes to that search page through its Code View in the Interface Editor.

When assembling Coveo Hive renderings to build a search interface from the ground up, add ARIA landmark attributes at the rendering level, in the .cshtml view file. To ensure your changes don’t get overwritten during a Coveo for Sitecore upgrade, follow the Coveo for Sitecore rendering duplication procedure.

Important

Never edit out-of-the-box Coveo for Sitecore rendering presentation items and view files directly. Always edit duplicates.