@bridgeline-digital/hawksearch-handlebars-ui 6.1.3 → 6.1.4

package/changelog.md

@@ -1,3 +1,9 @@
+# 6.1.4
+
+## Bug Fixes
+
+1. Fixed bug with Quick Lookup filtering not handling special characters correctly, e.g. '(',')', etc
+
 # 6.1.3
 
 ## Enhancements

package/dist/components/base.component.d.ts

@@ -0,0 +1,139 @@
+import { BaseComponentConfig, HawkSearchComponents } from '@configuration';
+import { BaseComponentModel } from '@models';
+/**
+ * @typeParam TConfig Component configuration
+ * @typeParam TData Component data
+ * @typeParam TModel Data bound to Handlebars template
+ *
+ * @noInheritDoc
+ * @category Base
+ */
+export declare abstract class BaseComponent<TConfig extends BaseComponentConfig, TData, TModel extends BaseComponentModel> extends HTMLElement {
+    /**
+     * Optional instance-level configuration to override the global configuration
+     */
+    configOverride?: TConfig;
+    /**
+     * The data bound to the component.
+     */
+    data?: TData;
+    /**
+     * The Handlebars reference shared by all HawkSearch components.
+     */
+    protected handlebars: typeof Handlebars;
+    /**
+     * For components that may have multiple instances with different data sources, this property is used to identify the subset of data used for binding.
+     *
+     * @internal
+     */
+    protected eventFilter?: string;
+    /**
+     * The data bound to the Handlebars template.
+     */
+    protected contentModel?: TModel;
+    /**
+     * The name of the component. This value is appended to `hawksearch-` to determine the tag name. For example, a value of `search-results` would be rendered by `<hawksearch-search-results>`.
+     *
+     * @internal
+     */
+    protected abstract componentName: keyof HawkSearchComponents;
+    /**
+     * The default Handlebars template.
+     *
+     * @internal
+     */
+    protected abstract defaultHtml: string;
+    /**
+     * Determines whether the component is bound by an event. If `false`, binding is performed by the parent component.
+     *
+     * @internal
+     */
+    protected abstract bindFromEvent: boolean;
+    /**
+     * The optional configuration object for this component.
+     */
+    protected get configuration(): TConfig | undefined;
+    /**
+     * Whether or not the component is rendered within the Shadow DOM. In order of preference, this is specified by {@link configuration} or {@link Models.HawkSearchConfig.shadowDom}.
+     *
+     * @internal
+     * @defaultValue `true`
+     */
+    protected get shadowDom(): boolean;
+    /**
+     * 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`.
+     */
+    get rootElement(): ParentNode;
+    /**
+     * 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.
+     *
+     * @internal
+     */
+    private get eventName();
+    /**
+     * @internal
+     */
+    private bindEventHandler?;
+    /**
+     * @internal
+     */
+    private template;
+    /**
+     * @ignore
+     */
+    connectedCallback(): void;
+    /**
+     * @ignore
+     */
+    disconnectedCallback(): void;
+    /**
+     * Optional method that can be overwritten to register Handlebars helper functions which can be accessed from the template. For more information, see [Custom Helpers](https://handlebarsjs.com/guide/#custom-helpers).
+     *
+     * @virtual
+     */
+    protected registerHelpers(): void;
+    /**
+     * Binds {@link contentModel} to the Handlebars template and renders the resulting HTML content.
+     */
+    render(): void;
+    /**
+     * Determines whether the {@link data} meets the necessary conditions to perform data binding and render content.
+     *
+     * @virtual
+     * @returns Whether the component should be rendered. If `false`, the component will have empty contents and be set to `display: none;`.
+     */
+    protected renderContent(): boolean;
+    /**
+     * Gets the data to be bound to the Handlebars template.
+     *
+     * @internal
+     * @returns The data bound to the Handlebars template.
+     */
+    protected abstract getContentModel(): TModel;
+    /**
+     * After the component is rendered, this method is called to bind any child components.
+     *
+     * @virtual
+     */
+    protected bindChildElements(): void;
+    /**
+     * After the component is rendered, this method is called for any additional processing (such as attaching event listeners) which needs to occur.
+     *
+     * @virtual
+     */
+    protected onRender(): void;
+    /**
+     * @returns The Handlebars template HTML. In order of preference, this is specified by the child contents of the HTML element, the template specified by {@link configuration}, or the default template for the component.
+     *
+     * @internal
+     */
+    private getCustomTemplateHtml;
+    /**
+     * Replaces placeholders in a given string with values from a data object.
+     *
+     * @param template The template string.
+     * @param values The object containing properties which will be bound to `template`.
+     * @returns The `template` string with all placeholders replaced by the values specified in `values`.
+     */
+    protected interpolate(template: string, values: Record<string, string>): string;
+}

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

