@empathyco/x-components 6.0.0-alpha.15 → 6.0.0-alpha.17

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 (123) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/design-system/deprecated-full-theme.css +1150 -1150
  3. package/docs/API-reference/api/x-components.animationprop.md +6 -1
  4. package/docs/API-reference/api/x-components.bannerslist.md +3 -3
  5. package/docs/API-reference/api/x-components.basedropdown.md +3 -3
  6. package/docs/API-reference/api/x-components.baseeventsmodal.md +2 -2
  7. package/docs/API-reference/api/x-components.basegrid.md +3 -3
  8. package/docs/API-reference/api/x-components.baseheadertogglepanel.md +3 -3
  9. package/docs/API-reference/api/x-components.baseidmodal.md +2 -2
  10. package/docs/API-reference/api/x-components.baseidtogglepanel.md +3 -3
  11. package/docs/API-reference/api/x-components.basemodal.md +6 -6
  12. package/docs/API-reference/api/x-components.baseresultimage.md +9 -9
  13. package/docs/API-reference/api/x-components.basesuggestions.md +3 -3
  14. package/docs/API-reference/api/x-components.basetabspanel.md +6 -6
  15. package/docs/API-reference/api/x-components.basetogglepanel.md +3 -3
  16. package/docs/API-reference/api/x-components.basevariablecolumngrid.md +3 -3
  17. package/docs/API-reference/api/x-components.empathize.md +3 -3
  18. package/docs/API-reference/api/x-components.facets.md +3 -3
  19. package/docs/API-reference/api/x-components.filterslist.md +3 -3
  20. package/docs/API-reference/api/x-components.hierarchicalfilter.md +2 -2
  21. package/docs/API-reference/api/x-components.identifierresults.md +3 -3
  22. package/docs/API-reference/api/x-components.itemslist.md +3 -3
  23. package/docs/API-reference/api/x-components.mainmodal.md +2 -2
  24. package/docs/API-reference/api/x-components.md +1 -0
  25. package/docs/API-reference/api/x-components.multicolumnmaxwidthlayout.md +3 -3
  26. package/docs/API-reference/api/x-components.myhistory.md +3 -3
  27. package/docs/API-reference/api/x-components.nextqueriesgroup.md +22 -0
  28. package/docs/API-reference/api/x-components.nextqueriesgroup.modelname.md +11 -0
  29. package/docs/API-reference/api/x-components.nextqueriesgroup.nextqueries.md +11 -0
  30. package/docs/API-reference/api/x-components.nextquerieslist.md +3 -3
  31. package/docs/API-reference/api/x-components.partialresultslist.md +3 -3
  32. package/docs/API-reference/api/x-components.promotedslist.md +3 -3
  33. package/docs/API-reference/api/x-components.querypreviewlist.md +3 -3
  34. package/docs/API-reference/api/x-components.recommendations.md +3 -3
  35. package/docs/API-reference/api/x-components.relatedpromptslist.md +3 -3
  36. package/docs/API-reference/api/x-components.relatedpromptsmutations.md +2 -0
  37. package/docs/API-reference/api/x-components.relatedpromptsmutations.setselectedprompt.md +24 -0
  38. package/docs/API-reference/api/x-components.relatedpromptsmutations.setselectedquery.md +24 -0
  39. package/docs/API-reference/api/x-components.relatedpromptsstate.md +2 -0
  40. package/docs/API-reference/api/x-components.relatedpromptsstate.selectedprompt.md +13 -0
  41. package/docs/API-reference/api/x-components.relatedpromptsstate.selectedquery.md +13 -0
  42. package/docs/API-reference/api/x-components.relatedtags.md +3 -3
  43. package/docs/API-reference/api/x-components.resultslist.md +3 -3
  44. package/docs/API-reference/api/x-components.scrolltotop.md +3 -3
  45. package/docs/API-reference/api/x-components.searchinputplaceholder.md +3 -3
  46. package/docs/API-reference/api/x-components.selectedfilterslist.md +3 -3
  47. package/docs/API-reference/api/x-components.singlecolumnlayout.md +3 -3
  48. package/docs/API-reference/components/common/result/x-components.base-result-image.md +2 -2
  49. package/docs/API-reference/components/common/x-components.items-list.md +1 -1
  50. package/docs/API-reference/components/facets/x-components.facets/facets.md +1 -1
  51. package/docs/API-reference/components/facets/x-components.lists/selected-filters-list.md +1 -1
  52. package/docs/API-reference/components/search/x-components.results-list.md +1 -1
  53. package/js/components/items-list.vue.js.map +1 -1
  54. package/js/components/items-list.vue2.js +2 -2
  55. package/js/components/items-list.vue2.js.map +1 -1
  56. package/js/components/result/base-result-image.vue.js.map +1 -1
  57. package/js/components/result/base-result-image.vue2.js +3 -3
  58. package/js/components/result/base-result-image.vue2.js.map +1 -1
  59. package/js/types/animation-prop.js +5 -0
  60. package/js/types/animation-prop.js.map +1 -1
  61. package/js/x-modules/facets/components/facets/facets.vue.js.map +1 -1
  62. package/js/x-modules/facets/components/facets/facets.vue2.js +2 -2
  63. package/js/x-modules/facets/components/facets/facets.vue2.js.map +1 -1
  64. package/js/x-modules/facets/components/lists/selected-filters-list.vue.js.map +1 -1
  65. package/js/x-modules/facets/components/lists/selected-filters-list.vue2.js +2 -2
  66. package/js/x-modules/facets/components/lists/selected-filters-list.vue2.js.map +1 -1
  67. package/js/x-modules/related-prompts/store/module.js +10 -0
  68. package/js/x-modules/related-prompts/store/module.js.map +1 -1
  69. package/js/x-modules/related-prompts/wiring.js +14 -0
  70. package/js/x-modules/related-prompts/wiring.js.map +1 -1
  71. package/js/x-modules/search/components/results-list.vue.js +2 -2
  72. package/js/x-modules/search/components/results-list.vue.js.map +1 -1
  73. package/package.json +2 -2
  74. package/report/x-components.api.json +1833 -7431
  75. package/report/x-components.api.md +151 -133
  76. package/types/components/base-dropdown.vue.d.ts +3 -3
  77. package/types/components/base-grid.vue.d.ts +3 -3
  78. package/types/components/base-variable-column-grid.vue.d.ts +3 -3
  79. package/types/components/items-list.vue.d.ts +3 -3
  80. package/types/components/layouts/multi-column-max-width-layout.vue.d.ts +3 -3
  81. package/types/components/layouts/single-column-layout.vue.d.ts +3 -3
  82. package/types/components/modals/base-events-modal.vue.d.ts +2 -2
  83. package/types/components/modals/base-id-modal.vue.d.ts +2 -2
  84. package/types/components/modals/base-modal.vue.d.ts +6 -6
  85. package/types/components/modals/main-modal.vue.d.ts +2 -2
  86. package/types/components/panels/base-header-toggle-panel.vue.d.ts +3 -3
  87. package/types/components/panels/base-id-toggle-panel.vue.d.ts +3 -3
  88. package/types/components/panels/base-tabs-panel.vue.d.ts +6 -6
  89. package/types/components/panels/base-toggle-panel.vue.d.ts +3 -3
  90. package/types/components/result/base-result-image.vue.d.ts +10 -10
  91. package/types/components/result/base-result-image.vue.d.ts.map +1 -1
  92. package/types/components/suggestions/base-suggestions.vue.d.ts +3 -3
  93. package/types/types/animation-prop.d.ts +6 -2
  94. package/types/types/animation-prop.d.ts.map +1 -1
  95. package/types/x-modules/empathize/components/empathize.vue.d.ts +3 -3
  96. package/types/x-modules/facets/components/facets/facets.vue.d.ts +3 -3
  97. package/types/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts +2 -2
  98. package/types/x-modules/facets/components/lists/filters-list.vue.d.ts +3 -3
  99. package/types/x-modules/facets/components/lists/selected-filters-list.vue.d.ts +3 -3
  100. package/types/x-modules/history-queries/components/my-history.vue.d.ts +3 -3
  101. package/types/x-modules/identifier-results/components/identifier-results.vue.d.ts +3 -3
  102. package/types/x-modules/next-queries/components/next-queries-list.vue.d.ts +3 -3
  103. package/types/x-modules/next-queries/index.d.ts +1 -0
  104. package/types/x-modules/next-queries/index.d.ts.map +1 -1
  105. package/types/x-modules/queries-preview/components/query-preview-list.vue.d.ts +3 -3
  106. package/types/x-modules/recommendations/components/recommendations.vue.d.ts +3 -3
  107. package/types/x-modules/related-prompts/components/related-prompts-list.vue.d.ts +3 -3
  108. package/types/x-modules/related-prompts/store/module.d.ts.map +1 -1
  109. package/types/x-modules/related-prompts/store/types.d.ts +16 -0
  110. package/types/x-modules/related-prompts/store/types.d.ts.map +1 -1
  111. package/types/x-modules/related-prompts/wiring.d.ts +6 -0
  112. package/types/x-modules/related-prompts/wiring.d.ts.map +1 -1
  113. package/types/x-modules/related-tags/components/related-tags.vue.d.ts +3 -3
  114. package/types/x-modules/scroll/components/scroll-to-top.vue.d.ts +3 -3
  115. package/types/x-modules/search/components/banners-list.vue.d.ts +3 -3
  116. package/types/x-modules/search/components/partial-results-list.vue.d.ts +3 -3
  117. package/types/x-modules/search/components/promoteds-list.vue.d.ts +3 -3
  118. package/types/x-modules/search/components/results-list.vue.d.ts +3 -3
  119. package/types/x-modules/search-box/components/search-input-placeholder.vue.d.ts +3 -3
  120. package/js/utils/options-api.js +0 -4
  121. package/js/utils/options-api.js.map +0 -1
  122. package/types/utils/options-api.d.ts +0 -3
  123. package/types/utils/options-api.d.ts.map +0 -1
