@bridgeline-digital/hawksearch-handlebars-ui 2.1.0-beta.4 → 3.0.0

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.
@@ -9,6 +9,10 @@ import { BaseComponentModel } from '@models';
9
9
  * @category Base
10
10
  */
11
11
  export declare abstract class BaseComponent<TConfig extends BaseComponentConfig, TData, TModel extends BaseComponentModel> extends HTMLElement {
12
+ /**
13
+ * Optional instance-level configuration to override the global configuration
14
+ */
15
+ configOverride?: TConfig;
12
16
  /**
13
17
  * The data bound to the component.
14
18
  */
@@ -60,12 +64,6 @@ export declare abstract class BaseComponent<TConfig extends BaseComponentConfig,
60
64
  * The root element which should be used for querying any child elements. This resolves to `this.shadowRoot` if the Shadow DOM is enabled, otherwise `this`.
61
65
  */
62
66
  get rootElement(): ParentNode;
63
- /**
64
- * @internal
65
- *
66
- * @returns Whether the element has a custom template specified through child content.
67
- */
68
- private get hasContentTemplateOverride();
69
67
  /**
70
68
  * The name of the event that this component listens to for data binding. if {@link bindFromEvent} is `true`, this prepends `hawksearch:bind-` to {@link componentName} and appends :{@link eventFilter}, if specified.
71
69
  *
@@ -3,11 +3,10 @@
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
- * There are three ways to replace the Handlebars template used by a component:
6
+ * There are two ways to replace the Handlebars template used by a component:
7
7
  *
8
8
  * - Pass a template HTML string containing a Handlebars template.
9
9
  * - Pass the ID of a template element containing a Handlebars template.
10
- * - Define the new Handlebars template as the child content of a control
11
10
  *
12
11
  * *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
12
  *
@@ -95,24 +94,6 @@
95
94
  *
96
95
  * *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
96
  *
98
- * ### Setting control content
99
- *
100
- * In your HTML file, add the custom markup as the content of a component element:
101
- *
102
- * ```html
103
- * <hawksearch-page-size>
104
- * <div class='page-size'>
105
- * <select hawksearch-page-size>
106
- * {{#each options}}
107
- * <option value='{{pageSize}}' {{attribute 'selected' selected}}>{{title}}</option>
108
- * {{/each}}
109
- * </select>
110
- * </div>
111
- * </hawksearch-page-size>
112
- * ```
113
- *
114
- * *Note: If you choose this approach to customization and need to define a template for a nested element, be aware that by default, Handlebars will try to apply the model from the top-level component to all nested components, which will not work. To guard against this behavior, use the `exclude` helper documented in {@link Helpers.exclude}.*
115
- *
116
97
  * ## Customizing CSS
117
98
  * By default, a neutral interface is rendered to get your search instance up and running quickly. However, this library was designed to be customizable and allow developers to use both custom markup and custom CSS.
118
99
  *