@bridgeline-digital/hawksearch-handlebars-ui 6.2.0 → 6.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/index.html CHANGED
@@ -12,7 +12,7 @@
12
12
  <div class="col-content">
13
13
  <div class="tsd-page-title">
14
14
  <h2>@bridgeline-digital/hawksearch-handlebars-ui</h2></div>
15
- <div class="tsd-panel tsd-typography"><a id="md:hawksearch-handlebars-ui-v620" class="tsd-anchor"></a><h1><a href="#md:hawksearch-handlebars-ui-v620">HawkSearch Handlebars UI v6.2.0</a></h1><p>The HawkSearch Handlebars UI package allows you to add a highly-customizable search results page to your website powered by <a href="https://www.hawksearch.com/">HawkSearch</a>.</p>
15
+ <div class="tsd-panel tsd-typography"><a id="md:hawksearch-handlebars-ui-v621" class="tsd-anchor"></a><h1><a href="#md:hawksearch-handlebars-ui-v621">HawkSearch Handlebars UI v6.2.1</a></h1><p>The HawkSearch Handlebars UI package allows you to add a highly-customizable search results page to your website powered by <a href="https://www.hawksearch.com/">HawkSearch</a>.</p>
16
16
  <a id="md:installation" class="tsd-anchor"></a><h2><a href="#md:installation">Installation</a></h2><a id="md:npm-package" class="tsd-anchor"></a><h3><a href="#md:npm-package">npm Package</a></h3><ol>
17
17
  <li>If your website does not already have a package.json file in the root, run <code>npm init</code> to generate one.</li>
18
18
  <li>Run <code>npm install --save @bridgeline-digital/hawksearch-handlebars-ui</code> to install the latest version.</li>
@@ -89,6 +89,9 @@
89
89
  <a id="md:hawksearchsearch-completed" class="tsd-anchor"></a><h4><a href="#md:hawksearchsearch-completed">hawksearch:search-completed</a></h4><p>This event is fired after every search operation prior to data binding.</p>
90
90
  <pre><code class="language-js"><span class="hl-6">addEventListener</span><span class="hl-2">(</span><span class="hl-7">&#39;hawksearch:search-completed&#39;</span><span class="hl-2">, (</span><span class="hl-9">event</span><span class="hl-2">) </span><span class="hl-8">=&gt;</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-8">const</span><span class="hl-2"> </span><span class="hl-11">searchResponse</span><span class="hl-2"> = </span><span class="hl-9">event</span><span class="hl-2">.</span><span class="hl-9">detail</span><span class="hl-2">;</span><br/><br/><span class="hl-2"> </span><span class="hl-9">console</span><span class="hl-2">.</span><span class="hl-6">log</span><span class="hl-2">(</span><span class="hl-9">searchResponse</span><span class="hl-2">);</span><br/><span class="hl-2">});</span>
91
91
  </code><button>Copy</button></pre>
92
+ <a id="md:hawksearchsearch-failed" class="tsd-anchor"></a><h4><a href="#md:hawksearchsearch-failed">hawksearch:search-failed</a></h4><p>This event is fired if the search operation fails due to some error.</p>
93
+ <pre><code class="language-js"><span class="hl-6">addEventListener</span><span class="hl-2">(</span><span class="hl-7">&#39;hawksearch:search-failed&#39;</span><span class="hl-2">, (</span><span class="hl-9">event</span><span class="hl-2">) </span><span class="hl-8">=&gt;</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-8">const</span><span class="hl-2"> </span><span class="hl-11">searchResponseError</span><span class="hl-2"> = </span><span class="hl-9">event</span><span class="hl-2">.</span><span class="hl-9">detail</span><span class="hl-2">;</span><br/><br/><span class="hl-2"> </span><span class="hl-9">console</span><span class="hl-2">.</span><span class="hl-6">log</span><span class="hl-2">(</span><span class="hl-9">searchResponseError</span><span class="hl-2">);</span><br/><span class="hl-2">});</span>
94
+ </code><button>Copy</button></pre>
92
95
  <p><em>Note: This object is the processed SearchResponse model, not the initial response from HawkSearch.</em></p>
93
96
  <a id="md:recommendations" class="tsd-anchor"></a><h3><a href="#md:recommendations">Recommendations</a></h3><a id="md:hawksearchbefore-recommendations-executed" class="tsd-anchor"></a><h4><a href="#md:hawksearchbefore-recommendations-executed">hawksearch:before-recommendations-executed</a></h4><p>This event is fired after before every recommendations operation. This can be used to modify the raw request sent to the HawkSearch API.</p>
94
97
  <pre><code class="language-js"><span class="hl-6">addEventListener</span><span class="hl-2">(</span><span class="hl-7">&#39;hawksearch:before-recommendations-executed&#39;</span><span class="hl-2">, (</span><span class="hl-9">event</span><span class="hl-2">) </span><span class="hl-8">=&gt;</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-8">const</span><span class="hl-2"> </span><span class="hl-11">recommendationsRequest</span><span class="hl-2"> = </span><span class="hl-9">event</span><span class="hl-2">.</span><span class="hl-9">detail</span><span class="hl-2">;</span><br/><br/><span class="hl-2"> </span><span class="hl-9">console</span><span class="hl-2">.</span><span class="hl-6">log</span><span class="hl-2">(</span><span class="hl-9">recommendationsRequest</span><span class="hl-2">);</span><br/><span class="hl-2">});</span>
@@ -121,7 +124,7 @@
121
124
  <ul>
122
125
  <li>
123
126
  <ul>
124
- <li><a href="#md:hawksearch-handlebars-ui-v620"><span>Hawk<wbr/>Search <wbr/>Handlebars UI v6.2.0</span></a></li>
127
+ <li><a href="#md:hawksearch-handlebars-ui-v621"><span>Hawk<wbr/>Search <wbr/>Handlebars UI v6.2.1</span></a></li>
125
128
  <li>
126
129
  <ul>
127
130
  <li><a href="#md:installation"><span>Installation</span></a></li>
@@ -153,7 +156,8 @@
153
156
  <ul>
154
157
  <li><a href="#md:hawksearchbefore-search-executed"><span>hawksearch:before-<wbr/>search-<wbr/>executed</span></a></li>
155
158
  <li><a href="#md:hawksearchafter-search-executed"><span>hawksearch:after-<wbr/>search-<wbr/>executed</span></a></li>
156
- <li><a href="#md:hawksearchsearch-completed"><span>hawksearch:search-<wbr/>completed</span></a></li></ul></li>
159
+ <li><a href="#md:hawksearchsearch-completed"><span>hawksearch:search-<wbr/>completed</span></a></li>
160
+ <li><a href="#md:hawksearchsearch-failed"><span>hawksearch:search-<wbr/>failed</span></a></li></ul></li>
157
161
  <li><a href="#md:recommendations"><span>Recommendations</span></a></li>
158
162
  <li>
159
163
  <ul>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bridgeline-digital/hawksearch-handlebars-ui",
3
- "version": "6.2.0",
3
+ "version": "6.2.2",
4
4
  "description": "The HawkSearch Handlebars UI package allows you to add a highly-customizable search results page to your website powered by HawkSearch.",
5
5
  "private": false,
6
6
  "publishConfig": {