V2 2019 releases
V2 2019 releases
This page summarizes the new features and bug fixes introduced throughout 2019.
|
|
Note
The latest changes are available in Release notes. |
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):
-
From GitHub: 2.7610.10 release on GitHub
-
From npm:
npm install coveo-search-ui@2.7610.10 -
From a CDN:
| Resource | Script to include |
|---|---|
Coveo JavaScript Search Framework (minified) |
|
CSS |
|
Result templates |
|
|
|
For more available resources, see CDN links. |
Release highlights
New pilot component: QuerySuggestPreview
Issue numbers: JSUI-2685, JSUI-2693
The pilot QuerySuggestPreview component allows you to display the most relevant results when hovering over a Coveo ML query suggestion in the Omnibox.
<!-- ... -->
<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.
<!-- ... -->
<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 |
[ |
JSUI-2689 |
[ |
JSUI-2701 |
[ |
| Issue number | Case | Maintenance case |
|---|---|---|
JSUI-2636 |
00055912 |
Fixed several in-product external documentation links. |
JSUI-2644 |
00056043 |
[ |
JSUI-2728 |
00057466 |
[ |
JSUI-2748 |
00057676 |
[ |
| Issue number | Bug fix |
|---|---|
JSUI-2661 |
[ |
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 |
JSUI-2730 |
[ |
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):
-
From GitHub: 2.7219.22 release on GitHub
-
From npm:
npm install coveo-search-ui@2.7219.22 -
From a CDN:
| Resource | Script to include |
|---|---|
Coveo JavaScript Search Framework (minified) |
|
CSS |
|
Result templates |
|
|
|
For more available resources, see CDN links. |
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:
|
|
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:
-
clearLocalDatadeletes all session information stored in the browser by the framework for Coveo Analytics purposes (for example, visitor ID cookie, actions history, etc.).
-
disableAnalyticscallsclearLocalData, and then deactivates usage analytics in a search interface. -
enableAnalyticsre-activates usage analytics in a search interface.
See also Disable Coveo UA in a search interface?.
New pilot component: DynamicFacetRange
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:
<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
| Issue number | Case | Maintenance case |
|---|---|---|
JSUI-2641 |
00055430 |
[ |
JSUI-2649 |
00054917 |
[ |
| Issue number | Bug fix |
|---|---|
JSUI-2572 |
Fixed issue where field names containing underscore ( |
JSUI-2614 |
Fixed issue where |
JSUI-2620 |
Fixed issue where some hyperlinks were difficult to read on YouTube results with default card template. |
JSUI-2637 |
[ |
JSUI-2639 |
[External |
JSUI-2646 |
[ |
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. |
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):
-
From GitHub: 2.7023.9 release on GitHub
-
From npm:
npm install coveo-search-ui@2.7023.9 -
From a CDN:
| Resource | Script to include |
|---|---|
Coveo JavaScript Search Framework (minified) |
|
CSS |
|
Result templates |
|
|
|
For more available resources, see CDN links. |
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
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
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
| Issue number | Enhancement |
|---|---|
JSUI-2591 |
Log a warning when a result template doesn’t contain a |
JSUI-2462 |
[ |
JSUI-2504 |
[ |
JSUI-2547 / JSUI-2604 |
[ |
| Issue number | Case | Maintenance case |
|---|---|---|
JSUI-2576 |
00047446 |
[ |
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 |
[ |
| Issue number | Bug fix |
|---|---|
JSUI-2304 |
Fixed issue where custom events weren’t handled properly with Locker Service (Coveo for Salesforce). |
JSUI-2512 |
[ |
JSUI-2516 |
[ |
JSUI-2540 |
[ |
JSUI-2563 |
Fixed Quickview button alignment issue with folded children in default result templates. |
JSUI-2583 |
[ |
JSUI-2584 |
[ |
JSUI-2593 |
[ |
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. |
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):
-
From GitHub: 2.6459.11 release on GitHub
-
From npm:
npm install coveo-search-ui@2.6459.11 -
From a CDN:
| Resource | Script to include |
|---|---|
Coveo JavaScript Search Framework (minified) |
|
CSS |
|
Result templates |
|
|
|
For more available resources, see CDN links. |
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
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
FieldValueresult 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
| Issue number | Enhancement |
|---|---|
JSUI-2397 |
[ |
JSUI-2463 |
[ |
| 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 |
[ |
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 |
[ |
JSUI-2394 |
[Accessibility] Fixed issue where the escape key didn’t close the facet settings menu. |
JSUI-2398 |
[ |
JSUI-2441 |
[ |
JSUI-2460 |
Fixed issue where certain usage analytics events weren’t sent when using IOS Safari. |
JSUI-2465 |
Fixed error in |
JSUI-2469 |
[ |
JSUI-2475 |
Fixed console warning issue in IE11. |
JSUI-2479 |
[ |
JSUI-2490 |
[ |
JSUI-2491 |
|
JSUI-2493 |
[ |
JSUI-2495 |
[ |
JSUI-2509 |
[ |
JSUI-2514 |
[ |
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 |
[ |
JSUI-2578 |
[ |
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):
-
From GitHub: 2.6063.12 release on GitHub
-
From npm:
npm install coveo-search-ui@2.6063.12 -
From a CDN:
| Resource | Script to include |
|---|---|
Coveo JavaScript Search Framework (minified) |
|
CSS |
|
Result templates |
|
|
|
For more available resources, see CDN links. |
Release highlights
New pilot feature: Dynamic facets
Issue numbers: JSUI-2397, JSUI-2414, JSUI-2415, JSUI-2416, JSUI-2427, JSUI-2428, JSUI-2464
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 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 |
JSUI-2459 |
Fixed issue where including the |
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 |
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):
-
From GitHub: 2.5926.10 release on GitHub
-
From npm:
npm install coveo-search-ui@2.5926.10 -
From a CDN:
| Resource | Script to include |
|---|---|
Coveo JavaScript Search Framework (minified) |
|
CSS |
|
Result templates |
|
|
|
For more available resources, see CDN links. |
| Issue number | Case | Maintenance case |
|---|---|---|
JSUI-2421 |
00049488 |
[ |
| Issue number | Bug fix |
|---|---|
JSUI-2387 |
[ |
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):
-
From GitHub: 2.5652.11 release on GitHub
-
From npm:
npm install coveo-search-ui@2.5652.11 -
From a CDN:
| Resource | Script to include |
|---|---|
Coveo JavaScript Search Framework (minified) |
|
CSS |
|
Result templates |
|
|
|
For more available resources, see CDN links. |
Changes
| Issue number | Case | Maintenance case |
|---|---|---|
JSUI-2367 |
00048445 |
[ |
JSUI-2368 |
00048531 |
[ |
JSUI-2371 |
00048517 |
[ |
JSUI-2383 |
00048799 |
[ |
JSUI-2385 |
00048853 |
[ |
JSUI-2386 |
00048573 |
[Localization] Fixed date translation issue with Norwegian culture. |
JSUI-2389 |
00048961 |
[ |
Additional change in maintenance version
v2.5652.11
| Issue number | Bug fix |
|---|---|
JSUI-2456 |
Fixed Filters menu alignment issue in small responsive mode. |
February 2019 release (v2.5549.6)
|
|
Note
Also covers the following maintenance releases:
|
To download the latest version of this release (v2.5549.6):
-
From GitHub: 2.5549.6 release on GitHub
-
From npm:
npm install coveo-search-ui@2.5549.6 -
From a CDN:
| Resource | Script to include |
|---|---|
Coveo JavaScript Search Framework (minified) |
|
CSS |
|
Result templates |
|
|
|
For more available resources, see CDN links. |
| 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 |
[ |
JSUI-2361 |
00048346 |
[ |
| Issue number | Bug fix |
|---|---|
JSUI-2281 |
[ |
January 2019 release (v2.5395.12)
|
|
Note
Also covers the following maintenance releases:
|
To download the latest version of this release (v2.5395.12):
-
From GitHub: 2.5395.12 release on GitHub
-
From npm:
npm install coveo-search-ui@2.5395.12 -
From a CDN:
| Resource | Script to include |
|---|---|
Coveo JavaScript Search Framework (minified) |
|
CSS |
|
Result templates |
|
|
|
For more available resources, see CDN links. |
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
| Issue number | Enhancement |
|---|---|
JSUI-2147 |
[ |
JSUI-2158 |
[ |
JSUI-2180 |
Improve visual separation of options at top of Debug window. |
JSUI-2207 |
[ |
JSUI-2271 |
[ |
JSUI-2302 |
[ |
JSUI-2311 |
[ |
| Issue number | Case | Maintenance case |
|---|---|---|
JSUI-2221 |
N/A |
[ |
JSUI-2241 |
00045390 |
Fixed issue where terms could be highlighted more than once. |
JSUI-2316 |
00047228 |
[Accessibility] Made |
JSUI-2319 |
00047394 |
[ |
JSUI-2321 |
00047460 |
Fixed deprecation and vulnerability warnings in package. |
JSUI-2324 |
00047583 |
[ |
JSUI-2326 |
00047633 |
Fixed string localization issue with date helpers. |
JSUI-2352 |
N/A |
Fixed issue where adding the |
| Issue number | Bug fix |
|---|---|
JSUI-2160 |
[ |
JSUI-2213 |
[ |
JSUI-2220 |
[ |
JSUI-2240 |
Fixed More tab dropdown menu display overflow issue in responsive mode. |
JSUI-2259 |
[ |
JSUI-2262 |
[ |
JSUI-2264 |
[ |
JSUI-2267 |
[ |
JSUI-2275 |
[Accessibility] Made |
JSUI-2276 |
[Accessibility] Made |
JSUI-2293 |
[ |
JSUI-2295 |
Fixed issue where debug panel search expression wasn’t reset when an option from the header was toggled. |
JSUI-2297 |
[ |
JSUI-2299 |
[ |