@bridgeline-digital/hawksearch-handlebars-ui 2.0.0-beta.8 → 2.0.0-beta.9

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.
@@ -1,17 +1,17 @@
1
1
  /**
2
- * ## Customizing Markup
2
+ * ## Overriding Component Templates
3
3
  *
4
4
  * This library was designed to be flexible and allow total customization of the markup used by all components.
5
5
  *
6
- * ### Overriding Templates
7
- *
8
6
  * There are three ways to replace the Handlebars template used by a component:
9
7
  *
10
8
  * - Pass a template HTML string containing a Handlebars template.
11
9
  * - Pass the ID of a template element containing a Handlebars template.
12
10
  * - Define the new Handlebars template as the child content of a control
13
11
  *
14
- * #### Passing an HTML string
12
+ * *Note: To avoid conflicts with BigCommerce and other systems that Handlebars for server-side rendering, this library also supports an alternate `[[value]]` syntax to work the same as the default Handlerbars `{{value}}` syntax.*
13
+ *
14
+ * ### Passing an HTML string
15
15
  *
16
16
  * In your HTML file, define the template content directly in the configuration options:
17
17
  *
@@ -51,7 +51,7 @@
51
51
  * </html>
52
52
  * ```
53
53
  *
54
- * #### Creating a template element
54
+ * ### Creating a template element
55
55
  *
56
56
  * In your HTML file, add the custom markup to a `template` element and pass the ID in the configuration options:
57
57
  *
@@ -95,7 +95,7 @@
95
95
  *
96
96
  * *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).*
97
97
  *
98
- * #### Setting control content
98
+ * ### Setting control content
99
99
  *
100
100
  * In your HTML file, add the custom markup as the content of a component element:
101
101
  *
@@ -295,6 +295,7 @@ export interface HawkSearchConfig {
295
295
  */
296
296
  tracking: string;
297
297
  };
298
+ index?: string;
298
299
  /**
299
300
  * Map item attributes to common object properties
300
301
  */