@@ -16,18 +16,18 @@ Component for use as Layout to be filled with the rest of the Components.
16
16
  ```typescript
17
17
  _default: import("vue").DefineComponent<{
18
18
  asideAnimation: {
19
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
19
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
20
20
  default: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
21
21
  };
22
22
  devMode: BooleanConstructor;
23
23
  }, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
24
24
  asideAnimation: {
25
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
25
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
26
26
  default: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
27
27
  };
28
28
  devMode: BooleanConstructor;
29
29
  }>>, {
30
- asideAnimation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
30
+ asideAnimation: string | Function | Record<string, any>;
31
31
  devMode: boolean;
32
32
  }, {}>
33
33
  ```
@@ -11,7 +11,7 @@ The component renders the full history of user searched queries grouped by the d
11
11
  ```typescript
12
12
  _default: import("vue").DefineComponent<{
13
13
  animation: {
14
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
14
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
15
15
  default: string;
16
16
  };
17
17
  locale: {
@@ -26,7 +26,7 @@ _default: import("vue").DefineComponent<{
26
26
  formatTime: (timestamp: number) => string;
27
27
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
28
28
  animation: {
29
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
29
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
30
30
  default: string;
31
31
  };
32
32
  locale: {
@@ -35,7 +35,7 @@ _default: import("vue").DefineComponent<{
35
35
  };
36
36
  queriesListClass: StringConstructor;
37
37
  }>>, {
38
- animation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
38
+ animation: string | Function | Record<string, any>;
39
39
  locale: string;
40
40
  }, {}>
41
41
  ```
