@bridgeline-digital/hawksearch-handlebars-ui 5.0.15 → 5.0.17

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/changelog.md CHANGED
@@ -1,5 +1,30 @@
1
+ # 5.0.17
2
+
3
+ ## New Features
4
+
5
+ 1. Added `HawkSearch.config.autocomplete.minCharacterCount` property with a default value of `1` to specify the minimum length of a query before triggering autocomplete recommendations
6
+
7
+ # 5.0.16
8
+
9
+ ## New Features
10
+
11
+ 1. Add support for script elements for custom templates
12
+ 2. Added support for content result images in default templates
13
+
14
+ ## Bug Fixes
15
+
16
+ 1. Added check to not display range facets that do not have range data (from API bug)
17
+
18
+ # 5.0.15
19
+
20
+ ## Bug Fixes
21
+
22
+ 1. Fixed bug with QueryString not adding correct param names when same facet parents are selected
23
+
1
24
  # 5.0.1
2
25
 
26
+ ## Bug Fixes
27
+
3
28
  1. Fixed bug in API endpoint construction when overriding the default `endpointUrl` for Autocomplete
4
29
 
5
30
  # 5.0.0
@@ -50,9 +50,9 @@
50
50
  * </html>
51
51
  * ```
52
52
  *
53
- * ### Creating a template element
53
+ * ### Creating a script or template element
54
54
  *
55
- * In your HTML file, add the custom markup to a `template` element and pass the ID in the configuration options:
55
+ * In your HTML file, add the custom markup to either a `script` element with `type` attribute set to `text/x-handlebars-template` or a `template` element and pass the ID in the configuration options:
56
56
  *
57
57
  * ```html
58
58
  * <!DOCTYPE html>
@@ -79,7 +79,7 @@
79
79
  * <h1>HawkSearch Handlebars UI</h1>
80
80
  * <hawksearch-search></hawksearch-search>
81
81
  * <hawksearch-results></hawksearch-results>
82
- * <template id="page-size-template">
82
+ * <script id="page-size-template" type="text/x-handlebars-template">
83
83
  * <div class='page-size'>
84
84
  * <select hawksearch-page-size>
85
85
  * {{#each options}}
@@ -87,11 +87,13 @@
87
87
  * {{/each}}
88
88
  * </select>
89
89
  * </div>
90
- * </template>
90
+ * </script>
91
91
  * </body>
92
92
  * </html>
93
93
  * ```
94
94
  *
95
+ * * *Note: `script` elements are preferred over `template` elements as they prevent some browser parsing behavior which can conflict with Handlebars directives in some edge cases.*
96
+ *
95
97
  * *Note: This approach tends to be easier to manage than the previous option as it is more compatible with popular HTML editors and templates can potentially be loaded from separate files using Server-side Includes (SSI).*
96
98
  *
97
99
  * ## Customizing CSS
@@ -28,6 +28,7 @@ export declare class SearchFieldComponent extends BaseComponent<SearchFieldCompo
28
28
  private defaultAutocompleteResponse?;
29
29
  private previousAutocompleteResponse?;
30
30
  private previousValue;
31
+ private get autocompleteMinCharacterCount();
31
32
  private get recommendationsEnabled();
32
33
  connectedCallback(): void;
33
34
  disconnectedCallback(): void;
@@ -333,7 +333,7 @@ export interface HawkSearchConfig {
333
333
  */
334
334
  endpointUrl?: string;
335
335
  /**
336
- * Specifies whether autocomplete recommendations (autocomplete without entering a query) is enabled
336
+ * Specifies whether autocomplete recommendations (autocomplete without entering a query - "instant engage") is enabled
337
337
  *
338
338
  * #### Default Value
339
339
  * `false`
@@ -346,6 +346,13 @@ export interface HawkSearchConfig {
346
346
  * `false`
347
347
  */
348
348
  decodeQuery?: boolean;
349
+ /**
350
+ * Specifies the minimum length for a query to trigger an autocomplete recommendations request
351
+ *
352
+ * #### Default Value
353
+ * `1`
354
+ */
355
+ minCharacterCount?: number;
349
356
  };
350
357
  search?: {
351
358
  /**