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

package/dist/components/search/modified-query/modified-query.component.d.ts

@@ -1,32 +1,32 @@
-import { BaseComponent } from '@components';
-import { HawkSearchComponents, ModifiedQueryComponentConfig } from '@configuration';
-import { ModifiedQueryComponentModel, ModifiedQueryData } from '@models';
-/**
- * The Modified Query component is rendered when the spellchecker detects a spelling error and searches for the correctly-spelled query instead.
- *
- * *Note: This component is only visible for new searches. If the spellchecker revises a query and the user then performs an action such as applying facet or moving to another page of results, it is implied that the user accepts the correction.*
- *
- * ## Tag
- * The tag for this component is `<hawksearch-modified-query>`.
- *
- * ## Event-Binding Attributes
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-query | `string` |
- *
- * When an element with this attribute is clicked, a new search will be executed with the specified query and spellcheck functionality disabled. This is useful when the spellchecker mistakes a valid entry for another term.
- *
- * ## 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 ./modified-query.component.hbs}
- *
- * @category Search
- */
-export declare class ModifiedQueryComponent extends BaseComponent<ModifiedQueryComponentConfig, ModifiedQueryData, ModifiedQueryComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    protected renderContent(): boolean;
-    protected getContentModel(): ModifiedQueryComponentModel;
-    protected onRender(): void;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, ModifiedQueryComponentConfig } from '@configuration';
+import { ModifiedQueryComponentModel, ModifiedQueryData } from '@models';
+/**
+ * The Modified Query component is rendered when the spellchecker detects a spelling error and searches for the correctly-spelled query instead.
+ *
+ * *Note: This component is only visible for new searches. If the spellchecker revises a query and the user then performs an action such as applying facet or moving to another page of results, it is implied that the user accepts the correction.*
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-modified-query>`.
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-query | `string` |
+ *
+ * When an element with this attribute is clicked, a new search will be executed with the specified query and spellcheck functionality disabled. This is useful when the spellchecker mistakes a valid entry for another term.
+ *
+ * ## 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 ./modified-query.component.hbs}
+ *
+ * @category Search
+ */
+export declare class ModifiedQueryComponent extends BaseComponent<ModifiedQueryComponentConfig, ModifiedQueryData, ModifiedQueryComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected renderContent(): boolean;
+    protected getContentModel(): ModifiedQueryComponentModel;
+    protected onRender(): void;
+}

package/dist/components/search/page-size/page-size.component.d.ts

@@ -1,32 +1,32 @@
-import { BaseComponent } from '@components';
-import { HawkSearchComponents, PageSizeComponentConfig } from '@configuration';
-import { PageSizeComponentModel, PaginationOption } from '@models';
-/**
- * The Page Size component is used to modify the number of search results displayed on each page.
- *
- * *Note: When the page size changes, the first page will automatically be selected.*
- *
- * ## Tag
- * The tag for this component is `<hawksearch-page-size>`.
- *
- * ## Event-Binding Attributes
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-page-size | |
- *
- * When a `select` element with this attribute changes in value, the search will be updated to use that value as the new page size.
- *
- * ## 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 ./page-size.component.hbs}
- *
- * @category Search
- */
-export declare class PageSizeComponent extends BaseComponent<PageSizeComponentConfig, Array<PaginationOption>, PageSizeComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    protected renderContent(): boolean;
-    protected getContentModel(): PageSizeComponentModel;
-    protected onRender(): void;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, PageSizeComponentConfig } from '@configuration';
+import { PageSizeComponentModel, PaginationOption } from '@models';
+/**
+ * The Page Size component is used to modify the number of search results displayed on each page.
+ *
+ * *Note: When the page size changes, the first page will automatically be selected.*
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-page-size>`.
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-page-size | |
+ *
+ * When a `select` element with this attribute changes in value, the search will be updated to use that value as the new page size.
+ *
+ * ## 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 ./page-size.component.hbs}
+ *
+ * @category Search
+ */
+export declare class PageSizeComponent extends BaseComponent<PageSizeComponentConfig, Array<PaginationOption>, PageSizeComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected renderContent(): boolean;
+    protected getContentModel(): PageSizeComponentModel;
+    protected onRender(): void;
+}

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

