August 2018 Release (v2.4609.6)

This page summarizes the new features and bug fixes introduced in the August 2018 Release (2.4609.6).

To download this release:

Resource Script to include
Coveo JavaScript Search Framework (minified)
<!-- Coveo JavaScript Search Framework (with lazy loading) -->
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.4609/js/CoveoJsSearch.Lazy.min.js"></script>
<!-- If you prefer to use the eager loading version, use the following link instead -->
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.4609/js/CoveoJsSearch.min.js"></script>
CSS
<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.4609/css/CoveoFullSearch.css"/>
Result templates
<script src="https://static.cloud.coveo.com/searchui/v2.4609/js/templates/templates.js"></script>

For more available resources, see CDN Links.

Release Highlights

[JSUI-2112] Customize the No Results Message

The QuerySummary component now has several new options which allow you to customize the message to display in a search page when a query yields no results.

You can specify a custom message as a simple string through the component markup (see the noResultsFoundMessage and enableNoResultsFoundMessage options), and/or use custom HTML (by including it inside an element with the coveo-show-if-no-results class).

The upcoming JavaScript Interface Editor release will leverage these enhancements to allow easier No results message customization.

[JSUI-2124/2166/2169/2199] WCAG 2.0 AA Compliance

Many internal changes were made to various component to ensure they are usable by people with vision impairment or other disabilities. Visually, subtle color changes will be noticeable, especially for all clickable elements (e.g., ResultLink components).

You may also want to add ARIA landmarks to your search page to make it even more accessible (see Adding ARIA Landmarks).

[JSUI-2153] Exponential Backoff Mechanism

This enhancement is aimed at improving end-user experience in some corner-case situations where the Search API would rightfully throttle very fast, successive search requests. Rather than eventually responding with 429 Too Many Requests (i.e., Oops, something went wrong), those queries will now typically respond successfully (though somewhat slower).

Full Release Notes

Issue Number Enhancement
JSUI-2112 [QuerySummary] Add options to customize the ‘No Results’ message/template.
JSUI-2124 Add ARIA button role to applicable clickable elements.
JSUI-2166 [Omnibox] Add ARIA attributes to combobox/listbox inputs.
JSUI-2169 [Searchbox] Support clearing the search box input with Tab + Enter.
JSUI-2199 [ErrorReport] Improve error report accessibility.
JSUI-2153 Add an exponential backoff mechanism to recover from 429 Too Many Requests response status.
JSUI-2108 [Facet] Log a Custom usage analytics event when a facet sort criteria/direction changes.
JSUI-2172 Add a new, dedicated component option type for options expecting a query expression as a value.
Issue Number Case Maintenance Case
JSUI-2163 00044139 [SearchInterface] Add options to configure global responsive breakpoints.
JSUI-2159 00044129 Fixed issue where pagination was incorrect if the number of results was modified in the query pipeline.
JSUI-2189 00044483 Reset and hide dependent facet when the parent facet no longer has any selected/excluded values.
Issue Number Bug Fix
JSUI-2058 [SearchInterface/DidYouMean] Fixed issue where the back button did not work as expected with the auto-correction feature.
JSUI-2071 [ResultList] Fixed issue where infinite scroll did not detect its actual scrolling container.
JSUI-2074 [OmniboxResultList] Fixed issue where the Omnibox result list was partially hidden in some layouts.
JSUI-2077 [SimpleFilter] Fixed issue that caused an error to be logged in the console when interacting with simple filters.
JSUI-2137 [Facet] Fixed issue where a facet with a custom ID was unable to read its state from the hash portion of the URL .
JSUI-2155 Fixed issue where the debug panel did not function properly when used in a page of results other than the first.
JSUI-2181 [DateUtils] Fixed issue where the dateTimeToString method did not correctly apply its predefined format.
JSUI-2187 [ResultActionMenu] Fixed issue where the results action menu did not stay opened when clicked.