@bridgeline-digital/hawksearch-handlebars-ui 5.0.0 → 5.0.4

package/dist/components/content/content-types/featured-items-content-item/featured-items-content-item.component.d.ts

@@ -1,39 +1,39 @@
-import { BaseComponent } from '@components';
-import { FeaturedItemsContentItemComponentConfig, HawkSearchComponents } from '@configuration';
-import { FeaturedItemsContentItem, FeaturedItemsContentItemComponentModel } from '@models';
-/**
- * The Featured Items Content Item component displays information for an individual product or page.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-featured-items-content>`.
- *
- * ## Event-Binding Attributes
- * ### Images
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-image | |
- *
- * Image elements with this attribute will have their src value replaced with a placeholder image URL if the image fails to load.
- *
- * ### Links
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-link | |
- *
- * Anchor elements with this attribute will be tracked when clicked.
- *
- * ## Default Template
- * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
- * {@embed ./featured-items-content-item.component.hbs}
- *
- * @category Content
- */
-export declare class FeaturedItemsContentItemComponent extends BaseComponent<FeaturedItemsContentItemComponentConfig, FeaturedItemsContentItem, FeaturedItemsContentItemComponentModel> {
-    trackingEnabled: boolean;
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    protected renderContent(): boolean;
-    protected getContentModel(): FeaturedItemsContentItemComponentModel;
-    protected onRender(): void;
-}
+import { BaseComponent } from '@components';
+import { FeaturedItemsContentItemComponentConfig, HawkSearchComponents } from '@configuration';
+import { FeaturedItemsContentItem, FeaturedItemsContentItemComponentModel } from '@models';
+/**
+ * The Featured Items Content Item component displays information for an individual product or page.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-featured-items-content>`.
+ *
+ * ## Event-Binding Attributes
+ * ### Images
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-image | |
+ *
+ * Image elements with this attribute will have their src value replaced with a placeholder image URL if the image fails to load.
+ *
+ * ### Links
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-link | |
+ *
+ * Anchor elements with this attribute will be tracked when clicked.
+ *
+ * ## Default Template
+ * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
+ * {@embed ./featured-items-content-item.component.hbs}
+ *
+ * @category Content
+ */
+export declare class FeaturedItemsContentItemComponent extends BaseComponent<FeaturedItemsContentItemComponentConfig, FeaturedItemsContentItem, FeaturedItemsContentItemComponentModel> {
+    trackingEnabled: boolean;
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected renderContent(): boolean;
+    protected getContentModel(): FeaturedItemsContentItemComponentModel;
+    protected onRender(): void;
+}

package/dist/components/content/content-types/image-content/image-content.component.d.ts

@@ -1,22 +1,22 @@
-import { HawkSearchComponents, ImageContentComponentConfig } from '@configuration';
-import { ImageContent, ImageContentComponentModel } from '@models';
-import { BaseContentComponent } from '../base-content.component';
-/**
- * The Image Content component displays an image defined in HawkSearch.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-image-content>`.
- *
- * ## Default Template
- * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
- * {@embed ./image-content.component.hbs}
- *
- * @category Content
- */
-export declare class ImageContentComponent extends BaseContentComponent<ImageContentComponentConfig, ImageContent, ImageContentComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected renderContent(): boolean;
-    protected getContentModel(): ImageContentComponentModel;
-    protected onRender(): void;
-}
+import { HawkSearchComponents, ImageContentComponentConfig } from '@configuration';
+import { ImageContent, ImageContentComponentModel } from '@models';
+import { BaseContentComponent } from '../base-content.component';
+/**
+ * The Image Content component displays an image defined in HawkSearch.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-image-content>`.
+ *
+ * ## Default Template
+ * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
+ * {@embed ./image-content.component.hbs}
+ *
+ * @category Content
+ */
+export declare class ImageContentComponent extends BaseContentComponent<ImageContentComponentConfig, ImageContent, ImageContentComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected renderContent(): boolean;
+    protected getContentModel(): ImageContentComponentModel;
+    protected onRender(): void;
+}

package/dist/components/content/content-types/index.d.ts

@@ -1,6 +1,6 @@
-export * from './base-content.component';
-export * from './custom-content/custom-content.component';
-export * from './featured-items-content/featured-items-content.component';
-export * from './featured-items-content-item/featured-items-content-item.component';
-export * from './image-content/image-content.component';
-export * from './popular-queries-content/popular-queries-content.component';
+export * from './base-content.component';
+export * from './custom-content/custom-content.component';
+export * from './featured-items-content/featured-items-content.component';
+export * from './featured-items-content-item/featured-items-content-item.component';
+export * from './image-content/image-content.component';
+export * from './popular-queries-content/popular-queries-content.component';

