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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/changelog.md +106 -102
  2. package/dist/components/base.component.d.ts +139 -139
  3. package/dist/components/content/content-types/base-content.component.d.ts +9 -9
  4. package/dist/components/content/content-types/custom-content/custom-content.component.d.ts +21 -21
  5. package/dist/components/content/content-types/featured-items-content/featured-items-content.component.d.ts +22 -22
  6. package/dist/components/content/content-types/featured-items-content-item/featured-items-content-item.component.d.ts +39 -39
  7. package/dist/components/content/content-types/image-content/image-content.component.d.ts +22 -22
  8. package/dist/components/content/content-types/index.d.ts +6 -6
  9. package/dist/components/content/content-types/popular-queries-content/popular-queries-content.component.d.ts +22 -22
  10. package/dist/components/content/content-zone/content-zone.component.d.ts +44 -44
  11. package/dist/components/content/index.d.ts +2 -2
  12. package/dist/components/general/date-picker/date-picker.component.d.ts +117 -117
  13. package/dist/components/general/icon/icon.component.d.ts +38 -38
  14. package/dist/components/general/index.d.ts +5 -5
  15. package/dist/components/general/range-slider/range-slider.component.d.ts +54 -54
  16. package/dist/components/general/rating/rating.component.d.ts +39 -39
  17. package/dist/components/general/tooltip/tooltip.component.d.ts +32 -32
  18. package/dist/components/index.d.ts +229 -229
  19. package/dist/components/landing-pages/index.d.ts +1 -1
  20. package/dist/components/landing-pages/landing-page/landing-page.component.d.ts +32 -32
  21. package/dist/components/recommendations/index.d.ts +2 -2
  22. package/dist/components/recommendations/recommendations/recommendations.component.d.ts +87 -87
  23. package/dist/components/recommendations/recommendations-item/recommendations-item.component.d.ts +40 -40
  24. package/dist/components/search/autocomplete/autocomplete.component.d.ts +59 -59
  25. package/dist/components/search/facet-types/base-facet.component.d.ts +44 -44
  26. package/dist/components/search/facet-types/checkbox-list-facet/checkbox-list-facet.component.d.ts +36 -36
  27. package/dist/components/search/facet-types/color-facet/color-facet.component.d.ts +24 -24
  28. package/dist/components/search/facet-types/date-range-facet/date-range-facet.component.d.ts +33 -33
  29. package/dist/components/search/facet-types/index.d.ts +11 -11
  30. package/dist/components/search/facet-types/linked-list-facet/link-list-facet.component.d.ts +24 -24
  31. package/dist/components/search/facet-types/numeric-range-facet/numeric-range-facet.component.d.ts +32 -32
  32. package/dist/components/search/facet-types/range-slider-facet/range-slider-facet.component.d.ts +34 -34
  33. package/dist/components/search/facet-types/recent-searches-facet/recent-searches-facet.component.d.ts +29 -29
  34. package/dist/components/search/facet-types/related-searches-facet/related-searches-facet.component.d.ts +29 -29
  35. package/dist/components/search/facet-types/search-within-facet/search-within-facet.component.d.ts +29 -29
  36. package/dist/components/search/facet-types/size-facet/size-facet.component.d.ts +24 -24
  37. package/dist/components/search/facet-wrapper/facet-wrapper.component.d.ts +47 -47
  38. package/dist/components/search/facets-list/facets-list.component.d.ts +32 -32
  39. package/dist/components/search/index.d.ts +15 -15
  40. package/dist/components/search/modified-query/modified-query.component.d.ts +32 -32
  41. package/dist/components/search/page-size/page-size.component.d.ts +32 -32
  42. package/dist/components/search/pagination/pagination.component.d.ts +43 -43
  43. package/dist/components/search/query-suggestions/query-suggestions.component.d.ts +38 -38
  44. package/dist/components/search/search-field/search-field.component.d.ts +38 -38
  45. package/dist/components/search/search-results/search-results.component.d.ts +34 -34
  46. package/dist/components/search/search-results-item/search-results-item.component.d.ts +38 -38
  47. package/dist/components/search/search-results-list/search-results-list.component.d.ts +23 -23
  48. package/dist/components/search/selected-facets/selected-facets.component.d.ts +31 -31
  49. package/dist/components/search/sorting/sorting.component.d.ts +30 -30
  50. package/dist/components/search/tabs/tabs.component.d.ts +30 -30
  51. package/dist/components/variants/index.d.ts +1 -1
  52. package/dist/components/variants/variant-selector/variant-selector.component.d.ts +23 -23
  53. package/dist/configuration/configuration.models.d.ts +574 -574
  54. package/dist/configuration/index.d.ts +4 -4
  55. package/dist/helpers/helpers.d.ts +200 -200
  56. package/dist/helpers/index.d.ts +4 -4
  57. package/dist/index.d.ts +1 -1
  58. package/dist/index.js +1 -1
  59. package/dist/index.js.map +1 -1
  60. package/dist/models/autocomplete.models.d.ts +85 -85
  61. package/dist/models/base.models.d.ts +50 -50
  62. package/dist/models/component.models.d.ts +453 -453
  63. package/dist/models/content.models.d.ts +94 -94
  64. package/dist/models/index.d.ts +11 -11
  65. package/dist/models/raw/index.d.ts +4 -4
  66. package/dist/models/raw/raw-autocomplete.models.d.ts +51 -51
  67. package/dist/models/raw/raw-base.models.d.ts +8 -8
  68. package/dist/models/raw/raw-recommendation.models.d.ts +39 -39
  69. package/dist/models/raw/raw-search.models.d.ts +191 -191
  70. package/dist/models/recommendation.models.d.ts +31 -31
  71. package/dist/models/search.models.d.ts +237 -237
  72. package/dist/models/tracking.models.d.ts +42 -42
  73. package/dist/services/autocomplete.service.d.ts +10 -10
  74. package/dist/services/base.service.d.ts +63 -63
  75. package/dist/services/index.d.ts +8 -8
  76. package/dist/services/recommendations.service.d.ts +10 -10
  77. package/dist/services/search.service.d.ts +50 -50
  78. package/dist/services/tracking.service.d.ts +29 -29
  79. package/dist/utilities/colors.d.ts +1 -1
  80. package/dist/utilities/dates.d.ts +4 -4
  81. package/dist/utilities/formatters.d.ts +4 -4
  82. package/dist/utilities/index.d.ts +6 -6
  83. package/package.json +1 -1
  84. package/readme.md +1 -1
