JavaScript Search Framework Release Notes

Coveo Relevance Cloud Developer JavaScript Search Framework Product Documentation

This page summarizes the new features and bug fixes introduced throughout 2022.

July 2022 Release (v2.10099)

The July 2022 package was initially released as v2.10099.2 You can get the latest version of this release (v2.10099.2):

  • From GitHub (2.10099.2)
  • From npm (npm install coveo-search-ui@2.10099.2)
  • From the Coveo CDN:
Resource1 Script to include
CSS (minified)

With SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10099/2/css/CoveoFullSearch.min.css" integrity="sha512-TBs03XI7M4g24z1tWm/81JbvLmC37V35QJxFCayy4NH0yDZ46d/zYlgO9QxLPBu2DmKEsKQxtqfgOU/GfvIRwA==" crossorigin="anonymous" />

Without SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10099/css/CoveoFullSearch.min.css" />
Framework (lazy loading, minified)

With SRI:2

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10099/2/js/CoveoJsSearch.Lazy.min.js" integrity="sha512-dxN7hWFFWjl6uZM5m0J9Yo8Vh43E0WDJKfmIgIvXRS4tLU2ZAfUAYJk7zjUwX5avvpt6tIpk4TGIAabwmykJOA==" crossorigin="anonymous"></script>

Without SRI:

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10099/js/CoveoJsSearch.Lazy.min.js"></script>
Templates

With SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10099/2/js/templates/templates.js" integrity="sha512-eiSn4qRsVzoRB0c52nRdn8mWn04bANr/LV3rXslk9b+PLN73I6aod28OyEbPTn7iMETKQHlSPESNdosKL/Cp8w==" crossorigin="anonymous"></script>

Without SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10099/js/templates/templates.js"></script>

1: For additional resources, see CDN Links.

2: See Subresource Integrity.

Changes

Issue number Enhancement
JSUI-3414 [SmartSnippetSuggestions] [SmartSnippet] Added the alwaysOpenInNewWindow option.
Issue number Maintenance case
JSUI-3417 PreferencesPanel ResultsFiltersPreferences Fixed issue that impaired accessibility in the Salesforce Agent search page.

June 2022 2nd Release (v2.10098)

The June 2022 package was initially released as v2.10098.1. You can get the latest version of this release (v2.10098.1):

  • From GitHub (2.10098.1)
  • From npm (npm install coveo-search-ui@2.10098.1)
  • From the Coveo CDN:
Resource1 Script to include
CSS (minified)

With SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10098/1/css/CoveoFullSearch.min.css" integrity="sha512-z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==" crossorigin="anonymous" />

Without SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10098/css/CoveoFullSearch.min.css" />
Framework (lazy loading, minified)

With SRI:2

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10098/1/js/CoveoJsSearch.Lazy.min.js" integrity="sha512-z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==" crossorigin="anonymous"></script>

Without SRI:

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10098/js/CoveoJsSearch.Lazy.min.js"></script>
Templates

With SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10098/1/js/templates/templates.js" integrity="sha512-z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==" crossorigin="anonymous"></script>

Without SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10098/js/templates/templates.js"></script>

1: For additional resources, see CDN Links.

2: See Subresource Integrity.

Changes

Issue number Enhancement
JSUI-3385 [SmartSnippetSuggestions] Added the hrefTemplate and titleField options.
JSUI-3405 [DynamicHierarchicalFacet] The component now supports clickable field values.
Issue number Case Maintenance case
JSUI-2383 00048799 Searchbox Fixed issue where pressing the Enter key in the OmniboxResultList wouldn’t forward the user to the full search page.
JSUI-3406 00081288 ResultsFiltersPreferences Fixed issue with single quotes in the filters option leading to unexpected behavior of the GUI.
JSUI-3407 00084025 Searchbox When an end user clicks the search button in the interface, the framework now adds the latest search request to the actionsHistory object while performing a querySuggest request to the Search API.

June 2022 1st Release (v2.10097)

The June 2022 package was initially released as v2.10097.0. You can get the latest version of this release (v2.10097.0):

  • From GitHub (2.10097.0)
  • From npm (npm install coveo-search-ui@2.10097.0)
  • From the Coveo CDN:
Resource1 Script to include
CSS (minified)

With SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10097/0/css/CoveoFullSearch.min.css" integrity="sha512-z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==" crossorigin="anonymous" />

Without SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10097/css/CoveoFullSearch.min.css" />
Framework (lazy loading, minified)

With SRI:2

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10097/0/js/CoveoJsSearch.Lazy.min.js" integrity="sha512-z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==" crossorigin="anonymous"></script>