@@ -0,0 +1,9 @@
+import { BaseComponent } from '@components';
+import { BaseComponentConfig } from '@configuration';
+import { BaseComponentModel, ContentType } from '@models';
+/**
+ * @category Content
+ */
+export declare abstract class BaseContentComponent<TConfig extends BaseComponentConfig, TData extends ContentType, TModel extends BaseComponentModel> extends BaseComponent<TConfig, TData, TModel> {
+    protected bindFromEvent: boolean;
+}

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

@@ -0,0 +1,21 @@
+import { CustomContentComponentConfig, HawkSearchComponents } from '@configuration';
+import { CustomContent, CustomContentComponentModel } from '@models';
+import { BaseContentComponent } from '../base-content.component';
+/**
+ * The Custom Content component renders HTML defined in HawkSearch.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-custom-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 ./custom-content.component.hbs}
+ *
+ * @category Content
+ */
+export declare class CustomContentComponent extends BaseContentComponent<CustomContentComponentConfig, CustomContent, CustomContentComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected renderContent(): boolean;
+    protected getContentModel(): CustomContentComponentModel;
+}

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

@@ -0,0 +1,22 @@
+import { FeaturedItemsContentComponentConfig, HawkSearchComponents } from '@configuration';
+import { FeaturedItemsContent, FeaturedItemsContentComponentModel } from '@models';
+import { BaseContentComponent } from '../base-content.component';
+/**
+ * The Featured Items Content component renders a custom list of search results (typically products) defined as Spotlights in HawkSearch. This is commonly used to display a default set of products when a query returns no results.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-featured-items-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 ./featured-items-content.component.hbs}
+ *
+ * @category Content
+ */
+export declare class FeaturedItemsContentComponent extends BaseContentComponent<FeaturedItemsContentComponentConfig, FeaturedItemsContent, FeaturedItemsContentComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected renderContent(): boolean;
+    protected getContentModel(): FeaturedItemsContentComponentModel;
+    protected bindChildElements(): void;
+}

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

@@ -0,0 +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;
+}

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

@@ -0,0 +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;
+}

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

@@ -0,0 +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';

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

@@ -0,0 +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;
+}

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

@@ -0,0 +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;
+}

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

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

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

@@ -0,0 +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;
+}

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

@@ -0,0 +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;
+}

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

@@ -0,0 +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';

package/dist/components/general/range-slider/range-slider.component.d.ts