package/dist/components/content/content-types/popular-queries-content/popular-queries-content.component.d.ts

@@ -1,22 +1,22 @@
-import { HawkSearchComponents, PopularQueriesContentComponentConfig } from '@configuration';
-import { PopularQueriesContent, PopularQueriesContentComponentModel } from '@models';
-import { BaseContentComponent } from '../base-content.component';
-/**
- * The Popular Queries Content component renders a tag cloud of popular queries relating to the current query. Each link is weighted according to its search frequency, with the most popular queries displayed in the largest font size.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-popular-queries-content>`.
- *
- * ## Default Template
- * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
- * {@embed ./popular-queries-content.component.hbs}
- *
- * @category Content
- */
-export declare class PopularQueriesContentComponent extends BaseContentComponent<PopularQueriesContentComponentConfig, PopularQueriesContent, PopularQueriesContentComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected renderContent(): boolean;
-    protected getContentModel(): PopularQueriesContentComponentModel;
-    protected onRender(): void;
-}
+import { HawkSearchComponents, PopularQueriesContentComponentConfig } from '@configuration';
+import { PopularQueriesContent, PopularQueriesContentComponentModel } from '@models';
+import { BaseContentComponent } from '../base-content.component';
+/**
+ * The Popular Queries Content component renders a tag cloud of popular queries relating to the current query. Each link is weighted according to its search frequency, with the most popular queries displayed in the largest font size.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-popular-queries-content>`.
+ *
+ * ## Default Template
+ * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
+ * {@embed ./popular-queries-content.component.hbs}
+ *
+ * @category Content
+ */
+export declare class PopularQueriesContentComponent extends BaseContentComponent<PopularQueriesContentComponentConfig, PopularQueriesContent, PopularQueriesContentComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected renderContent(): boolean;
+    protected getContentModel(): PopularQueriesContentComponentModel;
+    protected onRender(): void;
+}

package/dist/components/content/content-zone/content-zone.component.d.ts

@@ -1,44 +1,44 @@
-import { BaseComponent } from '@components';
-import { ContentZoneComponentConfig, HawkSearchComponents } from '@configuration';
-import { ContentZoneComponentModel, SearchResponse } from '@models';
-/**
- * The Content Zone component renders a list of content items or Spotlight products as defined in the Merchandising section of HawkSearch.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-content-zone>`.
- *
- * ## Attributes
- * | Name | Value | Required |
- * | :- | :- | :- |
- * | name | `string` | Yes |
- *
- * The `name` attribute corresponds to the `Zone` property defined in HawkSearch. This is used to differentiate different content areas, allowing you to place content items exactly where you want within your search results page.
- *
- * ## Event-Binding Attributes
- * | Name | Value |
- * | :- | :- |
- * | index | `number` |
- *
- * To render a content item, the `index` attribute must be present with a value corresponding to the item’s index in the {@link Models.ContentZoneComponentModel.items} array.
- *
- * ## Default Template
- * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
- * {@embed ./content-zone.component.hbs}
- *
- * @category Content
- */
-export declare class ContentZoneComponent extends BaseComponent<ContentZoneComponentConfig, SearchResponse, ContentZoneComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    private get name();
-    private get zone();
-    private get displayType();
-    private previousDisplayType?;
-    private windowResizeEventHandler;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    protected renderContent(): boolean;
-    protected getContentModel(): ContentZoneComponentModel;
-    protected bindChildElements(): void;
-}
+import { BaseComponent } from '@components';
+import { ContentZoneComponentConfig, HawkSearchComponents } from '@configuration';
+import { ContentZoneComponentModel, SearchResponse } from '@models';
+/**
+ * The Content Zone component renders a list of content items or Spotlight products as defined in the Merchandising section of HawkSearch.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-content-zone>`.
+ *
+ * ## Attributes
+ * | Name | Value | Required |
+ * | :- | :- | :- |
+ * | name | `string` | Yes |
+ *
+ * The `name` attribute corresponds to the `Zone` property defined in HawkSearch. This is used to differentiate different content areas, allowing you to place content items exactly where you want within your search results page.
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | index | `number` |
+ *
+ * To render a content item, the `index` attribute must be present with a value corresponding to the item’s index in the {@link Models.ContentZoneComponentModel.items} array.
+ *
+ * ## Default Template
+ * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
+ * {@embed ./content-zone.component.hbs}
+ *
+ * @category Content
+ */
+export declare class ContentZoneComponent extends BaseComponent<ContentZoneComponentConfig, SearchResponse, ContentZoneComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    private get name();
+    private get zone();
+    private get displayType();
+    private previousDisplayType?;
+    private windowResizeEventHandler;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected renderContent(): boolean;
+    protected getContentModel(): ContentZoneComponentModel;
+    protected bindChildElements(): void;
+}

