Rapid UI Release Notes

🚧

Important

While older versions of Rapid UI may continue to function, we officially support only the latest released version and its 2 previous releases. For optimal performance, security, and access to the latest features, we strongly recommend using one of the supported versions.

For example, if the current version is v6.3.8:

  • āœ… 6.3.8
  • āœ… 6.3.6
  • āœ… 6.3.3
  • āŒ 6.3.2

šŸ“˜ Note

Special Note for V5 Users: We will only continue to support V5.2 for existing implementations. However, we strongly encourage upgrading to the latest V6.x release to access all the latest features and improvements.


Changelog


6.3.8

Enhancements

  • Smart Response now runs concurrently with search requests.
  • Smart Response now uses the current search request (not a previous request).
  • Smart Response timeout updated to 20 seconds.
  • Added support for sending custom headers with API calls.

    -- X-HawkSearch-ClientGuid: <client guid>  
    -- X-Forwarded-For: <IP of site visitor>  
    -- User-Agent: <user agent of site visitor
    
  • Added a No Results component.
  • Added support for recommendation widget title configuration in Rapid UI.

Bug Fixes

  • Fixed a Rapid UI Shadow DOM / CSS styling issue.
  • Fixed a mobile search banner issue.
  • Fixed handling for open-range facets with non-numeric/currency values.

6.3.3

Enhancements

  • Update documentation.

6.3.2

Enhancements

  • Support .avif file format on VisualSearch.
  • Add configurable search debounce on Search field component for searching and triggering Autocomplete if enabled.

6.3.1

Enhancements

  • Fix rendering percentage(%) symbol correctly when displaying Autocomplete results.

6.3.0

Enhancements

  • Added Unified/Hybrid Search component hawksearch-unifiedsearch-field that allows Keyword and Concept search simultaneously.
  • Support multiple rotating placeholder examples with a typing-out effect on searchbar components: search-field, conceptsearch-field, imagesearch-field and unified-search.
  • Multiple performance and stability improvements.

6.2.10

Enhancements

  • Provide additional Result Item parameters on hawksearch:conversationalsearch component.

6.2.9

Fixes

  • Fix consistency issues when reading and writing queryStringParams on custom implementations.

6.2.8

Fixes

  • Update hawksearch-autocomplete default template to also render Suggested Product/Content without categories.

6.2.6

Fixes

  • Prevent queryStringParams being overriden when generating a SearchUrl with custom query parameters.

6.2.5

Fixes

  • Fix issue where VisualSearch queries would append on Search URL.

6.2.4

Enhancements

  • Added hawksearch:visualsearch-upload-failed event hooks on VisualSearch component to better handle errors when uploading images.

Fixes

  • Fix issue where workbench layout options are inconsistent when rendering Recommendation component (showDots, showNextPrevButtons).

6.2.3

Bug Fixes

  • Fix issue where recent queries are not decoded when Hawksearch.config.search.decodeFacetFalueis enabled.

6.2.2

Bug Fixes

  • Added required ElementNo parameter bug in tracking API when clicking an item from <hawksearch-search-results-list />.

6.2.1

New Feature

  • Modified SearchService so that hawksearch:search-failed event fires before if the search fails due to any error.

6.2.0

New Feature

  • Added Conversational Search component hawksearch-conversationalsearch that allows thread maintained prompt driven search.
  • Added SmartResponse component hawksearch-smartresponse that allows prompt driven analysis of search results.

Check out our webinar to see these in actions!


6.1.13

Enhancements

  • Reset pagination page to 1 when changing navigation page size.

6.1.12

Enhancements

  • Pagination links contains all query params, so facets and filters remain consistent when opening multiple pages when navigating on new tabs.

6.1.10

Enhancements

  • Suggest Popular Searches on Autocomplete popup without needing products or Categories to match the query.

6.1.9

Enhancements

  • Make decodeQuery and decodeFacetValue defaults to true on Search and Autocomplete services.

Bug Fixes

  • Fix issue where facets and categories on Autocomplete popup are not decoded.

v6.1.8

Bug Fixes

  • Fix issue where range facet not working when currency or number are false

v6.1.7

New Feature/Enhancement

  • Added HawkSearch.config.components.['search-field'].disableAutofill property with a default value of false to Specify whether the input element should be pre-populared if "query" parameter exists on the URL

v6.1.4

Bug Fixes

  • Fixed bug with Quick Lookup filtering not handling special characters correctly, e.g. ā€œ^ā€, ā€œ$ā€, ā€œā€, ā€œ.ā€, ā€œ*ā€, ā€œ+ā€, ā€œ?ā€, ā€œ(ā€œ, ā€œ)ā€, ā€œ[ā€œ, ā€œ]ā€, ā€œ{ā€œ, ā€œ}ā€, and ā€œ|ā€ in string

v6.1.3

New Feature/Enhancement

  • Added additional hawksearch-icons

v6.1.0