@@ -0,0 +1,54 @@
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, RangeSliderComponentConfig } from '@configuration';
+import { RangeSliderComponentModel } from '@models';
+/**
+ * The Range Slider component provides a draggable interface that allows the user to select a range between 0-100. This component is currently only used within the {@link Components.RangeSliderFacetComponent | Range Slider Facet Component}.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-range-slider>`.
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-handle | `'start'` or `'end'` |
+ *
+ * This component should always have exactly two elements with the `hawksearch-handle` attribute: one with a value of `'start'`, and one with a value of `'end'`. This are the elements that the user will drag to adjust the selected range.
+ *
+ * ## Events
+ * | Name | Data Type |
+ * | :- | :- |
+ * | hawksearch:range-slider-changed | {@link Models.RangeSliderEventData} |
+ *
+ * This event fires repeatedly while the user is dragging the handles; it does not wait until the user deselects a handle.
+ *
+ * *Note: The `min` and `max` values will always be between `0` and `100` inclusive.*
+ *
+ * ## 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 ./range-slider.component.hbs}
+ *
+ * @category General
+ */
+export declare class RangeSliderComponent extends BaseComponent<RangeSliderComponentConfig, never, RangeSliderComponentModel> {
+    static get observedAttributes(): Array<string>;
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    private dragging;
+    private activeHandle?;
+    private startX?;
+    private startOffsetPercentage?;
+    private mouseUpEventHandler;
+    private mouseMoveEventHandler;
+    private start;
+    private end;
+    connectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    disconnectedCallback(): void;
+    private setStart;
+    private setEnd;
+    protected getContentModel(): RangeSliderComponentModel;
+    protected onRender(): void;
+    private onMouseUp;
+    private onMouseMove;
+}

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

@@ -0,0 +1,39 @@
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, RatingComponentConfig } from '@configuration';
+import { RatingComponentModel } from '@models';
+/**
+ * The Rating component is used to display a visual representation of ratings for a particular product.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-rating>`.
+ *
+ * ## Attributes
+ * | Name | Type | Default Value | Required |
+ * | :- | :- | :- | :- |
+ * | rating | `number` | | Yes
+ *
+ * These attributes are used to position the tooltip based on the size and scroll position of the active window. The `hawksearch-tooltip` attribute should be present on an element containing both the element the tooltip is attached to (to display on hover) and the element containing the tooltip content, which should have a `hawksearch-tooltip-content` attribute.
+ *
+ * ## Handlebars Helpers
+ * | Name | Rating | Star Number
+ * | :- | :- | :- |
+ * | ratingIcon | `number` | `number` |
+ *
+ * This helper function returns the icon name to display for a given rating and star number (1-5)
+ *
+ * ## 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 ./rating.component.hbs}
+ *
+ * @category General
+ */
+export declare class RatingComponent extends BaseComponent<RatingComponentConfig, number, RatingComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    protected registerHelpers(): void;
+    private get rating();
+    protected renderContent(): boolean;
+    protected getContentModel(): RatingComponentModel;
+    protected onRender(): void;
+}

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

@@ -0,0 +1,32 @@
+import { BaseComponent } from '@components';
+import { HawkSearchComponents, TooltipComponentConfig } from '@configuration';
+import { TooltipComponentModel } from '@models';
+/**
+ * The Tooltip component is used to display a brief explanation or contextual information when the user hovers over an element.
+ *
+ * ## Tag
+ * The tag for this component is `<hawksearch-tooltip>`.
+ *
+ * ## Event-Binding Attributes
+ * | Name | Value |
+ * | :- | :- |
+ * | hawksearch-tooltip | |
+ * | hawksearch-tooltip-content | |
+ *
+ * These attributes are used to position the tooltip based on the size and scroll position of the active window. The `hawksearch-tooltip` attribute should be present on an element containing both the element the tooltip is attached to (to display on hover) and the element containing the tooltip content, which should have a `hawksearch-tooltip-content` attribute.
+ *
+ * ## 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 ./tooltip.component.hbs}
+ *
+ * @category General
+ */
+export declare class TooltipComponent extends BaseComponent<TooltipComponentConfig, string, TooltipComponentModel> {
+    protected componentName: keyof HawkSearchComponents;
+    protected defaultHtml: any;
+    protected bindFromEvent: boolean;
+    private get text();
+    protected renderContent(): boolean;
+    protected getContentModel(): TooltipComponentModel;
+    protected onRender(): void;
+}