package/dist/components/content/index.d.ts

@@ -1,2 +1,2 @@
-export * from './content-types';
-export * from './content-zone/content-zone.component';
+export * from './content-types';
+export * from './content-zone/content-zone.component';

package/dist/components/general/date-picker/date-picker.component.d.ts

@@ -1,117 +1,117 @@
-import { BaseComponent } from '@components';
-import { DatePickerComponentConfig, HawkSearchComponents } from '@configuration';
-import { DatePickerComponentModel } from '@models';
-/**
- * The Date Picker component provides an intuitive interface that allows the user to select a range in ISO format. This component is currently only used within the {@link Components.DateRangeFacetComponent | Date Range Facet Component}.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-date-picker>`.
- *
- * ## Attributes
- * | Name | Value |
- * | :- | :- |
- * | label | `string` |
- * | min | `Date` |
- * | max | `Date` |
- * | value | `Date` |
- *
- * ## Event-Binding Attributes
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-input | |
- *
- * The input element must have this attribute. When this element is clicked, the date picker modal will be displayed.
- *
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-modal | |
- *
- * This root element of the date picker modal must have this attribute to calculate modal positioning.
- *
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-month | |
- *
- * This attribute is used to identify the form element used to select a specific month.
- *
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-year | |
- *
- * This attribute is used to identify the form element used to select a specific year.
- *
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-select-month | |
- *
- * When an element with this attribute is clicked, the month specified by `hawksearch-month` and `hawksearch-year` to be displayed in the date picker modal.
- *
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-previous | |
- *
- * When an element with this attribute is clicked, the previous month will be displayed in the date picker modal.
- *
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-next | |
- *
- * When an element with this attribute is clicked, the next month will be displayed in the date picker modal.
- *
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-month-selector | |
- *
- * When an element with this attribute is clicked, the month selector will be displayed in the date picker modal to quickly jump to a particular month rather than using pagination.
- *
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-date | `string` (ISO date format) |
- *
- * When an element with this attribute is clicked, the specified date will be selected and displayed in the input element.
- *
- * ## Events
- * | Name | Data Type |
- * | :- | :- |
- * | hawksearch:date-picker-changed | `Date` |
- *
- * This event fires whenever the user selects a date.
- *
- * ## Handlebars Helpers
- * | Name | Parameter |
- * | :- | :- |
- * | dayOfMonth | `Date` |
- *
- * This helper function returns the zero-padded day of the month from a provided date object.
- *
- * ## Default Template
- * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
- * {@embed ./date-picker.component.hbs}
- *
- * @category General
- */
-export declare class DatePickerComponent extends BaseComponent<DatePickerComponentConfig, never, DatePickerComponentModel> {
-    static get observedAttributes(): Array<string>;
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    private label?;
-    private minDate?;
-    private maxDate?;
-    private selectedDate?;
-    private modalVisible;
-    private modalDate;
-    private monthSelectorVisible;
-    private documentClickEventHandler;
-    private windowResizeEventHandler;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
-    protected registerHelpers(): void;
-    protected getContentModel(): DatePickerComponentModel;
-    protected onRender(): void;
-    private positionModal;
-    private getYears;
-    private getWeeks;
-    private getWeek;
-}
+import { BaseComponent } from '@components';
+import { DatePickerComponentConfig, HawkSearchComponents } from '@configuration';
+import { DatePickerComponentModel } from '@models';
+/**
+ * The Date Picker component provides an intuitive interface that allows the user to select a range in ISO format. This component is currently only used within the {@link Components.DateRangeFacetComponent | Date Range Facet Component}.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-date-picker>`.
+ *
+ * ## Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | label | `string` |
+ * | min | `Date` |
+ * | max | `Date` |
+ * | value | `Date` |
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-input | |
+ *
+ * The input element must have this attribute. When this element is clicked, the date picker modal will be displayed.
+ *
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-modal | |
+ *
+ * This root element of the date picker modal must have this attribute to calculate modal positioning.
+ *
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-month | |
+ *
+ * This attribute is used to identify the form element used to select a specific month.
+ *
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-year | |
+ *
+ * This attribute is used to identify the form element used to select a specific year.
+ *
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-select-month | |
+ *
+ * When an element with this attribute is clicked, the month specified by `hawksearch-month` and `hawksearch-year` to be displayed in the date picker modal.
+ *
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-previous | |
+ *
+ * When an element with this attribute is clicked, the previous month will be displayed in the date picker modal.
+ *
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-next | |
+ *
+ * When an element with this attribute is clicked, the next month will be displayed in the date picker modal.
+ *
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-month-selector | |
+ *
+ * When an element with this attribute is clicked, the month selector will be displayed in the date picker modal to quickly jump to a particular month rather than using pagination.
+ *
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-date | `string` (ISO date format) |
+ *
+ * When an element with this attribute is clicked, the specified date will be selected and displayed in the input element.
+ *
+ * ## Events
+ * | Name | Data Type |
+ * | :- | :- |
+ * | hawksearch:date-picker-changed | `Date` |
+ *
+ * This event fires whenever the user selects a date.
+ *
+ * ## Handlebars Helpers
+ * | Name | Parameter |
+ * | :- | :- |
+ * | dayOfMonth | `Date` |
+ *
+ * This helper function returns the zero-padded day of the month from a provided date object.
+ *
+ * ## Default Template
+ * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
+ * {@embed ./date-picker.component.hbs}
+ *
+ * @category General
+ */
+export declare class DatePickerComponent extends BaseComponent<DatePickerComponentConfig, never, DatePickerComponentModel> {
+    static get observedAttributes(): Array<string>;
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    private label?;
+    private minDate?;
+    private maxDate?;
+    private selectedDate?;
+    private modalVisible;
+    private modalDate;
+    private monthSelectorVisible;
+    private documentClickEventHandler;
+    private windowResizeEventHandler;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    protected registerHelpers(): void;
+    protected getContentModel(): DatePickerComponentModel;
+    protected onRender(): void;
+    private positionModal;
+    private getYears;
+    private getWeeks;
+    private getWeek;
+}

