---
title: V2 2019 releases
slug: '3277'
canonical_url: https://docs.coveo.com/en/3277/
collection: javascript-search-framework
source_format: adoc
---
# V2 2019 releases
This page summarizes the new features and bug fixes introduced throughout 2019.

> **Note**
>
> The latest changes are available in [Release notes](https://docs.coveo.com/en/328/).

[#2-7610]
## December 2019 release (v2.7610)

The December 2019 package was initially released as v2.7610.7.

**CDN links for JavaScript Search Framework v2.7610.10**

- [GitHub release](https://github.com/coveo/search-ui/releases/tag/v2.7610.10)
- npm: `npm install coveo-search-ui@2.7610.10`
- CDN resources:
  - JavaScript (lazy, minified): `https://static.cloud.coveo.com/searchui/v2.7610.10/js/CoveoJsSearch.Lazy.min.js`
  - Stylesheet (minified): `https://static.cloud.coveo.com/searchui/v2.7610.10/css/CoveoFullSearch.min.css`
  - Templates: `https://static.cloud.coveo.com/searchui/v2.7610.10/js/templates/templates.js`
### Release highlights

#### New pilot component: `QuerySuggestPreview`

_Issue numbers: JSUI-2685, JSUI-2693_

pass:a[<span class="tag pilot" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Available feature deactivated by default that can be activated from the product UI or API"><a href="https://docs.coveo.com/en/1506/">Pilot Feature</a></span>]

The pilot [`QuerySuggestPreview`](https://coveo.github.io/search-ui/components/querysuggestpreview.html) component allows you to display the most relevant results when hovering over a Coveo ML query suggestion in the [`Omnibox`](https://coveo.github.io/search-ui/components/omnibox.html).

See [Rendering query suggestion result previews](https://docs.coveo.com/en/340#rendering-query-suggestion-result-previews).

```html
<!-- ... -->
<div class="CoveoQuerySuggestPreview"></div>
<div class="CoveoSearchbox"></div>
<!-- ... -->
```



#### New `DynamicFacet` option: `dependsOn`

_Issue number: JSUI-2643_

The [`DynamicFacet`](https://coveo.github.io/search-ui/components/dynamicfacet.html) and [`DynamicFacetRange`](https://coveo.github.io/search-ui/components/dynamicfacetrange.html) components now have a [`dependsOn`](https://coveo.github.io/search-ui/components/dynamicfacet.html#options.dependson) option allowing you to display a "dependent" facet only when a value is selected in its specified "parent".

See [Use dynamic facets](https://docs.coveo.com/en/2917/).

```html
<!-- ... -->
<div class="CoveoDynamicFacetManager">
  <div class="CoveoDynamicFacet"
       data-id="facet-filetype"
       data-title="File Type"
       data-field="@filetype"
       data-tab="All"></div>
  <div class="CoveoDynamicFacetRange"
       data-title="File Size"
       data-field="@syssize"
       data-depends-on="facet-filetype"
       data-ranges='[{"start":0,"end":1000},{"start":1000,"end":5000}]'></div>
</div>
<!-- ... -->
```



#### Did you mean localized string customization

_Issue number: JSUI-2679_

You can now specify where the query appears in custom localized text for the [`DidYouMean`](https://coveo.github.io/search-ui/components/didyoumean.html) component.

See [Change the language of your search interface](https://docs.coveo.com/en/421/).

```html
<!-- ... -->
<script src="https://static.cloud.coveo.com/searchui/v2.7610/js/cultures/pl.js"></script>
<script>
String.toLocaleString({
  "pl": {
    "didYouMean": "Czy chodziło Ci o : {0} a nie o"
  }
});
</script>
<!-- ... -->
```



### Other changes

|===
| Issue number | Enhancement

| JSUI-2645
| [[`Tab`](https://coveo.github.io/search-ui/components/tab.html)] Allow responsive behavior when initializing the component while it's hidden.

| JSUI-2689
| [[`Facet`](https://coveo.github.io/search-ui/components/facet.html)] Use lowercase values for the [`sortCriteria`](https://coveo.github.io/search-ui/components/facet.html#options.sortcriteria) option.

| JSUI-2701
| [[`ICommerceRequest`](https://coveo.github.io/search-ui/interfaces/icommercerequest.html)] Support the [`filter`](https://coveo.github.io/search-ui/interfaces/icommercerequest.html#filter) and [`operation`](https://coveo.github.io/search-ui/interfaces/icommercerequest.html#operation) properties.
|===

|===
| Issue number | Case | Maintenance case

| JSUI-2636
| 00055912
| Fixed several in-product external documentation links.

| JSUI-2644
| 00056043
| [[`FacetSlider`](https://coveo.github.io/search-ui/components/facetslider.html)] Fixed issue where the component would sometimes disappear when selecting values in other facets.

| JSUI-2728
| 00057466
| [[`CategoryFacet`](https://coveo.github.io/search-ui/components/categoryfacet.html)] Fixed issue where component was showing even when there were no values to display.

| JSUI-2748
| 00057676
| [[`FieldSuggestions`](https://coveo.github.io/search-ui/components/fieldsuggestions.html)] Fixed issue where clicking a field suggestion would clear the search box and trigger an empty query rather than triggering the expected query.
|===

|===
| Issue number | Bug fix

| JSUI-2661
| [[`Omnibox`](https://coveo.github.io/search-ui/components/omnibox.html)] Fixed issue where the currently focused query suggestion wasn't cleared when entering a new query.

| JSUI-2662
| Fixed issue where the keyboard Enter key couldn't be used to select a new tab when jQuery was loaded in a page.

| JSUI-2682
| Fixed issue where the search button had to be clicked twice to execute a query when multiple search boxes were initialized in the search interface.

| JSUI-2721 / JSUI-2737
| Refactored the usage analytics data logged by the `DynamicFacet` and `DynamicFacetRange` components.

| JSUI-2730
| [[`DynamicFacetRange`](https://coveo.github.io/search-ui/components/dynamicfacetrange.html)] Fixed issue where Firefox was unable to parse string date ranges.
|===

[#2-7219]
## October 2019 release (v2.7219)

The October 2019 package was initially released as v2.7219.9.

**CDN links for JavaScript Search Framework v2.7219.22**

- [GitHub release](https://github.com/coveo/search-ui/releases/tag/v2.7219.22)
- npm: `npm install coveo-search-ui@2.7219.22`
- CDN resources:
  - JavaScript (lazy, minified): `https://static.cloud.coveo.com/searchui/v2.7219.22/js/CoveoJsSearch.Lazy.min.js`
  - Stylesheet (minified): `https://static.cloud.coveo.com/searchui/v2.7219.22/css/CoveoFullSearch.min.css`
  - Templates: `https://static.cloud.coveo.com/searchui/v2.7219.22/js/templates/templates.js`
### Release highlights

#### Invert `Omnibox` suggestion highlighting

_Issue number: JSUI-2325_

According to recent UX research, the leading practice when it comes to designing autocomplete widgets is to highlight differences rather than the original text entered by the end user.
Doing so helps the end user focus on what would end up being added to their query if they select a given suggestion.

The framework now applies this principle when [providing search box suggestions](https://docs.coveo.com/en/340/).

**Before:**



**Now:**



> **Important**
>
> This change may cause styling issues in solutions that have customized the way Omnibox suggestions are being highlighted.

#### Clear session information and disable analytics

_Issue number: JSUI-2518_

To make it easier for developers to implement GDPR-compliant consent/withdrawal mechanisms, three new top-level functions are now available:

* [`clearLocalData`](https://coveo.github.io/search-ui/globals.html#clearlocaldata) deletes all session information stored in the browser by the framework for [Coveo Analytics](https://docs.coveo.com/en/182/) purposes (for example, [visitor ID](https://docs.coveo.com/en/273/) cookie, actions history, etc.).

* [`disableAnalytics`](https://coveo.github.io/search-ui/globals.html#disableanalytics) calls `clearLocalData`, and then deactivates usage analytics in a search interface.
* [`enableAnalytics`](https://coveo.github.io/search-ui/globals.html#enableanalytics) re-activates usage analytics in a search interface.

See also [Disable Coveo UA in a search interface?](https://docs.coveo.com/en/2795#disable-coveo-ua-in-a-search-interface).

#### New pilot component: `DynamicFacetRange`

pass:a[<span class="tag pilot" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Available feature deactivated by default that can be activated from the product UI or API"><a href="https://docs.coveo.com/en/1506/">Pilot Feature</a></span>]

_Issue numbers: JSUI-2586, JSUI-2633, JSUI-2638_

The new [`DynamicFacetRange`](https://coveo.github.io/search-ui/components/dynamicfacetrange.html) component is now available as a pilot feature, allowing you to further leverage the [Coveo Machine Learning (Coveo ML)](https://docs.coveo.com/en/188/) [Dynamic Navigation Experience (DNE)](https://docs.coveo.com/en/2907/) feature in your search interfaces.

See:

* [Use dynamic facets](https://docs.coveo.com/en/2917/)
* [Use dynamic facets](https://docs.coveo.com/en/2917/)

```html
<div id="search" class="CoveoSearchInterface">
  <div class="coveo-facet-column">
    <div class="CoveoDynamicFacetManager">
      <div id="ViewsFacet" class="CoveoDynamicFacetRange"
           data-title="Views"
           data-field="@views">
      </div>
    </div>
</div>
```

```javascript
document.addEventListener("DOMContentLoaded", () => {
  const viewsFacetRanges = [
    { "start": 0, "end": 250 },
    { "start": 250, "end": 500 },
    { "start": 500, "end": 1000 },
    { "start": 1000, "end": 2500 },
    { "start": 2500, "end": 5000 }
  ];
  Coveo.init(document.body, {
    ViewsFacet: { ranges: viewsFacetRanges }
  });
});
```



### Other changes

|===
| Issue number | Case | Maintenance case

| JSUI-2641
| 00055430
| [[`Facet`](https://coveo.github.io/search-ui/components/facet.html)] Fixed display issue with settings menu.

| JSUI-2649
| 00054917
| [[`Pager`](https://coveo.github.io/search-ui/components/pager.html)] Fixed issue where navigating with browser **Back** button could lead to wrong result page.
|===

|===
| Issue number | Bug fix

| JSUI-2572
| Fixed issue where field names containing underscore (`_`) characters weren't considered when the [`autoSelectFieldsToInclude`](https://coveo.github.io/search-ui/components/resultlist.html#options.autoselectfieldstoinclude) [`ResultList`](https://coveo.github.io/search-ui/components/resultlist.html) option was enabled.

| JSUI-2614
| Fixed issue where `customIdValue` wasn't kept when sent in usage analytics event `customData`.

| JSUI-2620
| Fixed issue where some hyperlinks were difficult to read on YouTube results with default card template.

| JSUI-2637
| [[`DynamicFacetManager`](https://coveo.github.io/search-ui/components/dynamicfacetmanager.html)] Fixed issue where [`DynamicFacet`](https://coveo.github.io/search-ui/components/dynamicfacet.html) components without values were removed from the DOM when switching tabs.

| JSUI-2639
| [External [`Omnibox`](https://coveo.github.io/search-ui/components/omnibox.html)] Fixed issue where events were triggered from the Omnibox element rather than from the root element.

| JSUI-2646
| [[`Tab`](https://coveo.github.io/search-ui/components/tab.html)] Fixed display issue in responsive mode.
|===

### Additional changes in maintenance versions

#### v2.7219.22

|===
| Issue number | Bug fix

| JSUI-2715
| Fixed issue where facets could be in a hovered state on touch-enabled (that is, mobile) devices.
|===

#### v2.7219.15

|===
| Issue number | Bug fix

| JSUI-2688
| Fixed issue where two query suggestion requests were sent when clicking in the search box.
|===

#### v2.7219.11

|===
| Issue number | Case | Enhancement

| JSUI-2677
| 11156520
| [Searchbox] Fixed issue where Left and Right arrow keys had no effect.
|===

[#2-7023]
## September 2019 release (v2.7023)

The September 2019 package was initially released as v2.7023.4.

**CDN links for JavaScript Search Framework v2.7023.9**

- [GitHub release](https://github.com/coveo/search-ui/releases/tag/v2.7023.9)
- npm: `npm install coveo-search-ui@2.7023.9`
- CDN resources:
  - JavaScript (lazy, minified): `https://static.cloud.coveo.com/searchui/v2.7023.9/js/CoveoJsSearch.Lazy.min.js`
  - Stylesheet (minified): `https://static.cloud.coveo.com/searchui/v2.7023.9/css/CoveoFullSearch.min.css`
  - Templates: `https://static.cloud.coveo.com/searchui/v2.7023.9/js/templates/templates.js`
### Release highlights

#### New result template component: `ImageFieldValue`

_Issue number: JSUI-2570_

The new [`ImageFieldValue`](https://coveo.github.io/search-ui/components/imagefieldvalue.html) result template component makes it easier to leverage fields pointing to image URLs in query results.

```html
<!-- ... -->
<div class="CoveoResultList">

  <script type="text/html" class="result-template" data-field-photourl">
    <div class="coveo-result-frame">
      <div class="coveo-result-row">
        <div class="coveo-result-cell">
          <div class="CoveoResultLink"></div>
        </div>
      </div>
      <div class="coveo-result-row">
        <div class="coveo-result-cell">
          <div class="CoveoImageFieldValue" data-field="@photourl"></div>
        </div>
        <div class="coveo-result-cell">
          <div class="CoveoExcerpt"></div>
        </div>
      </div>
    </div>
  </script>

</div>
<!-- ... -->
```



#### New `CategoryFacet` option: `dependsOn`

_Issue number: JSUI-2471_

The new [`dependsOn`](https://coveo.github.io/search-ui/components/categoryfacet.html#options.dependson) option of the [`CategoryFacet`](https://coveo.github.io/search-ui/components/categoryfacet.html) component allows you to hide a category facet unless one or more values are selected in another specific facet.

```html
<!-- ... -->
<div class="CoveoFacet" data-id="StoreFacet" data-field="@store" data-title="Store">
<div class="CoveoCategoryFacet" data-field="@categories" data-title="Category" data-depends-on="StoreFacet">
<!-- ... -->
```



#### New `Omnibox` option: `clearFiltersOnNewQuery`

You can set the new [`clearFiltersOnNewQuery`](https://coveo.github.io/search-ui/components/omnibox.html#options.clearfiltersonnewquery) option of the [`Omnibox`](https://coveo.github.io/search-ui/components/omnibox.html) component to `true` to automatically reset all advanced query filters when the end user submits a new query from the search box.

```html
<!-- ... -->
<div class="CoveoOmnibox" data-clear-filters-on-new-query="true">
<!-- ... -->
```



#### Improved pilot component: DynamicFacet

pass:a[<span class="tag pilot" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Available feature deactivated by default that can be activated from the product UI or API"><a href="https://docs.coveo.com/en/1506/">Pilot Feature</a></span>]

_Issue numbers: JSUI-2450, JSUI-2528, JSUI-2552_

The [`DynamicFacet`](https://coveo.github.io/search-ui/components/dynamicfacet.html) component now supports facet search.



The component has also been improved in several other ways (see [Other changes](#other-changes)).

#### Improved pilot component: DynamicFacetManager

pass:a[<span class="tag pilot" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Available feature deactivated by default that can be activated from the product UI or API"><a href="https://docs.coveo.com/en/1506/">Pilot Feature</a></span>]

_Issue number: JSUI-2571_

The new [`maximumNumberOfExpandedFacets`](https://coveo.github.io/search-ui/components/dynamicfacetmanager.html#options.maximumnumberofexpandedfacets) option of the [`DynamicFacetManager`](https://coveo.github.io/search-ui/components/dynamicfacetmanager.html) component allows you to specify how many of its embedded dynamic facets should be expanded when your search interface loads.

```html
<!-- ... -->
<div class="CoveoDynamicFacetManager" data-maximum-number-of-expanded-facets="2">
  <div class="CoveoDynamicFacet" data-title="Type" data-field="@objecttype"></div>
  <div class="CoveoDynamicFacet" data-title="FileType" data-field="@filetype"></div>
  <div class="CoveoDynamicFacet" data-title="Author" data-field="@author"></div>
</div>
<!-- ... -->
```



### Other changes

|===
| Issue number | Enhancement

| JSUI-2591
| Log a warning when a result template doesn't contain a [`ResultLink`](https://coveo.github.io/search-ui/components/resultlink.html) component.

| JSUI-2462
| [[`DynamicFacet`](https://coveo.github.io/search-ui/components/dynamicfacet.html)] Prevent show more/less from triggering a full search query.

| JSUI-2504
| [`DynamicFacet`] Remove the `preservePosition` option and replace it with [`enableScrollToTop`](https://coveo.github.io/search-ui/components/dynamicfacet.html#options.enablescrolltotop).

| JSUI-2547 / JSUI-2604
| [`DynamicFacet`] Refactor and improve dynamic facet state usage analytics metadata
|===

|===
| Issue number | Case | Maintenance case

| JSUI-2576
| 00047446
| [[`Facet`](https://coveo.github.io/search-ui/components/facet.html)] Fixed issue where specifying an [`additionalFilter`](https://coveo.github.io/search-ui/components/facet.html#options.additionalfilter) caused only the selected facet values to be shown if the search box contained a query.

| JSUI-2594
| 00053573
| Fixed issue where navigating back in history had no effect when a category facet value and other facets values were selected in a no results page.

| JSUI-2600
| 00053573
| [`Facet`] Fixed z-index issue with the `coveo-facet-value-exclude` CSS class
|===

|===
| Issue number | Bug fix

| JSUI-2304
| Fixed issue where custom events weren't handled properly with Locker Service (Coveo for Salesforce).

| JSUI-2512
| [`Facet`] Fixed issue where facet values weren't updated correctly when using the [`dependsOn`](https://coveo.github.io/search-ui/components/facet.html#options.dependson) option.

| JSUI-2516
| [[`ResultList`](https://coveo.github.io/search-ui/components/resultlist.html)] Fixed issue where the [`enableScrollToTop`](https://coveo.github.io/search-ui/components/resultlist.html#options.enablescrolltotop) option didn't work with Locker Service (Coveo for Salesforce).

| JSUI-2540
| [`Facet`] Fixed issue where facet fields were still clickable in query results when a facet was hidden because of the `dependsOn` option.

| JSUI-2563
| Fixed Quickview button alignment issue with folded children in default result templates.

| JSUI-2583
| [`Facet`] Fixed issue where facet settings were partially hidden when the facet column was in a scroll container.

| JSUI-2584
| [[`DateUtils`](https://coveo.github.io/search-ui/classes/dateutils.html)] Fixed regular expression syntax that caused issues with some browsers.

| JSUI-2593
| [[`TimespanFacet`](https://coveo.github.io/search-ui/components/timespanfacet.html)] Fixed issue where including a TimespanFacet always logged a _duplicate ID_ warning.

| JSUI-2559, JSUI-2596, JSUI-2595, JSUI-2597, JSUI-2598, JSUI-2599
| Fixed various accessibility issues.
|===

### Additional change in maintenance version

#### v2.7023.9

|===
| Issue number | Case | Enhancement

| JSUI-2640
| 00055330
| [Coveo for Salesforce/Locker Service] Fixed issue where fetching more results in infinite scroll didn't work.
|===

[#2-6459]
## July 2019 release (v2.6459)

The July 2019 package was initially released as v2.6459.4.

**CDN links for JavaScript Search Framework v2.6459.11**

- [GitHub release](https://github.com/coveo/search-ui/releases/tag/v2.6459.11)
- npm: `npm install coveo-search-ui@2.6459.11`
- CDN resources:
  - JavaScript (lazy, minified): `https://static.cloud.coveo.com/searchui/v2.6459.11/js/CoveoJsSearch.Lazy.min.js`
  - Stylesheet (minified): `https://static.cloud.coveo.com/searchui/v2.6459.11/css/CoveoFullSearch.min.css`
  - Templates: `https://static.cloud.coveo.com/searchui/v2.6459.11/js/templates/templates.js`
### Release highlights

#### New component: `MissingTerms`

_Issue number: JSUI-2454_

The new [`MissingTerms`](https://coveo.github.io/search-ui/components/missingterms.html) result template component renders a list of query terms that weren't matched by a given result item.
This component is now included in the default result templates.

By default, the component allows the end user to click any missing term to filter out items that don't match this term (see the [`clickable`](https://coveo.github.io/search-ui/components/missingterms.html#options.clickable) option).



#### New analytics feature: Push events to Google Tag Manager data layer

_Issue number: JSUI-2467_

The [`Analytics`](https://coveo.github.io/search-ui/components/analytics.html) component can now be configured to automatically push usage analytics events to a properly initialized Google Tag Manager data layer object.

Among other things, this new feature enables you to log usage analytics data from a Coveo JavaScript Search Framework interface to Google Analytics (see [Log Search Page Usage Analytics Data to Google Analytics](https://docs.coveo.com/en/2943/)).



#### New `Searchbox` option: `height`

_Issue number: JSUI-2349_

The new [`height`](https://coveo.github.io/search-ui/components/searchbox.html#options.height) option of the [`Searchbox`](https://coveo.github.io/search-ui/components/searchbox.html) component makes it easy to resize the searchbox without writing any custom CSS.



#### New `Omnibox` option: `querySuggestCharacterThreshold`

_Issue number: JSUI-2458_

The new [`querySuggestCharacterThreshold`](https://coveo.github.io/search-ui/components/omnibox.html#options.querysuggestcharacterthreshold) option of the [`Omnibox`](https://coveo.github.io/search-ui/components/omnibox.html) component allows you to specify the minimum number of characters required in the search input before displaying available query suggestions when focus is on the component.

For example, by setting this option to `1`, you can ensure that no query suggestions are displayed when the search box is empty.



#### New `SimpleFilter` option: `sortCriteria`

_Issue number: JSUI-2401_

The new [`sortCriteria`](https://coveo.github.io/search-ui/components/simplefilter.html#options.sortcriteria) option of the [`SimpleFilter`](https://coveo.github.io/search-ui/components/simplefilter.html) component allows you to specify whether to sort values in a given simple filter by ranking score (default), alphanumerically, by number of occurrences, or using the chi-square test.



#### New `ResultList` option: `enableScrollToTop`

_Issue number: JSUI-2413_

The new [`enableScrollToTop`](https://coveo.github.io/search-ui/components/resultlist.html#options.enablescrolltotop) option of the [`ResultList`](https://coveo.github.io/search-ui/components/resultlist.html) component allows you to specify whether to automatically scroll back to the top of the page when infinite scroll is enabled (see the [`enableInfiniteScroll`](https://coveo.github.io/search-ui/components/resultlist.html#options.enableinfinitescroll) option) and the end user interacts with a facet.

The option is set to `true` by default.
Setting it to `false` would yield a behavior similar to what follows:



#### Improved pilot component: `DynamicFacet`

pass:a[<span class="tag pilot" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Available feature deactivated by default that can be activated from the product UI or API"><a href="https://docs.coveo.com/en/1506/">Pilot Feature</a></span>]

_Issue numbers: JSUI-2442, JSUI-2482, JSUI-2513, JSUI-2397_

The pilot [`DynamicFacet`](https://coveo.github.io/search-ui/components/dynamicfacet.html) component has been improved in several ways:

* Automatic padding has been added to dynamic facets so they no longer move around when the end user is interacting with them.
* The [`FieldValue`](https://coveo.github.io/search-ui/components/fieldvalue.html) result template component is now compatible with dynamic facets.
* Dynamic facets can now be used alongside certain non-dynamic facet components, though some limitations still apply (see [Use dynamic facets alongside non-dynamic facets](https://docs.coveo.com/en/2917#using-dynamic-facets-alongside-non-dynamic-facets-not-recommended)).

### Other changes

|===
| Issue number | Enhancement

| JSUI-2397
| [`DynamicFacet`] Send dynamic facets state along with usage analytics search events.

| JSUI-2463
| [`CategoryFacet`, `Facet`, `DynamicFacet`] Send usage analytics custom event when showing more/less facet values.
|===

|===
| Issue number | Case | Maintenance case

| JSUI-2320 / JSUI-2507
| 00047446 / 00054093
| Fixed accessibility issues.

| JSUI-2488
| 00053573
| Fixed issue with default date format.
|===

|===
| Issue number | Bug fix

| JSUI-2335
| [`FacetSlider`] Fixed issue where graphic didn't correctly reflect the total number of result.

| JSUI-2376
| [Accessibility] Fixed tab navigation issue with **Settings** and **Search** buttons.

| JSUI-2377
| [Accessibility] Fixed issue where space key didn't activate buttons.

| JSUI-2390
| [`ResultsPerPage`] Fixed issue where `initialChoice` was ignored if `10` was in `choicesDisplayed`.

| JSUI-2394
| [Accessibility] Fixed issue where the escape key didn't close the facet settings menu.

| JSUI-2398
| [`OmniboxResultList`] Fixed issue where omnibox result list could push the rest of the search Page Down.

| JSUI-2441
| [`OmniboxResultList`] Fixed issue where omnibox queries weren't properly flagged as search-as-you-type queries.

| JSUI-2460
| Fixed issue where certain usage analytics events weren't sent when using IOS Safari.

| JSUI-2465
| Fixed error in `ShowingResultsOfWithQuery` localized string.

| JSUI-2469
| [`CategoryFacet`] Fixed issue where facet value counts weren't formatted as in other types of facets.

| JSUI-2475
| Fixed console warning issue in IE11.

| JSUI-2479
| [`Omnibox`] Fixed issue where trending query suggestions weren't updated when changing tabs.

| JSUI-2490
| [`DynamicFacet`] Fixed issue where dynamic facets couldn't be retrieved after they had been removed through Tab navigation.

| JSUI-2491
| `openQuickview` events aren't fired

| JSUI-2493
| [`DynamicFacet`] Fixed text underline issue in IE11.

| JSUI-2495
| [`Quickview`] Fixed hovering styling issue.

| JSUI-2509
| [`DynamicFacet`] Added loading animation.

| JSUI-2514
| [`DynamicFacet`] Fixed issue where component didn't respond to `data-tab` attribute as expected.
|===

### Additional changes in maintenance versions

#### v2.6459.11

|===
| Issue number | Enhancement

| JSUI-2581
| Support tagging items viewed by user.
|===

#### v2.6459.9

|===
| Issue number | Bug fix

| JSUI-2568
| [[`FacetValueSuggestions`](https://coveo.github.io/search-ui/components/facetvaluesuggestions.html)] Fixed issue where component didn't detect all facet types.

| JSUI-2578
| [[`FacetValueSuggestions`](https://coveo.github.io/search-ui/components/facetvaluesuggestions.html)] Added [`isCategoryField`](https://coveo.github.io/search-ui/components/facetvaluesuggestions.html#options.iscategoryfield) and [`categoryFieldDelimitingCharacter`](https://coveo.github.io/search-ui/components/facetvaluesuggestions.html#options.categoryfielddelimitingcharacter) options so the component can handle category fields.
|===

[#2-6063]
## May 2019 release (v2.6063)

The May 2019 package was initially released as v2.6063.7.

**CDN links for JavaScript Search Framework v2.6063.12**

- [GitHub release](https://github.com/coveo/search-ui/releases/tag/v2.6063.12)
- npm: `npm install coveo-search-ui@2.6063.12`
- CDN resources:
  - JavaScript (lazy, minified): `https://static.cloud.coveo.com/searchui/v2.6063.12/js/CoveoJsSearch.Lazy.min.js`
  - Stylesheet (minified): `https://static.cloud.coveo.com/searchui/v2.6063.12/css/CoveoFullSearch.min.css`
  - Templates: `https://static.cloud.coveo.com/searchui/v2.6063.12/js/templates/templates.js`
### Release highlights

#### New pilot feature: Dynamic facets

_Issue numbers: JSUI-2397, JSUI-2414, JSUI-2415, JSUI-2416, JSUI-2427, JSUI-2428, JSUI-2464_

pass:a[<span class="tag pilot" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Available feature deactivated by default that can be activated from the product UI or API"><a href="https://docs.coveo.com/en/1506/">Pilot Feature</a></span>]

This release introduces pilot versions of the [`DynamicFacet`](https://coveo.github.io/search-ui/components/dynamicfacet.html) and [`DynamicFacetManager`](https://coveo.github.io/search-ui/components/dynamicfacetmanager.html) components (see [Use dynamic facets](https://docs.coveo.com/en/2917/)).

Those components are designed to leverage the new [Coveo Machine Learning (Coveo ML)](https://docs.coveo.com/en/188/) [Dynamic Navigation Experience (DNE)](https://docs.coveo.com/en/2907/) feature in a search interface (see [Deploy Dynamic Navigation Experience (DNE)](https://docs.coveo.com/en/2918/)).

#### Bug fix side effect: Click events are no longer flagged as XHR requests

_Issue number: JSUI-2460_

To ensure that all click events are properly forwarded to Coveo Usage Analytics, the JavaScript Search Framework now logs those events using the [`Beacon`](https://developer.mozilla.org/en-US/docs/Web/API/Beacon_API) API, rather than [`XMLHttpRequest`](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest).

Among other things, this implies that click events will no longer appear as XHR requests on the **Network** tab of your browser developer tools.
To inspect click events, select the **All** or **Other** filter (the exact filter names may vary depending on the browser you're using).

### Other changes

|===
| Issue number | Enhancement

| JSUI-2430
| [Facet, Omnibox, Querybox, Tab] Update Interface Editor section for several options.

| JSUI-2436
| [DateUtils] Make all documented predefined date formats work as expected.

| JSUI-2449
| [Breadcrumb] Normalize breadcrumbs markup and style.
|===

|===
| Issue number | Bug fix

| JSUI-2437
| Fixed issue where result template conditions based on multi-value fields were always evaluated to `false`.

| JSUI-2459
| Fixed issue where including the `templates.js` script with no custom templates would throw errors.
|===

### Additional change in maintenance version

#### v2.6063.12

|===
| Issue number | Case | Maintenance case

| JSUI-2589
| 00055058
| Fixed Coveo for Sitecore issue where logging usage analytics click events would fail due to `access_token=undefined` being present in the query string.
|===

[#2-5926]
## April 2019 release (v2.5926)

The April 2019 package was initially released as v2.5926.10.

**CDN links for JavaScript Search Framework v2.5926.10**

- [GitHub release](https://github.com/coveo/search-ui/releases/tag/v2.5926.10)
- npm: `npm install coveo-search-ui@2.5926.10`
- CDN resources:
  - JavaScript (lazy, minified): `https://static.cloud.coveo.com/searchui/v2.5926.10/js/CoveoJsSearch.Lazy.min.js`
  - Stylesheet (minified): `https://static.cloud.coveo.com/searchui/v2.5926.10/css/CoveoFullSearch.min.css`
  - Templates: `https://static.cloud.coveo.com/searchui/v2.5926.10/js/templates/templates.js`
|===
| Issue number | Case | Maintenance case

| JSUI-2421
| 00049488
| [[`ResultsPerPage`](https://coveo.github.io/search-ui/components/resultsperpage.html)] Fixed issue where [`initialChoice`](https://coveo.github.io/search-ui/components/resultsperpage.html#options.initialchoice) would sometimes override end-user choice.
|===

|===
| Issue number | Bug fix

| JSUI-2387
| [[`Recommendation`](https://coveo.github.io/search-ui/components/recommendation.html)] Fixed issue where recording actions history for page whose title contains special characters would throw an error.
|===

[#2-5652]
## March 2019 release (v2.5652)

The March 2019 package was initially released as v2.5652.7.

**CDN links for JavaScript Search Framework v2.5652.11**

- [GitHub release](https://github.com/coveo/search-ui/releases/tag/v2.5652.11)
- npm: `npm install coveo-search-ui@2.5652.11`
- CDN resources:
  - JavaScript (lazy, minified): `https://static.cloud.coveo.com/searchui/v2.5652.11/js/CoveoJsSearch.Lazy.min.js`
  - Stylesheet (minified): `https://static.cloud.coveo.com/searchui/v2.5652.11/css/CoveoFullSearch.min.css`
  - Templates: `https://static.cloud.coveo.com/searchui/v2.5652.11/js/templates/templates.js`
### Changes

|===
| Issue number | Case | Maintenance case

| JSUI-2367
| 00048445
| [[`Facet`](https://coveo.github.io/search-ui/components/facet.html)/[`CategoryFacet`](https://coveo.github.io/search-ui/components/categoryfacet.html)] Fixed accessibility issues.

| JSUI-2368
| 00048531
| [[`Quickview`](https://coveo.github.io/search-ui/components/quickview.html)] Fixed issue where component didn't work with unique IDs contains URL-encoded characters.

| JSUI-2371
| 00048517
| [[`Pager`](https://coveo.github.io/search-ui/components/pager.html)] Fixed issue where current page could be set to decimal value.

| JSUI-2383
| 00048799
| [[`Omnibox`](https://coveo.github.io/search-ui/components/omnibox.html)] Fixed issue where `Enter` key didn't work in standalone search box with search-as-you-type enabled.

| JSUI-2385
| 00048853
| [`CategoryFacet`] Fixed issue where specifying custom facet value captions didn't work.

| JSUI-2386
| 00048573
| [Localization] Fixed date translation issue with Norwegian culture.

| JSUI-2389
| 00048961
| [[`OmniboxResultList`](https://coveo.github.io/search-ui/components/omniboxresultlist.html)] Fixed issue where header remained visible when query returned no results.
|===

### Additional change in maintenance version

#### v2.5652.11

|===
| Issue number | Bug fix

| JSUI-2456
| Fixed **Filters** menu alignment issue in small responsive mode.
|===

[#2-5549-6]
## February 2019 release (v2.5549.6)

> **Note**
>
> Also covers the following maintenance releases:
> 
> * v2.5549.2
> * v2.5549.4

**CDN links for JavaScript Search Framework v2.5549.6**

- [GitHub release](https://github.com/coveo/search-ui/releases/tag/v2.5549.6)
- npm: `npm install coveo-search-ui@2.5549.6`
- CDN resources:
  - JavaScript (lazy, minified): `https://static.cloud.coveo.com/searchui/v2.5549.6/js/CoveoJsSearch.Lazy.min.js`
  - Stylesheet (minified): `https://static.cloud.coveo.com/searchui/v2.5549.6/css/CoveoFullSearch.min.css`
  - Templates: `https://static.cloud.coveo.com/searchui/v2.5549.6/js/templates/templates.js`
|===
| Issue number | Case | Maintenance case

| JSUI-2341
| 00047780
| Fixed issue that could cause items to be missing when exporting query results to Excel.

| JSUI-2360
| 00048228
| [[`DateUtils`\](https://coveo.github.io/search-ui/classes/dateutils.html)^] Fixed issue where `yyyy` wasn't recognized in a predefined format.

| JSUI-2361
| 00048346
| [`Facet`] Fixed issue where specifying an [`additionalFilter`](https://coveo.github.io/search-ui/components/facet.html#options.additionalfilter) on a facet could cause inaccurate facet value counts.
|===

|===
| Issue number | Bug fix

| JSUI-2281
| [[`Facet`\](https://coveo.github.io/search-ui/components/facet.html)^] Fixed issue where toggle operator button wasn't accessible through keyboard navigation.
|===

[#2-5395-12]
## January 2019 release (v2.5395.12)

> **Note**
>
> Also covers the following maintenance releases:
> 
> * v2.5395.6
> * v2.5395.10

**CDN links for JavaScript Search Framework v2.5395.12**

- [GitHub release](https://github.com/coveo/search-ui/releases/tag/v2.5395.12)
- npm: `npm install coveo-search-ui@2.5395.12`
- CDN resources:
  - JavaScript (lazy, minified): `https://static.cloud.coveo.com/searchui/v2.5395.12/js/CoveoJsSearch.Lazy.min.js`
  - Stylesheet (minified): `https://static.cloud.coveo.com/searchui/v2.5395.12/css/CoveoFullSearch.min.css`
  - Templates: `https://static.cloud.coveo.com/searchui/v2.5395.12/js/templates/templates.js`
### Release highlights

#### `CategoryFacet` component

The [`CategoryFacet`](https://coveo.github.io/search-ui/components/categoryfacet.html) component is now officially supported.
This new component is essentially a revamped, simplified, and more efficient version of the now deprecated `HierarchicalFacet`.

See Using the [Category Facet Component](https://docs.coveo.com/en/2667/).

#### [JSUI-2271] Set `Quickview` tooltip position

You can use the new [`tooltipPlacement`](https://coveo.github.io/search-ui/components/quickview.html#options.tooltipplacement) [`Quickview`](https://coveo.github.io/search-ui/components/quickview.html) option to enforce a rendering position for its tooltip.

### Full release notes

|===
| Issue number | Enhancement

| JSUI-2147
| [[`SimpleFilter`](https://coveo.github.io/search-ui/components/simplefilter.html)] Change usage analytics `actionCause` to `deselectValue` when logging event after un-selecting value in component.

| JSUI-2158
| [[`Facet`](https://coveo.github.io/search-ui/components/facet.html)/[`CategoryFacet`](https://coveo.github.io/search-ui/components/categoryfacet.html)] Send `facetField` metadata when logging facet-related usage analytics events.

| JSUI-2180
| Improve visual separation of options at top of **Debug** window.

| JSUI-2207
| [[`ResultActionsMenu`](https://coveo.github.io/search-ui/components/resultactionsmenu.html)] Automatically adjust icon tooltip rendering position based on root element.

| JSUI-2271
| [[`Quickview`](https://coveo.github.io/search-ui/components/quickview.html)] Add [`tooltipPlacement`](https://coveo.github.io/search-ui/components/quickview.html#options.tooltipplacement) option to specify component tooltip rendering position.

| JSUI-2302
| [[`Logo`](https://coveo.github.io/search-ui/components/logo.html)] Update Coveo logo used by component.

| JSUI-2311
| [[`Omnibox`](https://coveo.github.io/search-ui/components/omnibox.html)] Send `tab` argument when requesting query suggestions.
|===

|===
| Issue number | Case | Maintenance case

| JSUI-2221
| N/A
| [[`Analytics`](https://coveo.github.io/search-ui/components/analytics.html)] Add optional `result` parameter to [`logCustomEvent`](https://coveo.github.io/search-ui/components/analytics.html#logcustomevent) method to link event to specific [`IQueryResult`](https://coveo.github.io/search-ui/interfaces/iqueryresult.html).

| JSUI-2241
| 00045390
| Fixed issue where terms could be highlighted more than once.

| JSUI-2316
| 00047228
| [Accessibility] Made [`Breadcrumb`](https://coveo.github.io/search-ui/components/breadcrumb.html) and [`CategoryFacet`](https://coveo.github.io/search-ui/components/categoryfacet.html) components accessible through keyboard navigation.

| JSUI-2319
| 00047394
| [[`FacetSlider`](https://coveo.github.io/search-ui/components/facetslider.html)] Fixed division by zero issue when only one result was returned.

| JSUI-2321
| 00047460
| Fixed deprecation and vulnerability warnings in package.

| JSUI-2324
| 00047583
| [[`Facet`](https://coveo.github.io/search-ui/components/facet.html)] Fixed issue where using [`additionalFilter`](https://coveo.github.io/search-ui/components/facet.html#options.additionalfilter) option resulted in Group By request ignoring the basic query expression.

| JSUI-2326
| 00047633
| Fixed string localization issue with date helpers.

| JSUI-2352
| N/A
| Fixed issue where adding the `coveo-show-if-results` class to an element didn't always work as expected with many result layouts.
|===

|===
| Issue number | Bug fix

| JSUI-2160
| [[`PrintableUri`](https://coveo.github.io/search-ui/components/printableuri.html)] Fixed alignment issue.

| JSUI-2213
| [[`ResultLink`](https://coveo.github.io/search-ui/components/resultlink.html)] Fixed issue where using `openQuickview` option in child result template threw an exception.

| JSUI-2220
| [[`ResultList`](https://coveo.github.io/search-ui/components/resultlist.html)] Fixed issue where layout selector icons disappeared after resizing window.

| JSUI-2240
| Fixed **More** tab dropdown menu display overflow issue in responsive mode.

| JSUI-2259
| [[`CategoryFacet`](https://coveo.github.io/search-ui/components/categoryfacet.html)] Fixed facet search dropdown menu display issue in IE11 and responsive mode.

| JSUI-2262
| [`CategoryFacet`] Fixed issue where [`basePath`](https://coveo.github.io/search-ui/components/categoryfacet.html#options.basepath) option wasn't taken into account in facet search.

| JSUI-2264
| [`CategoryFacet`] Fixed issue where inactive CategoryFacet with `basePath` still added a filter to the query.

| JSUI-2267
| [[`ResultList`](https://coveo.github.io/search-ui/components/resultlist.html)] Fixed issue where pager became temporarily visible while scrolling down rapidly with [`enableInfiniteScroll`](https://coveo.github.io/search-ui/components/resultlist.html#options.enableinfinitescroll) set to `true`.

| JSUI-2275
| [Accessibility] Made `Tab` components in dropdown menu accessible through keyboard navigation when in responsive mode.

| JSUI-2276
| [Accessibility] Made `Facet` settings accessible through keyboard navigation.

| JSUI-2293
| [[`Querybox`](https://coveo.github.io/search-ui/components/querybox.html)] Fixed issue where clear button overlapped with lengthy end-user input.

| JSUI-2295
| Fixed issue where debug panel search expression wasn't reset when an option from the header was toggled.

| JSUI-2297
| [`SimpleFilter`] Fixed issue where using `@month` as a [`field`](https://coveo.github.io/search-ui/components/simplefilter.html#options.field) caused the component to display invalid values

| JSUI-2299
| [`Omnibox`] Fixed issue where query suggestions weren't highlighted in searchbox initialized outside of its `SearchInterface`.
|===