@@ -1,43 +1,43 @@
-import { BaseComponent } from '@components';
-import { HawkSearchComponents, PaginationComponentConfig } from '@configuration';
-import { Pagination, PaginationComponentModel } from '@models';
-/**
- * The Pagination component is used to navigate between different pages of a search results set.
- *
- * *Note: If no maximum number of page links to display is configured in the HawkSearch admin, a default value of `9` will be used.*
- *
- * ## Tag
- * The tag for this component is `<hawksearch-pagination>`.
- *
- * ## Event-Binding Attributes
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-page | `number` |
- *
- * When an element with this attribute is clicked, the current search will be updated to display the results from the specified page.
- *
- * ## Handlebars Helpers
- * | Name | Parameter |
- * | :- | :- |
- * | pageUrl | `number` |
- *
- * This helper function returns the URL for the specified page to enable crawling.
- *
- * ## 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 ./pagination.component.hbs}
- *
- * @category Search
- */
-export declare class PaginationComponent extends BaseComponent<PaginationComponentConfig, Pagination, PaginationComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    private defaultMaxPageLinks;
-    protected registerHelpers(): void;
-    protected renderContent(): boolean;
-    protected getContentModel(): PaginationComponentModel;
-    protected onRender(): void;
-    protected setPage(page: number): Promise<void>;
-    private getPages;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, PaginationComponentConfig } from '@configuration';
+import { Pagination, PaginationComponentModel } from '@models';
+/**
+ * The Pagination component is used to navigate between different pages of a search results set.
+ *
+ * *Note: If no maximum number of page links to display is configured in the HawkSearch admin, a default value of `9` will be used.*
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-pagination>`.
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-page | `number` |
+ *
+ * When an element with this attribute is clicked, the current search will be updated to display the results from the specified page.
+ *
+ * ## Handlebars Helpers
+ * | Name | Parameter |
+ * | :- | :- |
+ * | pageUrl | `number` |
+ *
+ * This helper function returns the URL for the specified page to enable crawling.
+ *
+ * ## 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 ./pagination.component.hbs}
+ *
+ * @category Search
+ */
+export declare class PaginationComponent extends BaseComponent<PaginationComponentConfig, Pagination, PaginationComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    private defaultMaxPageLinks;
+    protected registerHelpers(): void;
+    protected renderContent(): boolean;
+    protected getContentModel(): PaginationComponentModel;
+    protected onRender(): void;
+    protected setPage(page: number): Promise<void>;
+    private getPages;
+}

package/dist/components/search/query-suggestions/query-suggestions.component.d.ts

@@ -1,38 +1,38 @@
-import { BaseComponent } from '@components';
-import { HawkSearchComponents, QuerySuggestionsComponentConfig } from '@configuration';
-import { QuerySuggestionsComponentModel, QuerySuggestionsData } from '@models';
-/**
- * The Query Suggestions component displays a list of possible queries that the search engine detects the user may be looking for.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-query-suggestions>`.
- *
- * ## Event-Binding Attributes
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-query | `string` |
- *
- * When an element with this attribute is clicked, a new search will be formed for the specified query.
- *
- * ## Handlebars Helpers
- * | Name | Parameter |
- * | :- | :- |
- * | query-suggestions | `Array<string>` |
- *
- * This helper function creates a comma-separated list of links with the `hawksearch-query` attribute, using the word “or” before the last link.
- *
- * ## 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 ./query-suggestions.component.hbs}
- *
- * @category Search
- */
-export declare class QuerySuggestionsComponent extends BaseComponent<QuerySuggestionsComponentConfig, QuerySuggestionsData, QuerySuggestionsComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    protected registerHelpers(): void;
-    protected renderContent(): boolean;
-    protected getContentModel(): QuerySuggestionsComponentModel;
-    protected onRender(): void;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, QuerySuggestionsComponentConfig } from '@configuration';
+import { QuerySuggestionsComponentModel, QuerySuggestionsData } from '@models';
+/**
+ * The Query Suggestions component displays a list of possible queries that the search engine detects the user may be looking for.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-query-suggestions>`.
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-query | `string` |
+ *
+ * When an element with this attribute is clicked, a new search will be formed for the specified query.
+ *
+ * ## Handlebars Helpers
+ * | Name | Parameter |
+ * | :- | :- |
+ * | query-suggestions | `Array<string>` |
+ *
+ * This helper function creates a comma-separated list of links with the `hawksearch-query` attribute, using the word “or” before the last link.
+ *
+ * ## 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 ./query-suggestions.component.hbs}
+ *
+ * @category Search
+ */
+export declare class QuerySuggestionsComponent extends BaseComponent<QuerySuggestionsComponentConfig, QuerySuggestionsData, QuerySuggestionsComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected registerHelpers(): void;
+    protected renderContent(): boolean;
+    protected getContentModel(): QuerySuggestionsComponentModel;
+    protected onRender(): void;
+}

package/dist/components/search/search-field/search-field.component.d.ts