Without SRI:

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10097/js/CoveoJsSearch.Lazy.min.js"></script>
Templates

With SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10097/0/js/templates/templates.js" integrity="sha512-z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==" crossorigin="anonymous"></script>

Without SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10097/js/templates/templates.js"></script>

1: For additional resources, see CDN Links.

2: See Subresource Integrity.

Changes

Issue number Bug fix
JSUI-3400 ResultLink Fixed issue where every result would have an aria label with the value of ‘Result’.
Issue number Case Maintenance case
JSUI-3401 00080286 SearchInterface Fixed issue in versions 2.10092.7 and later where the data-allow-queries-without-keywords options set to true could make search tabs overflow the search interface on pages with a small width.

May 2022 Release (v2.10096)

The May 2022 package was initially released as v2.10096.1. You can get the latest version of this release (v2.10096.1):

  • From GitHub (2.10096.1)
  • From npm (npm install coveo-search-ui@2.10096.1)
  • From the Coveo CDN:
Resource1 Script to include
CSS (minified)

With SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10096/1/css/CoveoFullSearch.min.css" integrity="sha512-TBs03XI7M4g24z1tWm/81JbvLmC37V35QJxFCayy4NH0yDZ46d/zYlgO9QxLPBu2DmKEsKQxtqfgOU/GfvIRwA==" crossorigin="anonymous" />

Without SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10096/css/CoveoFullSearch.min.css" />
Framework (lazy loading, minified)

With SRI:2

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10096/1/js/CoveoJsSearch.Lazy.min.js" integrity="sha512-+qDmnye0XNb5Sj5CSXgzGPCUri67W38V2D0qbLYtx7pUBYQ2K2sPOwO3wHbnQlofvKG99BS85QqEt53LwUW7ZQ==" crossorigin="anonymous"></script>

Without SRI:

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10096/js/CoveoJsSearch.Lazy.min.js"></script>
Templates

With SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10096/1/js/templates/templates.js" integrity="sha512-eiSn4qRsVzoRB0c52nRdn8mWn04bANr/LV3rXslk9b+PLN73I6aod28OyEbPTn7iMETKQHlSPESNdosKL/Cp8w==" crossorigin="anonymous"></script>

Without SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10096/js/templates/templates.js"></script>

1: For additional resources, see CDN Links.

2: See Subresource Integrity.

Changes

Issue number Bug fix
JSUI-3392 [QuerySuggestPreview] Fixed issue where the component wouldn’t work in the search box initialized as an external component.

April 2022 3rd Release (v2.10095)

The April 2022 3rd package was initially released as v2.10095.4. You can get the latest version of this release (v2.10095.4):

  • From GitHub (2.10095.4)
  • From npm (npm install coveo-search-ui@2.10095.4)
  • From the Coveo CDN:
Resource1 Script to include
CSS (minified)

With SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10095/4/css/CoveoFullSearch.min.css" integrity="sha512-TBs03XI7M4g24z1tWm/81JbvLmC37V35QJxFCayy4NH0yDZ46d/zYlgO9QxLPBu2DmKEsKQxtqfgOU/GfvIRwA==" crossorigin="anonymous" />

Without SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10095/css/CoveoFullSearch.min.css" />
Framework (lazy loading, minified)

With SRI:2

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10095/4/js/CoveoJsSearch.Lazy.min.js" integrity="sha512-lnAeLRIW56ExwEp16YYu1+Z3mt+Or5s3MHRKMXroc8mbPZ5j2FRKkEByp3CCNixZkC90/vJ/S7zgOO/Ydo4nng==" crossorigin="anonymous"></script>

Without SRI:

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10095/js/CoveoJsSearch.Lazy.min.js"></script>
Templates

With SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10095/4/js/templates/templates.js" integrity="sha512-eiSn4qRsVzoRB0c52nRdn8mWn04bANr/LV3rXslk9b+PLN73I6aod28OyEbPTn7iMETKQHlSPESNdosKL/Cp8w==" crossorigin="anonymous"></script>

Without SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10095/js/templates/templates.js"></script>

1: For additional resources, see CDN Links.

2: See Subresource Integrity.

Changes

Issue number Case Maintenance case
JSUI-3383 00078160 Fixed issue in versions 2.10095.1 and later where the framework could fire an error with the text this.UsageAnalytics.getOriginContext is not a function.

April 2022 2nd Release (v2.10095)

The April 2022 2nd package was initially released as v2.10095.3. You can get the latest version of this release (v2.10095.3):

  • From GitHub (2.10095.3)
  • From npm (npm install coveo-search-ui@2.10095.3)
  • From the Coveo CDN:
Resource1 Script to include
CSS (minified)

With SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10095/3/css/CoveoFullSearch.min.css" integrity="sha512-TBs03XI7M4g24z1tWm/81JbvLmC37V35QJxFCayy4NH0yDZ46d/zYlgO9QxLPBu2DmKEsKQxtqfgOU/GfvIRwA==" crossorigin="anonymous" />

Without SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10095/css/CoveoFullSearch.min.css" />
Framework (lazy loading, minified)

With SRI:2

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10095/3/js/CoveoJsSearch.Lazy.min.js" integrity="sha512-angzbF1txx+zVqNpDCVh/2zWb1OSPtsBtkrVf6tTB8vNb2iTYq6JeSjUaLAseq9OxVodGJ3HNaAVsMhOtlXL4w==" crossorigin="anonymous"></script>

Without SRI:

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10095/js/CoveoJsSearch.Lazy.min.js"></script>
Templates

With SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10095/3/js/templates/templates.js" integrity="sha512-eiSn4qRsVzoRB0c52nRdn8mWn04bANr/LV3rXslk9b+PLN73I6aod28OyEbPTn7iMETKQHlSPESNdosKL/Cp8w==" crossorigin="anonymous"></script>

Without SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10095/js/templates/templates.js"></script>

1: For additional resources, see CDN Links.

2: See Subresource Integrity.

Changes

Issue number Case Maintenance case
JSUI-3382 00078543 [CoveoPager] Fixed issue where the element could have hidden focusable descendants that would be inaccessible for screen readers.

April 2022 1st Release (v2.10095)

The April 2022 1st package was initially released as v2.10095.2. You can get the latest version of this release (v2.10095.2):

  • From GitHub (2.10095.2)
  • From npm (npm install coveo-search-ui@2.10095.2)
  • From the Coveo CDN:
Resource1 Script to include
CSS (minified)

With SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10095/2/css/CoveoFullSearch.min.css" integrity="sha512-TBs03XI7M4g24z1tWm/81JbvLmC37V35QJxFCayy4NH0yDZ46d/zYlgO9QxLPBu2DmKEsKQxtqfgOU/GfvIRwA==" crossorigin="anonymous" />

Without SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10095/css/CoveoFullSearch.min.css" />
Framework (lazy loading, minified)

With SRI:2

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10095/2/js/CoveoJsSearch.Lazy.min.js" integrity="sha512-xMxiflWTjXIGs/ukigdKbip3smzQVZlKWtts8vAPRMstzXPRPe72W6ujMXrtdmaB5QqckSjhNfRllziBlPdL1Q==" crossorigin="anonymous"></script>

Without SRI:

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10095/js/CoveoJsSearch.Lazy.min.js"></script>
Templates

With SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10095/2/js/templates/templates.js" integrity="sha512-eiSn4qRsVzoRB0c52nRdn8mWn04bANr/LV3rXslk9b+PLN73I6aod28OyEbPTn7iMETKQHlSPESNdosKL/Cp8w==" crossorigin="anonymous"></script>

Without SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10095/js/templates/templates.js"></script>

1: For additional resources, see CDN Links.

2: See Subresource Integrity.

Changes

Issue number Bug fix
JSUI-3374 [FacetsMobileMode] The facets now appear in a modal by default when expanded in mobile responsive mode. It is possible to go back to the previous behavior by setting the isModal option to false.
Issue number Case Maintenance case
JSUI-3369 00076710 [ResultLink] Fixed issue where setting tabindex to -1 would not work.
JSUI-3373 00074337 [MissingTerms] Fixed issue where behavior would vary when dots where used in keywords.
JSUI-3377 00075234 [ResultsPerPage] Fixed issue where behavior was inconsistent when choicesDisplayed and initialChoice were set to different values.

March 2022 Release (v2.10094)

The March 2022 package was initially released as v2.10094.3. You can get the latest version of this release (v2.10094.3):

  • From GitHub (2.10094.3)
  • From npm (npm install coveo-search-ui@2.10094.3)
  • From the Coveo CDN:
Resource1 Script to include
CSS (minified)

With SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10094/3/css/CoveoFullSearch.min.css" integrity="sha512-TBs03XI7M4g24z1tWm/81JbvLmC37V35QJxFCayy4NH0yDZ46d/zYlgO9QxLPBu2DmKEsKQxtqfgOU/GfvIRwA==" crossorigin="anonymous" />

Without SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10094/css/CoveoFullSearch.min.css" />
Framework (lazy loading, minified)

