@bridgeline-digital/hawksearch-handlebars-ui 4.0.3 → 5.0.0-beta.2

package/dist/components/search/search-results-item/search-results-item.component.d.ts

@@ -1,38 +1,38 @@
-import { HawkSearchComponents, SearchResultsItemComponentConfig } from '@configuration';
-import { SearchResultsItem, SearchResultsItemComponentModel } from '@models';
-import { BaseComponent } from '../../base.component';
-/**
- * The Search Results Item component displays information for an individual product or page.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-search-results-item>`.
- *
- * *Note: This component should only be used within the context of the {@link Components.SearchResultsListComponent | Search Results List component}.
- *
- * ## Event-Binding Attributes
- * | 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.
- *
- * | 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 ./search-results-item.component.hbs}
- *
- * @category Search
- */
-export declare class SearchResultsItemComponent extends BaseComponent<SearchResultsItemComponentConfig, SearchResultsItem, SearchResultsItemComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    protected renderContent(): boolean;
-    protected getContentModel(): SearchResultsItemComponentModel;
-    protected onRender(): void;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, SearchResultsItemComponentConfig } from '@configuration';
+import { SearchResultsItem, SearchResultsItemComponentModel } from '@models';
+/**
+ * The Search Results Item component displays information for an individual product or page.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-search-results-item>`.
+ *
+ * *Note: This component should only be used within the context of the {@link Components.SearchResultsListComponent | Search Results List component}.
+ *
+ * ## Event-Binding Attributes
+ * | 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.
+ *
+ * | 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 ./search-results-item.component.hbs}
+ *
+ * @category Search
+ */
+export declare class SearchResultsItemComponent extends BaseComponent<SearchResultsItemComponentConfig, SearchResultsItem, SearchResultsItemComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected renderContent(): boolean;
+    protected getContentModel(): SearchResultsItemComponentModel;
+    protected onRender(): void;
+}

package/dist/components/search/search-results-list/search-results-list.component.d.ts

@@ -1,23 +1,23 @@
-import { HawkSearchComponents, SearchResultsListComponentConfig } from '@configuration';
-import { SearchResultsItem, SearchResultsListComponentModel } from '@models';
-import { BaseComponent } from '../../base.component';
-/**
- * The Search Results List component is a wrapper around a group of {@link Components.SearchResultsItemComponent | Search Results Item} components.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-search-results-list>`.
- *
- * ## 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 ./search-results-list.component.hbs}
- *
- * @category Search
- */
-export declare class SearchResultsListComponent extends BaseComponent<SearchResultsListComponentConfig, Array<SearchResultsItem>, SearchResultsListComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    protected renderContent(): boolean;
-    protected getContentModel(): SearchResultsListComponentModel;
-    protected bindChildElements(): void;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, SearchResultsListComponentConfig } from '@configuration';
+import { SearchResultsItem, SearchResultsListComponentModel } from '@models';
+/**
+ * The Search Results List component is a wrapper around a group of {@link Components.SearchResultsItemComponent | Search Results Item} components.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-search-results-list>`.
+ *
+ * ## 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 ./search-results-list.component.hbs}
+ *
+ * @category Search
+ */
+export declare class SearchResultsListComponent extends BaseComponent<SearchResultsListComponentConfig, Array<SearchResultsItem>, SearchResultsListComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected renderContent(): boolean;
+    protected getContentModel(): SearchResultsListComponentModel;
+    protected bindChildElements(): void;
+}

package/dist/components/search/selected-facets/selected-facets.component.d.ts

@@ -1,31 +1,31 @@
-import { HawkSearchComponents, SelectedFacetsComponentConfig } from '@configuration';
-import { SelectedFacet, SelectedFacetsComponentModel } from '@models';
-import { BaseComponent } from '../../base.component';
-/**
- * The Selected Facets component displays a list of facets that have been selected by the user.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-selected-facets>`.
- *
- * ## Event-Binding Attributes
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-facet-field | `string` |
- * | hawksearch-facet-value | `string` |
- *
- * When an element with both of these attributes is clicked, that facet selection will be removed and the search results will be updated.
- *
- * ## 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 ./selected-facets.component.hbs}
- *
- * @category Search
- */
-export declare class SelectedFacetsComponent extends BaseComponent<SelectedFacetsComponentConfig, Array<SelectedFacet>, SelectedFacetsComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    protected renderContent(): boolean;
-    protected getContentModel(): SelectedFacetsComponentModel;
-    protected onRender(): void;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, SelectedFacetsComponentConfig } from '@configuration';
+import { SelectedFacet, SelectedFacetsComponentModel } from '@models';
+/**
+ * The Selected Facets component displays a list of facets that have been selected by the user.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-selected-facets>`.
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-facet-field | `string` |
+ * | hawksearch-facet-value | `string` |
+ *
+ * When an element with both of these attributes is clicked, that facet selection will be removed and the search results will be updated.
+ *
+ * ## 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 ./selected-facets.component.hbs}
+ *
+ * @category Search
+ */
+export declare class SelectedFacetsComponent extends BaseComponent<SelectedFacetsComponentConfig, Array<SelectedFacet>, SelectedFacetsComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected renderContent(): boolean;
+    protected getContentModel(): SelectedFacetsComponentModel;
+    protected onRender(): void;
+}