@@ -1,38 +1,38 @@
-import { BaseComponent } from '@components';
-import { HawkSearchComponents, SearchFieldComponentConfig } from '@configuration';
-import { SearchFieldComponentModel, SearchResponse } from '@models';
-/**
- * The Search component contains a text input element which triggers the {@link Components.AutocompleteComponent | Autocomplete component} as the user types and executes a new search when the user hits the `enter` key.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-search-field>`.
- *
- * ## Event-Binding Attributes
- * | Name | Value |
- * | :- | :- |
- * | hawksearch-input | |
- *
- * Input elements with this attribute will trigger {@link Components.AutocompleteComponent | Autocomplete} functionality when the user types and executes a new search when the user hits the `enter` key.
- *
- * ## 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-field.component.hbs}
- *
- * @category Search
- */
-export declare class SearchFieldComponent extends BaseComponent<SearchFieldComponentConfig, SearchResponse, SearchFieldComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    private clickEventHandler;
-    private defaultAutocompleteResponse?;
-    private previousAutocompleteResponse?;
-    private previousValue;
-    private get recommendationsEnabled();
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    protected getContentModel(): SearchFieldComponentModel;
-    protected onRender(): void;
-    private toggleAutocomplete;
-    private displayDefaultAutocomplete;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, SearchFieldComponentConfig } from '@configuration';
+import { SearchFieldComponentModel, SearchResponse } from '@models';
+/**
+ * The Search component contains a text input element which triggers the {@link Components.AutocompleteComponent | Autocomplete component} as the user types and executes a new search when the user hits the `enter` key.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-search-field>`.
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-input | |
+ *
+ * Input elements with this attribute will trigger {@link Components.AutocompleteComponent | Autocomplete} functionality when the user types and executes a new search when the user hits the `enter` key.
+ *
+ * ## 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-field.component.hbs}
+ *
+ * @category Search
+ */
+export declare class SearchFieldComponent extends BaseComponent<SearchFieldComponentConfig, SearchResponse, SearchFieldComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    private clickEventHandler;
+    private defaultAutocompleteResponse?;
+    private previousAutocompleteResponse?;
+    private previousValue;
+    private get recommendationsEnabled();
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    protected getContentModel(): SearchFieldComponentModel;
+    protected onRender(): void;
+    private toggleAutocomplete;
+    private displayDefaultAutocomplete;
+}

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

@@ -1,34 +1,34 @@
-import { BaseComponent } from '@components';
-import { HawkSearchComponents, SearchResultsComponentConfig } from '@configuration';
-import { SearchResponse, SearchResultsComponentModel, SearchResultsMode } from '@models';
-/**
- * The Search Results component encapsulates all components relating to search-results.
- *
- * ## Tag
- * The tag for this component is `<hawksearch-search-results>`.
- *
- * ## 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.component.hbs}
- *
- * @category Search
- */
-export declare class SearchResultsComponent extends BaseComponent<SearchResultsComponentConfig, SearchResponse, SearchResultsComponentModel> {
-    protected componentName: keyof HawkSearchComponents;
-    protected defaultHtml: any;
-    protected bindFromEvent: boolean;
-    /**
-     * Speficies the context that the component is being used. This is determined by the `mode` attribute on the HTML element.
-     *
-     * @defaultValue `'search-results'`
-     */
-    protected get mode(): SearchResultsMode;
-    /**
-     * If {@link mode} is set to `'landing-page'`, this specifies the URL sent to retrieve content from HawkSearch. This can be customized by setting the `url` attribute on the HTML element.
-     *
-     * @defaultValue `window.location.pathname`
-     */
-    protected get url(): string;
-    constructor();
-    protected getContentModel(): SearchResultsComponentModel;
-}
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, SearchResultsComponentConfig } from '@configuration';
+import { SearchResponse, SearchResultsComponentModel, SearchResultsMode } from '@models';
+/**
+ * The Search Results component encapsulates all components relating to search-results.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-search-results>`.
+ *
+ * ## 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.component.hbs}
+ *
+ * @category Search
+ */
+export declare class SearchResultsComponent extends BaseComponent<SearchResultsComponentConfig, SearchResponse, SearchResultsComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    /**
+     * Speficies the context that the component is being used. This is determined by the `mode` attribute on the HTML element.
+     *
+     * @defaultValue `'search-results'`
+     */
+    protected get mode(): SearchResultsMode;
+    /**
+     * If {@link mode} is set to `'landing-page'`, this specifies the URL sent to retrieve content from HawkSearch. This can be customized by setting the `url` attribute on the HTML element.
+     *
+     * @defaultValue `window.location.pathname`
+     */
+    protected get url(): string;
+    constructor();
+    protected getContentModel(): SearchResultsComponentModel;
+}

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

@@ -1,38 +1,38 @@
-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;
-}
+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 { 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;
-}
+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 { 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;
-}
+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;
+}