With SRI:2

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10094/3/js/CoveoJsSearch.Lazy.min.js" integrity="sha512-0TQxte3BQBFm6LMBjWvy7BSL3OfnzWeZan5bGVd2B/If/9wIYL7ipAWDRtI8HsM08TwP0c6DYnhfy9cOGe56hg==" crossorigin="anonymous"></script>

Without SRI:

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10094/js/CoveoJsSearch.Lazy.min.js"></script>
Templates

With SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10094/3/js/templates/templates.js" integrity="sha512-eiSn4qRsVzoRB0c52nRdn8mWn04bANr/LV3rXslk9b+PLN73I6aod28OyEbPTn7iMETKQHlSPESNdosKL/Cp8w==" crossorigin="anonymous"></script>

Without SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10094/js/templates/templates.js"></script>

1: For additional resources, see CDN Links.

2: See Subresource Integrity.

Changes

Issue number Enhancement
JSUI-3348 [DynamicFacet] The role of DynamicFacet values is now checkbox instead of button.
JSUI-3359 The framework now sends the customData and actionCause key-value pairs to the Search API while performing search queries.
Issue number Bug fix
JSUI-3346 [Breadcrumb] Fixed issue where <li> elements would have nested heading elements (<h1>, <h2>, etc.).
JSUI-3347 [DynamicFacet] Fixed issue where selecting or clearing a DynamicFacet checkbox via keyboard would lead to losing focus on that checkbox. Also, fixed issue where clearing a checkbox would make the page scroll up.
JSUI-3353 [DynamicFacet] This component now doesn’t apply aq to folded child results.
JSUI-3354 [SmartSnippet] Also, fixed issue where the survey wouldn’t close after submitting. Fixed issue where the explain why modal window wouldn’t open via pressing the Enter key.
Issue number Case Maintenance case
JSUI-3357 00075994 Dependent facets now become disabled if their parent is disabled.

February 2022 Release (v2.10093)

The February 2022 package was initially released as v2.10093.4 You can get the latest version of this release (v2.10093.4):

  • From GitHub (2.10093.4)
  • From npm (npm install coveo-search-ui@2.10093.4)
  • From the Coveo CDN:
Resource1 Script to include
CSS (minified)

With SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10093/4/css/CoveoFullSearch.min.css" integrity="sha512-KxEGMZiFvOW8ftwCreuUAE7vA7oMaV8dohgb5rHClHOg4BEq0bleZKy7B75KCdNtGbj0I+Jjy5z6i+mJ9g+yIA==" crossorigin="anonymous" />

Without SRI:

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.10093/css/CoveoFullSearch.min.css" />
Framework (lazy loading, minified)

With SRI:2

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10093/4/js/CoveoJsSearch.Lazy.min.js" integrity="sha512-wq21KRc/kpKncWYC+LRC5D1mw0ZIs7EJE4V3I3w6paHXKUsnRy2tP1DF9UjEyV23lY3lzOZH0VhXBauMF7Rikw==" crossorigin="anonymous"></script>

Without SRI:

<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.10093/js/CoveoJsSearch.Lazy.min.js"></script>
Templates

With SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10093/4/js/templates/templates.js" integrity="sha512-eiSn4qRsVzoRB0c52nRdn8mWn04bANr/LV3rXslk9b+PLN73I6aod28OyEbPTn7iMETKQHlSPESNdosKL/Cp8w==" crossorigin="anonymous"></script>

Without SRI:

<script src="https://static.cloud.coveo.com/searchui/v2.10093/js/templates/templates.js"></script>

1: For additional resources, see CDN Links.

2: See Subresource Integrity.

Changes

Issue number Bug fix
JSUI-3345 [CoveoResultActionsMenu] Fixed issue where an error was fired if CoveoResultActionsMenu was used inside a folded result template.
JSUI-3355 [Analytics] Fixed issue where the Search Hub wouldn’t be set in search requests when analytics were disabled in the browser.
Issue number Case Maintenance case
JSUI-1775 00038408 Fixed issue where RequireJS Optimizer fired an error on anonymous define() functions.
JSUI-3332 00074668 The JAWS reading software now reads information in the filter panel when it appears on the page.
JSUI-3334 00074658 [CoveoFieldValue] Fixed issue where CoveoFieldValue set to decimal, integer, or double didn’t display the value 0 in the result template.
JSUI-3337 00075079 Fixed issue when it was impossible to dynamically load JSUI via a SharePoint Framework customizer.
JSUI-3343 00075573 [CoveoDidYouMean] Fixed issue where a page with CoveoDidYouMean might generate more than a thousand events in few seconds.
What's next for me?