package/dist/components/general/icon/icon.component.d.ts

@@ -1,38 +1,38 @@
-import { BaseComponent } from '@components';
-import { HawkSearchComponents, IconComponentConfig } from '@configuration';
-import { IconComponentModel } from '@models';
-/**
- * The Icon component renders an SVG image inline with text content.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-icon>`.
- *
- * ## Attributes
- * | Name | Type | Default Value | Required |
- * | :- | :- | :- | :- |
- * | name | {@link Models.IconName} | | Yes
- * | size | `string` | `number` | `1em` | No
- *
- * ## CSS Variables
- * The following CSS classes are available that allow you to bypass the [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM) and customize the appearance of this component without overriding the Handlebars template:
- *
- * | Name | Default Value |
- * | :- | :- |
- * | --icon-color | `currentColor` |
- * | --icon-font-size | `1em` |
- *
- * ## Default Template
- * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
- * {@embed ./icon.component.hbs}
- *
- * @category General
- */
-export declare class IconComponent extends BaseComponent<IconComponentConfig, never, IconComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    private get name();
-    private get size();
-    protected renderContent(): boolean;
-    protected getContentModel(): IconComponentModel;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, IconComponentConfig } from '@configuration';
+import { IconComponentModel } from '@models';
+/**
+ * The Icon component renders an SVG image inline with text content.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-icon>`.
+ *
+ * ## Attributes
+ * | Name | Type | Default Value | Required |
+ * | :- | :- | :- | :- |
+ * | name | {@link Models.IconName} | | Yes
+ * | size | `string` | `number` | `1em` | No
+ *
+ * ## CSS Variables
+ * The following CSS classes are available that allow you to bypass the [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM) and customize the appearance of this component without overriding the Handlebars template:
+ *
+ * | Name | Default Value |
+ * | :- | :- |
+ * | --icon-color | `currentColor` |
+ * | --icon-font-size | `1em` |
+ *
+ * ## Default Template
+ * The following is the default Handlebars template for this component. To create a custom template, it is recommended to use this as a starting point.
+ * {@embed ./icon.component.hbs}
+ *
+ * @category General
+ */
+export declare class IconComponent extends BaseComponent<IconComponentConfig, never, IconComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    private get name();
+    private get size();
+    protected renderContent(): boolean;
+    protected getContentModel(): IconComponentModel;
+}

package/dist/components/general/index.d.ts

@@ -1,5 +1,5 @@
-export * from './date-picker/date-picker.component';
-export * from './icon/icon.component';
-export * from './range-slider/range-slider.component';
-export * from './rating/rating.component';
-export * from './tooltip/tooltip.component';
+export * from './date-picker/date-picker.component';
+export * from './icon/icon.component';
+export * from './range-slider/range-slider.component';
+export * from './rating/rating.component';
+export * from './tooltip/tooltip.component';