@@ -0,0 +1,22 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [NextQueriesGroup](./x-components.nextqueriesgroup.md)
4
+
5
+ ## NextQueriesGroup interface
6
+
7
+ Next queries group interface for the NextQueries.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface NextQueriesGroup extends ListItem
13
+ ```
14
+ **Extends:** [ListItem](./x-components.listitem.md)
15
+
16
+ ## Properties
17
+
18
+ | Property | Modifiers | Type | Description |
19
+ | --- | --- | --- | --- |
20
+ | [modelName](./x-components.nextqueriesgroup.modelname.md) | | 'NextQueriesGroup' | |
21
+ | [nextQueries](./x-components.nextqueriesgroup.nextqueries.md) | | NextQuery\[\] | |
22
+
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [NextQueriesGroup](./x-components.nextqueriesgroup.md) &gt; [modelName](./x-components.nextqueriesgroup.modelname.md)
4
+
5
+ ## NextQueriesGroup.modelName property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ modelName: 'NextQueriesGroup';
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [NextQueriesGroup](./x-components.nextqueriesgroup.md) &gt; [nextQueries](./x-components.nextqueriesgroup.nextqueries.md)
4
+
5
+ ## NextQueriesGroup.nextQueries property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ nextQueries: NextQuery[];
11
+ ```
@@ -11,7 +11,7 @@ Component that inserts groups of next queries in different positions of the inje
11
11
  ```typescript
12
12
  _default: import("vue").DefineComponent<{
13
13
  animation: {
14
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
14
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
15
15
  default: string;
16
16
  };
17
17
  offset: {
@@ -35,7 +35,7 @@ _default: import("vue").DefineComponent<{
35
35
  [key: string]: any;
36
36
  }>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
37
37
  animation: {
38
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
38
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
39
39
  default: string;
40
40
  };
41
41
  offset: {
@@ -56,7 +56,7 @@ _default: import("vue").DefineComponent<{
56
56
  default: boolean;
57
57
  };
58
58
  }>>, {
59
- animation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
59
+ animation: string | Function | Record<string, any>;
60
60
  offset: number;
61
61
  frequency: number;
62
62
  maxNextQueriesPerGroup: number;
@@ -11,7 +11,7 @@ It renders a list of partial results from [SearchState.partialResults](./x-compo
11
11
  ```typescript