New Feature/Enhancement

  • Added smart search component hawksearch-visualsearch-field to search using images to find other similar images
  • Added smart search component hawksearch-imagesearch-field to search using a text-based query and finds the most relevant images based on the text provided
  • Added smart search component hawksearch-conceptsearch-field to search using a sentence or a concept and finds the most relevant results based on the text provided
  • Allow ConceptSearch and ImageSearch components to customise whether to trigger search requests on Key Press or only when hitting ENTER
  • Allow ConceptSearch and ImageSearch components to customise the timeout between search requests while typing

V6.0.0

New Feature/Enhancement

  • Build output now generated by Vite instead of Webpack
  • External assets such as default CSS and icons are now bundled directly in JavaScript file to minimize the number of HTTP requests
  • Build output now contains cjs, es, and umd formats along with typings to allow custom implementations to reference this as a library
  • Changed TypeDoc theme to support latest version of Typedoc and allow bundling via npm package
  • Tests added and executed by Vitest

Bug Fixes

  • Prevented "empty" range facets from displaying when facet configuration is incorrect
  • Add decodeURI helper for Templates

Breaking Changes

  • HawkSearch configuration requires executing the HawkSearch.init function which should be triggered after hawksearch:loaded event

Documentation

https://handlebars-ui.hawksearch.com/latest/


5.2.8

New Features

  • Fix rendering percentage(%) symbol correctly when displaying Autocomplete results.

5.2.7

New Features

  • Modified SearchService so that hawksearch:search-failed event fires before if the search fails due to any error.

5.2.6

New Features

  • Reset pagination page to 1 when changing navigation page size.

5.2.5

New Features

  • Suggest Popular Searches on Autocomplete popup without needing products or Categories to match the query.

5.2.4

New Features

  • Make decodeQuery and decodeFacetValue defaults to true on Search and Autocomplete services.

Bug Fixes

  • Fix issue where facets and categories on Autocomplete popup are not decoded.

5.2.3

Bug Fixes

  • Fix issue where range facet not working when currency or number are false

5.2.2

New Feature/Enhancement

  • Added HawkSearch.config.components.['search-field'].disableAutofill property with a default value of false to Specify whether the input element should be pre-populared if "query" parameter exists on the URL

5.2.1

Bug Fixes

  • Added support to successfully upgrade v5.1.x implementations

Breaking Changes

  • Prevents implementations of components in v6, e.g. ConceptSearch, VisualSearch, ImageSearch

5.0.19

Bug Fixes

  • Fixed bug with Quick Lookup filtering not handling special characters correctly, e.g. '(',')', etc

V5.0.17

New Feature/Enhancement

  • Added HawkSearch.config.autocomplete.minCharacterCount property with a default value of 1 to specify the minimum length of a query before triggering autocomplete recommendations

V5.0.16

New Feature/Enhancement

  • Support for image of content results
  • Support for script elements of custom templates

Bug Fix

  • Added check to not display range facets that do not have range data

V5.0.15

Bug Fix

  • Fix an issue in v5.0.0 where selecting multiple values from the same facet did not properly format URL parameters

V5.0.14

New Feature/Enhancement

  • Introduced the decodeURI helper to our template toolkit, enabling automatic decoding of URL-encoded values directly for clearer and more accurate content rendering

Bug Fix

  • Fix the situation where "Did You Mean" suggestions with multiple keywords did not execute searches correctly

V5.0.8

Bug Fix

  • Fix the redirect functionality in search results, ensuring immediate transitions without displaying unintended results
  • Fix the misinterpretation of NULL and empty 'Redirect Target' values, ensuring redirects open in the correct window

V5.0.0

New Feature/Enhancement

  • Support for variants functionality

Documentation

https://handlebars-ui.hawksearch.com/5.0.17/stable/#hawksearch-handlebars-ui-v5017


V4.0.4

Bug Fix

  • Fix the recommendations response handling to split property values into arrays, ensuring consistency with the autocomplete and search APIs for more accurate data processing
  • Fix an issue where clicking on Top Product Category suggestions in Autocomplete did not correctly redirect to the search page with the selected facet value, now ensuring seamless navigation
  • Fix the field mismatch in Event Sales Tracking, ensuring "ItemPrice" is used instead of "Price" for accurate transaction recording

V4.0.3

Bug Fix

  • Fix URL parsing logic to avoid prepending domain when API returns value starting with //

V4.0.2

Bug Fix

  • Fix number and currency helpers to handle string values from API
    V4.0.3
    Bug Fix
  • Fix URL parsing logic to avoid prepending domain when API returns value starting with //

V4.0.0

New Feature/Enhancement

  • Property to toggle autocomplete recommendations
  • Ratings display
  • Did You Mean in autocomplete
  • Product ratings and prices in autocomplete
  • Refactor config object to group options by type

V3.0.0

New Feature/Enhancement

  • Instant engage
  • Display previous autocomplete when refocusing on search field
  • Removal of custom templates as content
  • New instance-level config options

Bug Fix

  • Eliminate double click required to expand facets collapsed by default

v 2.0.0

New Feature/Enhancement

  • With this latest update, you can now efficiently and easily embed the HawkSearch Experience into your Website. The framework uses a popular developer tool, handlebars js and comes with standard templates for the search bar and search results page experiences.
  • Autocomplete
  • All search results
  • Default templates
  • Customization Options
  • Recommendations
  • Landing Pages