@@ -1,54 +1,54 @@
1
- import { BaseComponent } from '@components';
2
- import { HawkSearchComponents, RangeSliderComponentConfig } from '@configuration';
3
- import { RangeSliderComponentModel } from '@models';
4
- /**
5
- * 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}.
6
- *
7
- * ## Tag
8
- * The tag for this component is `<hawksearch-range-slider>`.
9
- *
10
- * ## Event-Binding Attributes
11
- * | Name | Value |
12
- * | :- | :- |
13
- * | hawksearch-handle | `'start'` or `'end'` |
14
- *
15
- * 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.
16
- *
17
- * ## Events
18
- * | Name | Data Type |
19
- * | :- | :- |
20
- * | hawksearch:range-slider-changed | {@link Models.RangeSliderEventData} |
21
- *
22
- * This event fires repeatedly while the user is dragging the handles; it does not wait until the user deselects a handle.
23
- *
24
- * *Note: The `min` and `max` values will always be between `0` and `100` inclusive.*
25
- *
26
- * ## Default Template
27
- * 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.
28
- * {@embed ./range-slider.component.hbs}
29
- *
30
- * @category General
31
- */
32
- export declare class RangeSliderComponent extends BaseComponent<RangeSliderComponentConfig, never, RangeSliderComponentModel> {
33
- static get observedAttributes(): Array<string>;
34
- protected componentName: keyof HawkSearchComponents;
35
- protected defaultHtml: any;
36
- protected bindFromEvent: boolean;
37
- private dragging;
38
- private activeHandle?;
39
- private startX?;
40
- private startOffsetPercentage?;
41
- private mouseUpEventHandler;
42
- private mouseMoveEventHandler;
43
- private start;
44
- private end;
45
- connectedCallback(): void;
46
- attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
47
- disconnectedCallback(): void;
48
- private setStart;
49
- private setEnd;
50
- protected getContentModel(): RangeSliderComponentModel;
51
- protected onRender(): void;
52
- private onMouseUp;
53
- private onMouseMove;
54
- }
1
+ import { BaseComponent } from '@components';
2
+ import { HawkSearchComponents, RangeSliderComponentConfig } from '@configuration';
3
+ import { RangeSliderComponentModel } from '@models';
4
+ /**
5
+ * 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}.
6
+ *
7
+ * ## Tag
8
+ * The tag for this component is `<hawksearch-range-slider>`.
9
+ *
10
+ * ## Event-Binding Attributes
11
+ * | Name | Value |
12
+ * | :- | :- |
13
+ * | hawksearch-handle | `'start'` or `'end'` |
14
+ *
15
+ * 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.
16
+ *
17
+ * ## Events
18
+ * | Name | Data Type |
19
+ * | :- | :- |
20
+ * | hawksearch:range-slider-changed | {@link Models.RangeSliderEventData} |
21
+ *
22
+ * This event fires repeatedly while the user is dragging the handles; it does not wait until the user deselects a handle.
23
+ *
24
+ * *Note: The `min` and `max` values will always be between `0` and `100` inclusive.*
25
+ *
26
+ * ## Default Template
27
+ * 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.
28
+ * {@embed ./range-slider.component.hbs}
29
+ *
30
+ * @category General
31
+ */
32
+ export declare class RangeSliderComponent extends BaseComponent<RangeSliderComponentConfig, never, RangeSliderComponentModel> {
33
+ static get observedAttributes(): Array<string>;
34
+ protected componentName: keyof HawkSearchComponents;
35
+ protected defaultHtml: any;
36
+ protected bindFromEvent: boolean;
37
+ private dragging;
38
+ private activeHandle?;
39
+ private startX?;
40
+ private startOffsetPercentage?;
41
+ private mouseUpEventHandler;
42
+ private mouseMoveEventHandler;
43
+ private start;
44
+ private end;
45
+ connectedCallback(): void;
46
+ attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
47
+ disconnectedCallback(): void;
48
+ private setStart;
49
+ private setEnd;
50
+ protected getContentModel(): RangeSliderComponentModel;
51
+ protected onRender(): void;
52
+ private onMouseUp;
53
+ private onMouseMove;
54
+ }
@@ -1,39 +1,39 @@
1
- import { BaseComponent } from '@components';
2
- import { HawkSearchComponents, RatingComponentConfig } from '@configuration';
3
- import { RatingComponentModel } from '@models';
4
- /**
5
- * The Rating component is used to display a visual representation of ratings for a particular product.
6
- *
7
- * ## Tag
8
- * The tag for this component is `<hawksearch-rating>`.
9
- *
10
- * ## Attributes
11
- * | Name | Type | Default Value | Required |
12
- * | :- | :- | :- | :- |
13
- * | rating | `number` | | Yes
14
- *
15
- * 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.
16
- *
17
- * ## Handlebars Helpers
18
- * | Name | Rating | Star Number
19
- * | :- | :- | :- |
20
- * | ratingIcon | `number` | `number` |
21
- *
22
- * This helper function returns the icon name to display for a given rating and star number (1-5)
23
- *
24
- * ## Default Template
25
- * 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.
26
- * {@embed ./rating.component.hbs}
27
- *
28
- * @category General
29
- */
30
- export declare class RatingComponent extends BaseComponent<RatingComponentConfig, number, RatingComponentModel> {
31
- protected componentName: keyof HawkSearchComponents;
32
- protected defaultHtml: any;
33
- protected bindFromEvent: boolean;
34
- protected registerHelpers(): void;
35
- private get rating();
36
- protected renderContent(): boolean;
37
- protected getContentModel(): RatingComponentModel;
38
- protected onRender(): void;
39
- }
1
+ import { BaseComponent } from '@components';
2
+ import { HawkSearchComponents, RatingComponentConfig } from '@configuration';
3
+ import { RatingComponentModel } from '@models';
4
+ /**
5
+ * The Rating component is used to display a visual representation of ratings for a particular product.
6
+ *
7
+ * ## Tag
8
+ * The tag for this component is `<hawksearch-rating>`.
9
+ *
10
+ * ## Attributes
11
+ * | Name | Type | Default Value | Required |
12
+ * | :- | :- | :- | :- |
13
+ * | rating | `number` | | Yes
14
+ *
15
+ * 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.
16
+ *
17
+ * ## Handlebars Helpers
18
+ * | Name | Rating | Star Number
19
+ * | :- | :- | :- |
20
+ * | ratingIcon | `number` | `number` |
21
+ *
22
+ * This helper function returns the icon name to display for a given rating and star number (1-5)
23
+ *
24
+ * ## Default Template
25
+ * 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.
26
+ * {@embed ./rating.component.hbs}
27
+ *
28
+ * @category General
29
+ */
30
+ export declare class RatingComponent extends BaseComponent<RatingComponentConfig, number, RatingComponentModel> {
31
+ protected componentName: keyof HawkSearchComponents;
32
+ protected defaultHtml: any;
33
+ protected bindFromEvent: boolean;
34
+ protected registerHelpers(): void;
35
+ private get rating();
36
+ protected renderContent(): boolean;
37
+ protected getContentModel(): RatingComponentModel;
38
+ protected onRender(): void;
39
+ }
@@ -1,32 +1,32 @@
1
- import { BaseComponent } from '@components';
2
- import { HawkSearchComponents, TooltipComponentConfig } from '@configuration';
3
- import { TooltipComponentModel } from '@models';
4
- /**
5
- * The Tooltip component is used to display a brief explanation or contextual information when the user hovers over an element.
6
- *
7
- * ## Tag
8
- * The tag for this component is `<hawksearch-tooltip>`.
9
- *
10
- * ## Event-Binding Attributes
11
- * | Name | Value |
12
- * | :- | :- |
13
- * | hawksearch-tooltip | |
14
- * | hawksearch-tooltip-content | |
15
- *
16
- * 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.
17
- *
18
- * ## Default Template
19
- * 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.
20
- * {@embed ./tooltip.component.hbs}
21
- *
22
- * @category General
23
- */
24
- export declare class TooltipComponent extends BaseComponent<TooltipComponentConfig, string, TooltipComponentModel> {
25
- protected componentName: keyof HawkSearchComponents;
26
- protected defaultHtml: any;
27
- protected bindFromEvent: boolean;
28
- private get text();
29
- protected renderContent(): boolean;
30
- protected getContentModel(): TooltipComponentModel;
31
- protected onRender(): void;
32
- }
1
+ import { BaseComponent } from '@components';
2
+ import { HawkSearchComponents, TooltipComponentConfig } from '@configuration';
3
+ import { TooltipComponentModel } from '@models';
4
+ /**
5
+ * The Tooltip component is used to display a brief explanation or contextual information when the user hovers over an element.
6
+ *
7
+ * ## Tag
8
+ * The tag for this component is `<hawksearch-tooltip>`.
9
+ *
10
+ * ## Event-Binding Attributes
11
+ * | Name | Value |
12
+ * | :- | :- |
13
+ * | hawksearch-tooltip | |
14
+ * | hawksearch-tooltip-content | |
15
+ *
16
+ * 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.
17
+ *
18
+ * ## Default Template
19
+ * 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.
20
+ * {@embed ./tooltip.component.hbs}
21
+ *
22
+ * @category General
23
+ */
24
+ export declare class TooltipComponent extends BaseComponent<TooltipComponentConfig, string, TooltipComponentModel> {
25
+ protected componentName: keyof HawkSearchComponents;
26
+ protected defaultHtml: any;
27
+ protected bindFromEvent: boolean;
28
+ private get text();
29
+ protected renderContent(): boolean;
30
+ protected getContentModel(): TooltipComponentModel;
31
+ protected onRender(): void;
32
+ }