package/dist/components/search/sorting/sorting.component.d.ts

@@ -1,30 +1,30 @@
-import { HawkSearchComponents, SortingComponentConfig } from '@configuration';
-import { Sorting, SortingComponentModel } from '@models';
-import { BaseComponent } from '../../base.component';
-/**
- * The Sorting component is used to select the logic for ordering search results.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-sorting>`.
- *
- * ## Event-Binding Attributes
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-sort | |
- *
- * When a `select` element with this attribute changes in value, the search will be updated to use that value as the new sort order.
- *
- * ## 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 ./sorting.component.hbs}
- *
- * @category Search
- */
-export declare class SortingComponent extends BaseComponent<SortingComponentConfig, Sorting, SortingComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    protected renderContent(): boolean;
-    protected getContentModel(): SortingComponentModel;
-    protected onRender(): void;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, SortingComponentConfig } from '@configuration';
+import { Sorting, SortingComponentModel } from '@models';
+/**
+ * The Sorting component is used to select the logic for ordering search results.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-sorting>`.
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-sort | |
+ *
+ * When a `select` element with this attribute changes in value, the search will be updated to use that value as the new sort order.
+ *
+ * ## 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 ./sorting.component.hbs}
+ *
+ * @category Search
+ */
+export declare class SortingComponent extends BaseComponent<SortingComponentConfig, Sorting, SortingComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected renderContent(): boolean;
+    protected getContentModel(): SortingComponentModel;
+    protected onRender(): void;
+}

package/dist/components/search/tabs/tabs.component.d.ts

@@ -1,30 +1,30 @@
-import { HawkSearchComponents, TabsComponentConfig } from '@configuration';
-import { Facet, TabsComponentModel } from '@models';
-import { BaseComponent } from '../../base.component';
-/**
- * The Tabs component is used to segment search results by item type, often products and content.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-tabs>`.
- *
- * ## Event-Binding Attributes
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-tab-value | `string` |
- *
- * When an element with this attribute is clicked, the specified tab facet value will be selected and the search results will update.
- *
- * ## 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 ./tabs.component.hbs}
- *
- * @category Search
- */
-export declare class TabsComponent extends BaseComponent<TabsComponentConfig, Facet, TabsComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    protected renderContent(): boolean;
-    protected getContentModel(): TabsComponentModel;
-    protected onRender(): void;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, TabsComponentConfig } from '@configuration';
+import { Facet, TabsComponentModel } from '@models';
+/**
+ * The Tabs component is used to segment search results by item type, often products and content.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-tabs>`.
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-tab-value | `string` |
+ *
+ * When an element with this attribute is clicked, the specified tab facet value will be selected and the search results will update.
+ *
+ * ## 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 ./tabs.component.hbs}
+ *
+ * @category Search
+ */
+export declare class TabsComponent extends BaseComponent<TabsComponentConfig, Facet, TabsComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected renderContent(): boolean;
+    protected getContentModel(): TabsComponentModel;
+    protected onRender(): void;
+}

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

@@ -0,0 +1 @@
+export * from './variant-selector/variant-selector.component';

package/dist/components/variants/variant-selector/variant-selector.component.d.ts

@@ -0,0 +1,23 @@
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, VariantSelectorComponentConfig } from '@configuration';
+import { VariantSelectorComponentModel, Variants } from '@models';
+/**
+ * The Variant Selector component is used to select a single variant within an item.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-variant-selector>`.
+ *
+ * ## 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 ./variant-selector.component.hbs}
+ *
+ * @category Variants
+ */
+export declare class VariantSelectorComponent extends BaseComponent<VariantSelectorComponentConfig, Variants, VariantSelectorComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected renderContent(): boolean;
+    protected getContentModel(): VariantSelectorComponentModel;
+    protected onRender(): void;
+}