12
12
  _default: import("vue").DefineComponent<{
13
13
  animation: {
14
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
14
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
15
15
  default: string;
16
16
  };
17
17
  maxItemsToRender: {
@@ -22,7 +22,7 @@ _default: import("vue").DefineComponent<{
22
22
  partialResults: ComputedRef<PartialResult[]>;
23
23
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
24
24
  animation: {
25
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
25
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
26
26
  default: string;
27
27
  };
28
28
  maxItemsToRender: {
@@ -30,7 +30,7 @@ _default: import("vue").DefineComponent<{
30
30
  default: number;
31
31
  };
32
32
  }>>, {
33
- animation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
33
+ animation: string | Function | Record<string, any>;
34
34
  maxItemsToRender: number;
35
35
  }, {}>
36
36
  ```
@@ -15,17 +15,17 @@ It also provides the parent slots to customize the items.
15
15
  ```typescript
16
16
  _default: import("vue").DefineComponent<{
17
17
  animation: {
18
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
18
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
19
19
  default: string;
20
20
  };
21
21
  }, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
22
22
  [key: string]: any;
23
23
  }>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
24
24
  animation: {
25
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
25
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
26
26
  default: string;
27
27
  };
28
28
  }>>, {
29
- animation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
29
+ animation: string | Function | Record<string, any>;
30
30
  }, {}>
31
31
  ```
@@ -26,7 +26,7 @@ _default: import("vue").DefineComponent<{
26
26
  };
27
27
  persistInCache: BooleanConstructor;
28
28
  animation: {
29
- type: PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
29
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
30
30
  default: string;
31
31
  };
32
32
  }, {
@@ -50,12 +50,12 @@ _default: import("vue").DefineComponent<{
50
50
  };
51
51
  persistInCache: BooleanConstructor;
52
52
  animation: {
53
- type: PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
53
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
54
54
  default: string;
55
55
  };
56
56
  }>>, {
57
57
  debounceTimeMs: number;
58
58
  persistInCache: boolean;
59
- animation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
59
+ animation: string | Function | Record<string, any>;
60
60
  }, {}>
61
61
  ```
@@ -11,7 +11,7 @@ It renders a list of recommendations from the [RecommendationsState.recommendati
11
11
  ```typescript
12
12
  _default: import("vue").DefineComponent<{
13
13
  animation: {
14
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
14
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
15
15
  default: string;
16
16
  };
17
17
  maxItemsToRender: NumberConstructor;
@@ -19,11 +19,11 @@ _default: import("vue").DefineComponent<{
19
19
  recommendations: ComputedRef<Result[]>;
20
20
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
21
21
  animation: {
22
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
22
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
23
23
  default: string;
24
24
  };
25
25
  maxItemsToRender: NumberConstructor;
26
26
  }>>, {
27
- animation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
27
+ animation: string | Function | Record<string, any>;
28
28
  }, {}>
29
29
  ```
@@ -11,7 +11,7 @@ Component that inserts groups of related prompts in different positions of the i
11
11
  ```typescript
12
12
  _default: import("vue").DefineComponent<{
13
13
  animation: {
14
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
14
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
15
15
  default: string;
16
16
  };
17
17
  offset: {
@@ -38,7 +38,7 @@ _default: import("vue").DefineComponent<{
38
38
  [key: string]: any;
39
39
  }>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
40
40
  animation: {
41
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
41
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
42
42
  default: string;
43
43
  };
44
44
  offset: {
@@ -62,7 +62,7 @@ _default: import("vue").DefineComponent<{
62
62
  default: boolean;
63
63
  };
64
64
  }>>, {
65
- animation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
65
+ animation: string | Function | Record<string, any>;
66
66
  offset: number;
67
67
  frequency: number;
68
68
  maxRelatedPromptsPerGroup: number;
@@ -20,4 +20,6 @@ export interface RelatedPromptsMutations extends StatusMutations, QueryMutations
20
20
  | [resetRelatedPromptsState()](./x-components.relatedpromptsmutations.resetrelatedpromptsstate.md) | Resets the related prompts state. |
21
21
  | [setParams(params)](./x-components.relatedpromptsmutations.setparams.md) | Sets the extra params of the module. |
22
22
  | [setRelatedPromptsProducts(products)](./x-components.relatedpromptsmutations.setrelatedpromptsproducts.md) | Sets the related prompts of the module. |
23
+ | [setSelectedPrompt(index)](./x-components.relatedpromptsmutations.setselectedprompt.md) | Sets the selected related prompt. |
24
+ | [setSelectedQuery(index)](./x-components.relatedpromptsmutations.setselectedquery.md) | Sets the selected next query. |
23
25
 
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md) &gt; [setSelectedPrompt](./x-components.relatedpromptsmutations.setselectedprompt.md)
4
+
5
+ ## RelatedPromptsMutations.setSelectedPrompt() method
6
+
7
+ Sets the selected related prompt.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setSelectedPrompt(index: number): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | index | number | The new selected related prompt. |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
@@ -0,0 +1,24 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsMutations](./x-components.relatedpromptsmutations.md) &gt; [setSelectedQuery](./x-components.relatedpromptsmutations.setselectedquery.md)
4
+
5
+ ## RelatedPromptsMutations.setSelectedQuery() method
6
+
7
+ Sets the selected next query.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ setSelectedQuery(index: number): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | index | number | The new selected next query. |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
@@ -19,4 +19,6 @@ export interface RelatedPromptsState extends StatusState, QueryState
19
19
  | --- | --- | --- | --- |
20
20
  | [params](./x-components.relatedpromptsstate.params.md) | | Dictionary&lt;unknown&gt; | The extra params property of the state. |
21
21
  | [relatedPrompts](./x-components.relatedpromptsstate.relatedprompts.md) | | RelatedPrompt\[\] | The list of the related-prompts, related to the <code>query</code> property of the state. |
22
+ | [selectedPrompt](./x-components.relatedpromptsstate.selectedprompt.md) | | number | The index of the selected related-prompt. |
23
+ | [selectedQuery](./x-components.relatedpromptsstate.selectedquery.md) | | number | The index of the selected next query. |
22
24
 
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsState](./x-components.relatedpromptsstate.md) &gt; [selectedPrompt](./x-components.relatedpromptsstate.selectedprompt.md)
4
+
5
+ ## RelatedPromptsState.selectedPrompt property
6
+
7
+ The index of the selected related-prompt.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ selectedPrompt: number;
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [RelatedPromptsState](./x-components.relatedpromptsstate.md) &gt; [selectedQuery](./x-components.relatedpromptsstate.selectedquery.md)
4
+
5
+ ## RelatedPromptsState.selectedQuery property
6
+
7
+ The index of the selected next query.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ selectedQuery: number;
13
+ ```
@@ -11,7 +11,7 @@ This component renders a set of \[`RelatedTag`<!-- -->\](./x-components.related-
11
11
  ```typescript
12
12
  _default: import("vue").DefineComponent<{
13
13
  animation: {
14
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
14
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
15
15
  default: string;
16
16
  };
17
17
  maxItemsToRender: NumberConstructor;
@@ -24,7 +24,7 @@ _default: import("vue").DefineComponent<{
24
24
  relatedTags: ComputedRef<RelatedTagModel[]>;
25
25
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
26
26
  animation: {
27
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
27
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
28
28
  default: string;
29
29
  };
30
30
  maxItemsToRender: NumberConstructor;
@@ -34,7 +34,7 @@ _default: import("vue").DefineComponent<{
34
34
  };
35
35
  itemClass: StringConstructor;
36
36
  }>>, {
37
- animation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
37
+ animation: string | Function | Record<string, any>;
38
38
  highlightCurated: boolean;
39
39
  }, {}>
40
40
  ```
@@ -15,19 +15,19 @@ It also provides the slot result to customize the item, which is within the defa
15
15
  ```typescript
16
16
  _default: import("vue").DefineComponent<{
17
17
  animation: {
18
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
18
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
19
19
  default: string;
20
20
  };
21
21
  }, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
22
22
  [key: string]: any;
23
23
  }>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "UserReachedResultsListEnd"[], "UserReachedResultsListEnd", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
24
24
  animation: {
25
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
25
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
26
26
  default: string;
27
27
  };
28
28
  }>> & {
29
29
  onUserReachedResultsListEnd?: ((...args: any[]) => any) | undefined;
30
30
  }, {
31
- animation: string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
31
+ animation: string | Function | Record<string, any>;
32
32
  }, {}>
33
33
  ```
@@ -11,7 +11,7 @@ The `ScrollToTop` component is a button that the user can click to make a contai
11
11
  ```typescript
12
12
  _default: import("vue").DefineComponent<{
13
13
  animation: {
14
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
14
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
15
15
  default: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
16
16
  };
17
17
  thresholdPx: NumberConstructor;
@@ -24,7 +24,7 @@ _default: import("vue").DefineComponent<{
24
24
  isVisible: import("vue").ComputedRef<any>;
25
25
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
26
26
  animation: {
27
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
27
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
28
28
  default: () => import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
29
29
  };
30
30
  thresholdPx: NumberConstructor;
@@ -33,7 +33,7 @@ _default: import("vue").DefineComponent<{
33
33
  default: string;
34
34
  };
35
35
  }>>, {
36
- animation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
36
+ animation: string | Function | Record<string, any>;
37
37
  scrollId: string;
38
38
  }, {}>
39
39
  ```
@@ -15,7 +15,7 @@ _default: import("vue").DefineComponent<{
15
15
  required: true;
16
16
  };
17
17
  animation: {
18
- type: PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
18
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
19
19
  default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
20
20
  };
21
21
  animationIntervalMs: {
@@ -32,7 +32,7 @@ _default: import("vue").DefineComponent<{
32
32
  required: true;
33
33
  };
34
34
  animation: {
35
- type: PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
35
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
36
36
  default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
37
37
  };
38
38
  animationIntervalMs: {
@@ -41,7 +41,7 @@ _default: import("vue").DefineComponent<{
41
41
  };
42
42
  animateOnlyOnHover: BooleanConstructor;
43
43
  }>>, {
44
- animation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
44
+ animation: string | Function | Record<string, any>;
45
45
  animationIntervalMs: number;
46
46
  animateOnlyOnHover: boolean;
47
47
  }, {}>
@@ -17,7 +17,7 @@ _default: import("vue").DefineComponent<{
17
17
  facetsIds: PropType<(string | number)[]>;
18
18
  alwaysVisible: BooleanConstructor;
19
19
  animation: {
20
- type: PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
20
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
21
21
  default: string;
22
22
  };
23
23
  }, {
@@ -28,11 +28,11 @@ _default: import("vue").DefineComponent<{
28
28
  facetsIds: PropType<(string | number)[]>;
29
29
  alwaysVisible: BooleanConstructor;
30
30
  animation: {
31
- type: PropType<string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
31
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
32
32
  default: string;
33
33
  };
34
34
  }>>, {
35
35
  alwaysVisible: boolean;
36
- animation: string | import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
36
+ animation: string | Function | Record<string, any>;
37
37
  }, {}>
38
38
  ```
@@ -16,18 +16,18 @@ Component for use as Layout to be filled with the rest of the Components.
16
16
  ```typescript
17
17
  _default: import("vue").DefineComponent<{
18
18
  asideAnimation: {
19
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
19
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
20
20
  default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
21
21
  };
22
22
  devMode: BooleanConstructor;
23
23
  }, unknown, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
24
24
  asideAnimation: {
25
- type: import("vue").PropType<string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>>;
25
+ type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
26
26
  default: () => import("vue").DefineComponent<{}, {}, {}, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
27
27
  };
28
28
  devMode: BooleanConstructor;
29
29
  }>>, {
30
- asideAnimation: string | import("vue").DefineComponent<{}, {}, any, import("vue").ComputedOptions, import("vue").MethodOptions, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
30
+ asideAnimation: string | Function | Record<string, any>;
31
31
  devMode: boolean;
32
32
  }, {}>
33
33
  ```
@@ -13,8 +13,8 @@ Component to be reused that renders an `<img>`.
13
13
  | Name | Description | Type | Default |
14
14
  | --------------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------ |
15
15
  | <code>result</code> | (Required) The @empathyco/x-types#Result information. | <code>Result</code> | <code></code> |
16
- | <code>loadAnimation</code> | Animation to use when switching between the placeholder, the loaded image, or the failed<br />image fallback. | <code>animationProp</code> | <code>() => NoAnimation</code> |
17
- | <code>hoverAnimation</code> | Animation to use when switching between the loaded image and the hover image. | <code>animationProp</code> | <code></code> |
16
+ | <code>loadAnimation</code> | Animation to use when switching between the placeholder, the loaded image, or the failed<br />image fallback. | <code>AnimationProp</code> | <code>() => NoAnimation</code> |
17
+ | <code>hoverAnimation</code> | Animation to use when switching between the loaded image and the hover image. | <code>AnimationProp</code> | <code></code> |
18
18
  | <code>showNextImageOnHover</code> | Indicates if the next valid image should be displayed on hover. | <code>boolean</code> | <code>false</code> |
19
19
 
20
20
  ## Slots
@@ -13,7 +13,7 @@ It renders a list of ListItem providing a slot for each `slotName` which depends
13
13
 
14
14
  | Name | Description | Type | Default |
15
15
  | ---------------------- | ---------------------------------------------------------- | -------------------------- | ----------------- |
16
- | <code>animation</code> | Animation component that will be used to animate the list. | <code>animationProp</code> | <code>'ul'</code> |
16
+ | <code>animation</code> | Animation component that will be used to animate the list. | <code>AnimationProp</code> | <code>'ul'</code> |
17
17
  | <code>items</code> | List of items. | <code>ListItem[]</code> | <code></code> |
18
18
  | <code>itemClass</code> | Item's classes. | <code>string</code> | <code></code> |
19
19
 
@@ -19,7 +19,7 @@ differently based on their purpose and this can be achieved using the exposed sl
19
19
  | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------------- |
20
20
  | <code>facetsIds</code> | Array of facets ids used to get the selected filters for those facets. | <code>Array<Facet['id']></code> | <code></code> |
21
21
  | <code>alwaysVisible</code> | Flag to render the component even if there are no filters selected. | <code>boolean</code> | <code></code> |
22
- | <code>animation</code> | Animation component that will be used to animate the facets. | <code>animationProp</code> | <code>'ul'</code> |
22
+ | <code>animation</code> | Animation component that will be used to animate the facets. | <code>AnimationProp</code> | <code>'ul'</code> |
23
23
  | <code>renderableFacets</code> | Discriminates the facets rendered by this component. It expects a string containing facets<br />ids, comma separated. This property will include or exclude facets based on its value.<br />The default value is an empty string and the component will render all existing facets. | <code>string</code> | <code></code> |
24
24
 
25
25
  ## Slots
@@ -20,7 +20,7 @@ The property "alwaysVisible" handles if the component is rendered if no filters
20
20
  | -------------------------- | --------------------------------------------------------------------------- | ------------------------------- | ----------------- |
21
21
  | <code>facetsIds</code> | Array of facets ids used to get the selected filters for those facets. | <code>Array<Facet['id']></code> | <code></code> |
22
22
  | <code>alwaysVisible</code> | Flag to render the component even if there are no filters selected. | <code>boolean</code> | <code></code> |
23
- | <code>animation</code> | Animation component that will be used to animate the selected filters list. | <code>animationProp</code> | <code>'ul'</code> |
23
+ | <code>animation</code> | Animation component that will be used to animate the selected filters list. | <code>AnimationProp</code> | <code>'ul'</code> |
24
24
 
25
25
  ## Slots
26
26
 
@@ -17,7 +17,7 @@ result bound.
17
17
 
18
18
  | Name | Description | Type | Default |
19
19
  | ---------------------- | ------------------------------------------------------------- | -------------------------- | ----------------- |
20
- | <code>animation</code> | Animation component that will be used to animate the results. | <code>animationProp</code> | <code>'ul'</code> |
20
+ | <code>animation</code> | Animation component that will be used to animate the results. | <code>AnimationProp</code> | <code>'ul'</code> |
21
21
 
22
22
  ## Events
23
23
 
@@ -1 +1 @@
1
- {"version":3,"file":"items-list.vue.js","sources":["../../../src/components/items-list.vue"],"sourcesContent":["<template>\n <component\n :is=\"animation\"\n v-if=\"items.length\"\n tag=\"ul\"\n class=\"x-items-list\"\n data-test=\"items-list\"\n >\n <li\n v-for=\"item in computedItems\"\n :key=\"item.id\"\n class=\"x-items-list__item\"\n :class=\"item.class\"\n :data-test=\"item.dataTest\"\n >\n <!--\n @slot Custom item to render.\n @binding {ListItem} item - Item data.\n -->\n <slot :item=\"item\" :name=\"item.slotName\">{{ item.id }}</slot>\n </li>\n </component>\n</template>\n\n<script lang=\"ts\">\n import { computed, defineComponent, PropType } from 'vue';\n import { ListItem } from '../utils/types';\n import { toKebabCase } from '../utils/string';\n import { animationProp } from '../utils/options-api';\n\n /**\n * It renders a list of {@link ListItem} providing a slot for each `slotName` which depends on\n * the `modelName`of the item.\n *\n * @public\n */\n export default defineComponent({\n name: 'ItemsList',\n props: {\n /** Animation component that will be used to animate the list. */\n animation: {\n type: animationProp,\n default: 'ul'\n },\n /** List of items. */\n items: {\n type: Array as PropType<ListItem[]>,\n required: true\n },\n /** Item's classes. */\n itemClass: String\n },\n setup(props) {\n /**\n * The list of the items with additional properties.\n *\n * @returns A list of items with `dataTest`, `class` and the `slotName` for each item.\n */\n const computedItems = computed(() =>\n props.items.map(item => {\n const modelName = toKebabCase(item.modelName);\n return {\n ...item,\n dataTest: `${modelName}s-list-item`,\n class: [`x-${modelName}s-list-item`, props.itemClass],\n slotName: modelName\n };\n })\n );\n\n return { computedItems };\n }\n });\n</script>\n"],"names":["animation","_openBlock","_createBlock","_resolveDynamicComponent","_createElementBlock","_Fragment","_renderList","_normalizeClass","_createCommentVNode","_renderSlot","_toDisplayString"],"mappings":";;;;;AACE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EADF,MAESA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,QAAAA,EAAAA;SAFT,IAIY,CAAA,KAAA,CAAA,MAAA,IAAAC,SAAA,EAAA,EAAAC,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,IACR,GAAK,EAAA,CAAA;AAAA,IACL,GAAA,EAAA,IAAA;AAAA,IAAA,KAAA,EAAA,cAAA;AANJ,IAAA,WAAA,EAAA,YAAA;AAAA,GAAA,EAAA;;iBAUY,IAAO,CAAA,EAAAC,kBAAA;AAAA,QAAAC,QAAA;AAAA,QAAA,IAAA;AAAA,QAAAC,UAAA,CAAA,IAAA,CAAA,aAAA,EAAA,CAAA,IAAA,KAAA;AACR,UAAA,OAAAL,SAAA,uBAAC,IACE,EAAA;AAAA,YACP,GAAA,EAAA,IAAA,CAAA,EAAA;AAAA,YAAA,KAAA,EAAAM,cAAA,CAAA,CAAA,oBAAA,EAAA,IAAA,CAAA,KAAA,CAAA,CAAA;AAED,YAAA,WAAA,EAAA,IAAA,CAAA,QAAA;AAAA,WAIA,EAAA;AAAA,YAAAC,kBAAA,CAnBN,iGAmByD,CAAA;AAAA,YAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,IAAA,CAAA,QAAA,EAAA,EAAA,IAAA,EAAA,EAAA,MAAA;;AAnBzD,gBAAAC,eAAA,CAAA,IAAA,CAAA,EAAA,CAAA;AAAA,gBAAA,CAAA;AAAA;AAAA,eAAA;AAAA,aAAA,CAAA;;AAAA,SAAA,CAAA;AAAA,QAAA,GAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;AAAA,IAAA,CAAA,EAAA,CAAA;AAAA;AAAA,GAAA,CAAA,IAAAF,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA,CAAA;;;;;;"}
1
+ {"version":3,"file":"items-list.vue.js","sources":["../../../src/components/items-list.vue"],"sourcesContent":["<template>\n <component\n :is=\"animation\"\n v-if=\"items.length\"\n tag=\"ul\"\n class=\"x-items-list\"\n data-test=\"items-list\"\n >\n <li\n v-for=\"item in computedItems\"\n :key=\"item.id\"\n class=\"x-items-list__item\"\n :class=\"item.class\"\n :data-test=\"item.dataTest\"\n >\n <!--\n @slot Custom item to render.\n @binding {ListItem} item - Item data.\n -->\n <slot :item=\"item\" :name=\"item.slotName\">{{ item.id }}</slot>\n </li>\n </component>\n</template>\n\n<script lang=\"ts\">\n import { computed, defineComponent, PropType } from 'vue';\n import { ListItem } from '../utils/types';\n import { toKebabCase } from '../utils/string';\n import { AnimationProp } from '../types';\n\n /**\n * It renders a list of {@link ListItem} providing a slot for each `slotName` which depends on\n * the `modelName`of the item.\n *\n * @public\n */\n export default defineComponent({\n name: 'ItemsList',\n props: {\n /** Animation component that will be used to animate the list. */\n animation: {\n type: AnimationProp,\n default: 'ul'\n },\n /** List of items. */\n items: {\n type: Array as PropType<ListItem[]>,\n required: true\n },\n /** Item's classes. */\n itemClass: String\n },\n setup(props) {\n /**\n * The list of the items with additional properties.\n *\n * @returns A list of items with `dataTest`, `class` and the `slotName` for each item.\n */\n const computedItems = computed(() =>\n props.items.map(item => {\n const modelName = toKebabCase(item.modelName);\n return {\n ...item,\n dataTest: `${modelName}s-list-item`,\n class: [`x-${modelName}s-list-item`, props.itemClass],\n slotName: modelName\n };\n })\n );\n\n return { computedItems };\n }\n });\n</script>\n"],"names":["animation","_openBlock","_createBlock","_resolveDynamicComponent","_createElementBlock","_Fragment","_renderList","_normalizeClass","_createCommentVNode","_renderSlot","_toDisplayString"],"mappings":";;;;;AACE,SAAA,WAAA,CAAA,IAAA,EAAA,MAAA,EADF,MAESA,EAAAA,MAAAA,EAAAA,KAAAA,EAAAA,QAAAA,EAAAA;SAFT,IAIY,CAAA,KAAA,CAAA,MAAA,IAAAC,SAAA,EAAA,EAAAC,WAAA,CAAAC,uBAAA,CAAA,IAAA,CAAA,SAAA,CAAA,EAAA;AAAA,IACR,GAAK,EAAA,CAAA;AAAA,IACL,GAAA,EAAA,IAAA;AAAA,IAAA,KAAA,EAAA,cAAA;AANJ,IAAA,WAAA,EAAA,YAAA;AAAA,GAAA,EAAA;;iBAUY,IAAO,CAAA,EAAAC,kBAAA;AAAA,QAAAC,QAAA;AAAA,QAAA,IAAA;AAAA,QAAAC,UAAA,CAAA,IAAA,CAAA,aAAA,EAAA,CAAA,IAAA,KAAA;AACR,UAAA,OAAAL,SAAA,uBAAC,IACE,EAAA;AAAA,YACP,GAAA,EAAA,IAAA,CAAA,EAAA;AAAA,YAAA,KAAA,EAAAM,cAAA,CAAA,CAAA,oBAAA,EAAA,IAAA,CAAA,KAAA,CAAA,CAAA;AAED,YAAA,WAAA,EAAA,IAAA,CAAA,QAAA;AAAA,WAIA,EAAA;AAAA,YAAAC,kBAAA,CAnBN,iGAmByD,CAAA;AAAA,YAAAC,UAAA,CAAA,IAAA,CAAA,MAAA,EAAA,IAAA,CAAA,QAAA,EAAA,EAAA,IAAA,EAAA,EAAA,MAAA;;AAnBzD,gBAAAC,eAAA,CAAA,IAAA,CAAA,EAAA,CAAA;AAAA,gBAAA,CAAA;AAAA;AAAA,eAAA;AAAA,aAAA,CAAA;;AAAA,SAAA,CAAA;AAAA,QAAA,GAAA;AAAA;AAAA,OAAA;AAAA,KAAA,CAAA;AAAA,IAAA,CAAA,EAAA,CAAA;AAAA;AAAA,GAAA,CAAA,IAAAF,kBAAA,CAAA,MAAA,EAAA,IAAA,CAAA,CAAA;;;;;;"}