V2 2019 releases

V2 2019 releases

This is for:

Developer

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

December 2019 release (v2.7610)

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

To download the latest version of this release (v2.7610.10):

<!-- Coveo JavaScript Search Framework (with lazy loading) -->
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.7610/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.7610/js/CoveoJsSearch.min.js"></script>

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.7610/css/CoveoFullSearch.css"/>

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

Release highlights

New pilot component: QuerySuggestPreview

Issue numbers: JSUI-2685, JSUI-2693

Pilot Feature

The pilot QuerySuggestPreview component allows you to display the most relevant results when hovering over a Coveo ML query suggestion in the Omnibox.

See Rendering query suggestion result previews.

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

New DynamicFacet option: dependsOn

Issue number: JSUI-2643

The DynamicFacet and DynamicFacetRange components now have a dependsOn option allowing you to display a “dependent” facet only when a value is selected in its specified “parent”.

See Use dynamic facets.

<!-- ... -->
<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 component.

See Change the language of your search interface.

<!-- ... -->
<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

October 2019 release (v2.7219)

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

To download the latest version of this release (v2.7219.22):

<!-- Coveo JavaScript Search Framework (with lazy loading) -->
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.7219/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.7219/js/CoveoJsSearch.min.js"></script>

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.7219/css/CoveoFullSearch.css"/>

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

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.

Before:

Now:

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 deletes all session information stored in the browser by the framework for Coveo Usage Analytics purposes (for example, visitor ID cookie, actions history, etc.).

  

• disableAnalytics calls clearLocalData, and then deactivates usage analytics in a search interface.

• enableAnalytics re-activates usage analytics in a search interface.

See also Disable Coveo UA in a search interface?.

New pilot component: DynamicFacetRange

Pilot Feature

Issue numbers: JSUI-2586, JSUI-2633, JSUI-2638

The new DynamicFacetRange component is now available as a pilot feature, allowing you to further leverage the Coveo Machine Learning (Coveo ML) Dynamic Navigation Experience (DNE) feature in your search interfaces.

See:

• Use dynamic facets
• Use dynamic facets

<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>

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

Additional changes in maintenance versions

v2.7219.22

v2.7219.15

v2.7219.11

September 2019 release (v2.7023)

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

To download the latest version of this release (v2.7023.9):

<!-- Coveo JavaScript Search Framework (with lazy loading) -->
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.7023/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.7023/js/CoveoJsSearch.min.js"></script>

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.7023/css/CoveoFullSearch.css"/>

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

Release highlights

New result template component: ImageFieldValue

Issue number: JSUI-2570

The new ImageFieldValue result template component makes it easier to leverage fields pointing to image URLs in query results.

<!-- ... -->
<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 option of the CategoryFacet component allows you to hide a category facet unless one or more values are selected in another specific facet.

<!-- ... -->
<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 option of the Omnibox component to true to automatically reset all advanced query filters when the end user submits a new query from the search box.

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

Improved pilot component: DynamicFacet

Pilot Feature

Issue numbers: JSUI-2450, JSUI-2528, JSUI-2552

The DynamicFacet component now supports facet search.

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

Improved pilot component: DynamicFacetManager

Pilot Feature

Issue number: JSUI-2571

The new maximumNumberOfExpandedFacets option of the DynamicFacetManager component allows you to specify how many of its embedded dynamic facets should be expanded when your search interface loads.

<!-- ... -->
<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

Additional change in maintenance version

v2.7023.9

July 2019 release (v2.6459)

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

To download the latest version of this release (v2.6459.11):

<!-- Coveo JavaScript Search Framework (with lazy loading) -->
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.6459/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.6459/js/CoveoJsSearch.min.js"></script>

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.6459/css/CoveoFullSearch.css"/>

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

Release highlights

New component: MissingTerms

Issue number: JSUI-2454

The new MissingTerms 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 option).

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

Issue number: JSUI-2467

The Analytics 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).

New Searchbox option: height

Issue number: JSUI-2349

The new height option of the Searchbox component makes it easy to resize the searchbox without writing any custom CSS.

New Omnibox option: querySuggestCharacterThreshold

Issue number: JSUI-2458

The new querySuggestCharacterThreshold option of the Omnibox 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 option of the SimpleFilter 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 option of the ResultList component allows you to specify whether to automatically scroll back to the top of the page when infinite scroll is enabled (see the 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

Pilot Feature

Issue numbers: JSUI-2442, JSUI-2482, JSUI-2513, JSUI-2397

The pilot DynamicFacet 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 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).

Other changes

Additional changes in maintenance versions

v2.6459.11

v2.6459.9

May 2019 release (v2.6063)

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

To download the latest version of this release (v2.6063.12):

<!-- Coveo JavaScript Search Framework (with lazy loading) -->
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.6063/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.6063/js/CoveoJsSearch.min.js"></script>

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.6063/css/CoveoFullSearch.css"/>

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

Release highlights

New pilot feature: Dynamic facets

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

Pilot Feature

This release introduces pilot versions of the DynamicFacet and DynamicFacetManager components (see Use dynamic facets).

Those components are designed to leverage the new Coveo Machine Learning (Coveo ML) Dynamic Navigation Experience (DNE) feature in a search interface (see Deploy Dynamic Navigation Experience (DNE)).

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 API, rather than XMLHttpRequest.

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

Other changes

Additional change in maintenance version

v2.6063.12

April 2019 release (v2.5926)

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

To download the latest version of this release (v2.5926.10):

<!-- Coveo JavaScript Search Framework (with lazy loading) -->
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.5926/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.5926/js/CoveoJsSearch.min.js"></script>

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.5926/css/CoveoFullSearch.css"/>

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

March 2019 release (v2.5652)

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

To download the latest version of this release (v2.5652.11):

<!-- Coveo JavaScript Search Framework (with lazy loading) -->
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.5652/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.5652/js/CoveoJsSearch.min.js"></script>

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.5652/css/CoveoFullSearch.css"/>

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

Changes

Additional change in maintenance version

v2.5652.11

February 2019 release (v2.5549.6)

To download this release:

<!-- Coveo JavaScript Search Framework (with lazy loading) -->
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.5549/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.5549/js/CoveoJsSearch.min.js"></script>

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.5549/css/CoveoFullSearch.css"/>

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

January 2019 release (v2.5395.12)

To download this release:

<!-- Coveo JavaScript Search Framework (with lazy loading) -->
<script class="coveo-script" src="https://static.cloud.coveo.com/searchui/v2.5395/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.5395/js/CoveoJsSearch.min.js"></script>

<link rel="stylesheet" href="https://static.cloud.coveo.com/searchui/v2.5395/css/CoveoFullSearch.css"/>

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

Release highlights

CategoryFacet component

The CategoryFacet 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.

[JSUI-2271] Set Quickview tooltip position

You can use the new tooltipPlacement Quickview option to enforce a rendering position for its tooltip.

Full release notes

Is this article useful?

You can close this window or leave a comment below.

Very useful Not really

Can you tell us more about your experience today?

Comments (optional)

Need help with our product? Please open a support case for expert assistance. Use this feedback option to comment on the article only.

Submit

Is this article useful?

You can close this window or leave a comment below.

Very useful Not really

Can you tell us more about your experience today?

Comments (optional)

Need help with our product? Please open a support case for expert assistance. Use this feedback option to comment on the article only.

Submit