@empathyco/x-components 3.0.0-alpha.366 → 3.0.0-alpha.368

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 (37) hide show
  1. package/CHANGELOG.md +48 -0
  2. package/design-system/deprecated-full-theme.css +18 -18
  3. package/docs/API-reference/api/x-components.basecurrency.md +20 -11
  4. package/docs/API-reference/api/x-components.basesuggestion.md +48 -23
  5. package/docs/API-reference/api/x-components.md +2 -2
  6. package/js/components/currency/base-currency.vue.js.map +1 -1
  7. package/js/components/currency/base-currency.vue_rollup-plugin-vue_script.vue.js +51 -38
  8. package/js/components/currency/base-currency.vue_rollup-plugin-vue_script.vue.js.map +1 -1
  9. package/js/components/result/base-result-image.vue.js +1 -1
  10. package/js/components/result/base-result-image.vue.js.map +1 -1
  11. package/js/components/result/base-result-image.vue_rollup-plugin-vue_script.vue.js +6 -1
  12. package/js/components/result/base-result-image.vue_rollup-plugin-vue_script.vue.js.map +1 -1
  13. package/js/components/result/base-result-image.vue_rollup-plugin-vue_styles.0.vue.js +1 -1
  14. package/js/components/suggestions/base-suggestion.vue.js +6 -2
  15. package/js/components/suggestions/base-suggestion.vue.js.map +1 -1
  16. package/js/components/suggestions/base-suggestion.vue_rollup-plugin-vue_script.vue.js +124 -94
  17. package/js/components/suggestions/base-suggestion.vue_rollup-plugin-vue_script.vue.js.map +1 -1
  18. package/package.json +13 -13
  19. package/report/x-components.api.json +345 -409
  20. package/report/x-components.api.md +67 -23
  21. package/types/components/currency/base-currency.vue.d.ts +26 -20
  22. package/types/components/currency/base-currency.vue.d.ts.map +1 -1
  23. package/types/components/result/base-result-image.vue.d.ts.map +1 -1
  24. package/types/components/suggestions/base-suggestion.vue.d.ts +55 -36
  25. package/types/components/suggestions/base-suggestion.vue.d.ts.map +1 -1
  26. package/docs/API-reference/api/x-components.basecurrency.format.md +0 -13
  27. package/docs/API-reference/api/x-components.basecurrency.injectedformat.md +0 -13
  28. package/docs/API-reference/api/x-components.basecurrency.value.md +0 -18
  29. package/docs/API-reference/api/x-components.basesuggestion.dynamiccssclasses.md +0 -18
  30. package/docs/API-reference/api/x-components.basesuggestion.emitevents.md +0 -17
  31. package/docs/API-reference/api/x-components.basesuggestion.events.md +0 -18
  32. package/docs/API-reference/api/x-components.basesuggestion.feature.md +0 -13
  33. package/docs/API-reference/api/x-components.basesuggestion.filter.md +0 -13
  34. package/docs/API-reference/api/x-components.basesuggestion.highlightcurated.md +0 -13
  35. package/docs/API-reference/api/x-components.basesuggestion.query.md +0 -13
  36. package/docs/API-reference/api/x-components.basesuggestion.suggestion.md +0 -13
  37. package/docs/API-reference/api/x-components.basesuggestion.suggestionselectedevents.md +0 -13
@@ -278,15 +278,25 @@ export class BaseColumnPickerList extends BaseColumnPickerList_base {
278
278
  }
279
279
 
280
280
  // @public
281
- export class BaseCurrency extends Vue_2 {
282
- // @internal
283
- protected get currency(): string;
284
- protected format?: string;
285
- injectedFormat: string;
286
- // @internal
287
- protected get renderedFormat(): string;
288
- protected value: number;
289
- }
281
+ export const BaseCurrency: DefineComponent< {
282
+ value: {
283
+ type: NumberConstructor;
284
+ required: true;
285
+ };
286
+ format: {
287
+ type: StringConstructor;
288
+ };
289
+ }, {
290
+ currency: ComputedRef<string>;
291
+ }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes< {
292
+ value: {
293
+ type: NumberConstructor;
294
+ required: true;
295
+ };
296
+ format: {
297
+ type: StringConstructor;
298
+ };
299
+ }>>, {}>;
290
300
 
291
301
  // @public
292
302
  export class BaseDropdown extends Vue_2 {
@@ -795,20 +805,53 @@ export class BaseScroll extends BaseScroll_base {
795
805
  }
796
806
 
797
807
  // @public
798
- export class BaseSuggestion extends Vue_2 {
799
- protected get dynamicCSSClasses(): VueCSSClasses;
800
- protected emitEvents(): void;
801
- protected get events(): Partial<XEventsTypes>;
802
- protected feature?: QueryFeature;
803
- protected get filter(): BooleanFilter | undefined;
804
- protected highlightCurated: boolean;
805
- protected query: string;
806
- // @internal
807
- protected get shouldHighlightCurated(): boolean;
808
- // Warning: (ae-forgotten-export) The symbol "Suggestion" needs to be exported by the entry point index.d.ts
809
- protected suggestion: Suggestion;
810
- protected suggestionSelectedEvents: Partial<XEventsTypes>;
811
- }
808
+ export const BaseSuggestion: DefineComponent< {
809
+ query: {
810
+ type: StringConstructor;
811
+ default: string;
812
+ };
813
+ suggestion: {
814
+ type: PropType<Suggestion>;
815
+ required: true;
816
+ };
817
+ feature: {
818
+ type: PropType<QueryFeature>;
819
+ };
820
+ suggestionSelectedEvents: {
821
+ type: PropType<Partial<XEventsTypes>>;
822
+ required: true;
823
+ };
824
+ highlightCurated: {
825
+ type: BooleanConstructor;
826
+ };
827
+ }, {
828
+ el: Ref<HTMLElement | null>;
829
+ filter: ComputedRef<BooleanFilter | undefined>;
830
+ emitEvents: () => void;
831
+ dynamicCSSClasses: ComputedRef<VueCSSClasses>;
832
+ }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, Readonly<ExtractPropTypes< {
833
+ query: {
834
+ type: StringConstructor;
835
+ default: string;
836
+ };
837
+ suggestion: {
838
+ type: PropType<Suggestion>;
839
+ required: true;
840
+ };
841
+ feature: {
842
+ type: PropType<QueryFeature>;
843
+ };
844
+ suggestionSelectedEvents: {
845
+ type: PropType<Partial<XEventsTypes>>;
846
+ required: true;
847
+ };
848
+ highlightCurated: {
849
+ type: BooleanConstructor;
850
+ };
851
+ }>>, {
852
+ query: string;
853
+ highlightCurated: boolean;
854
+ }>;
812
855
 
813
856
  // Warning: (ae-forgotten-export) The symbol "BaseSuggestions_base" needs to be exported by the entry point index.d.ts
814
857
  //
@@ -6093,6 +6136,7 @@ export type XStoreModuleOptions<StoreModule extends AnyXStoreModule> = StoreModu
6093
6136
  // dist/types/components/filters/labels/base-price-filter-label.vue.d.ts:13:13 - (ae-forgotten-export) The symbol "RangeValue" needs to be exported by the entry point index.d.ts
6094
6137
  // dist/types/components/filters/labels/base-rating-filter-label.vue.d.ts:16:9 - (ae-forgotten-export) The symbol "BooleanFilter" needs to be exported by the entry point index.d.ts
6095
6138
  // dist/types/components/result/base-result-add-to-cart.vue.d.ts:17:9 - (ae-forgotten-export) The symbol "Result" needs to be exported by the entry point index.d.ts
6139
+ // dist/types/components/suggestions/base-suggestion.vue.d.ts:31:9 - (ae-forgotten-export) The symbol "Suggestion" needs to be exported by the entry point index.d.ts
6096
6140
  // src/x-modules/search/store/emitters.ts:13:40 - (ae-forgotten-export) The symbol "TaggingRequest" needs to be exported by the entry point index.d.ts
6097
6141
  // src/x-modules/url/store/emitters.ts:57:1 - (ae-forgotten-export) The symbol "shouldPushUrl" needs to be exported by the entry point index.d.ts
6098
6142
  // src/x-modules/url/store/emitters.ts:64:1 - (ae-forgotten-export) The symbol "shouldReplaceUrl" needs to be exported by the entry point index.d.ts
@@ -1,4 +1,3 @@
1
- import Vue from 'vue';
2
1
  /**
3
2
  * Renders the value received as a property which always must be a JavaScript number, with the
4
3
  * proper format provided as a string property or by injection. The rendered tag is a span in
@@ -37,7 +36,7 @@ import Vue from 'vue';
37
36
  *
38
37
  * @public
39
38
  */
40
- export default class BaseCurrency extends Vue {
39
+ declare const _default: import("vue").DefineComponent<{
41
40
  /**
42
41
  * Numeric value to be formatted.
43
42
  *
@@ -46,34 +45,41 @@ export default class BaseCurrency extends Vue {
46
45
  *
47
46
  * @public
48
47
  */
49
- protected value: number;
48
+ value: {
49
+ type: NumberConstructor;
50
+ required: true;
51
+ };
50
52
  /**
51
53
  * The format as string.
52
54
  *
53
55
  * @public
54
56
  */
55
- protected format?: string;
57
+ format: {
58
+ type: StringConstructor;
59
+ };
60
+ }, {
61
+ currency: import("vue").ComputedRef<string>;
62
+ }, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
56
63
  /**
57
- * The injected format as string.
58
- *
59
- * @public
60
- */
61
- injectedFormat: string;
62
- /**
63
- * A format which can be passed through prop or injected.
64
+ * Numeric value to be formatted.
64
65
  *
65
- * @returns A format as string.
66
+ * @remarks Pass the value with 'v-bind:value' (or ':value' shortcut) instead of plain string.
67
+ * @remarks Be careful using numbers under Number.MAX_SAFE_INTEGER to avoid unexpected errors.
66
68
  *
67
- * @internal
69
+ * @public
68
70
  */
69
- protected get renderedFormat(): string;
71
+ value: {
72
+ type: NumberConstructor;
73
+ required: true;
74
+ };
70
75
  /**
71
- * Returns the formatted result as string.
72
- *
73
- * @returns Formatted number.
76
+ * The format as string.
74
77
  *
75
- * @internal
78
+ * @public
76
79
  */
77
- protected get currency(): string;
78
- }
80
+ format: {
81
+ type: StringConstructor;
82
+ };
83
+ }>>, {}>;
84
+ export default _default;
79
85
  //# sourceMappingURL=base-currency.vue?rollup-plugin-vue=script.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"base-currency.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../src/components/currency/base-currency.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAKE,OAAO,GAAG,MAAM,KAAK,CAAC;AAKtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,GAAG;IAC3C;;;;;;;OAOG;IAEH,SAAS,CAAC,KAAK,EAAG,MAAM,CAAC;IAEzB;;;;OAIG;IAEH,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IAEI,cAAc,EAAG,MAAM,CAAC;IAE/B;;;;;;OAMG;IACH,SAAS,KAAK,cAAc,IAAI,MAAM,CAErC;IAED;;;;;;OAMG;IACH,SAAS,KAAK,QAAQ,IAAI,MAAM,CAE/B;CACF"}
1
+ {"version":3,"file":"base-currency.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../src/components/currency/base-currency.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAQE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;;IAGC;;;;;;;OAOG;;;;;IAMH;;;;OAIG;;;;;;;IAjBH;;;;;;;OAOG;;;;;IAMH;;;;OAIG;;;;;AAnBP,wBAuDG"}
@@ -1 +1 @@
1
- {"version":3,"file":"base-result-image.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../src/components/result/base-result-image.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AA0CE,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAEL,eAAe,EAEf,QAAQ,EACR,GAAG,EAIJ,MAAM,KAAK,CAAC;AAIb;;;;GAIG;;IAMC;;;;OAIG;;;;;IAMH;;;;;OAKG;;;;;IAMH;;;;OAIG;;;;IAKH;;;;OAIG;;;;;;;;;;;;;;6BAmH2B,IAAI;2BASN,IAAI;;IA9JhC;;;;OAIG;;;;;IAMH;;;;;OAKG;;;;;IAMH;;;;OAIG;;;;IAKH;;;;OAIG;;;;;;;;;;;AAvCP,wBAuLG"}
1
+ {"version":3,"file":"base-result-image.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../src/components/result/base-result-image.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AA0CE,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAEL,eAAe,EAEf,QAAQ,EACR,GAAG,EAIJ,MAAM,KAAK,CAAC;AAIb;;;;GAIG;;IAMC;;;;OAIG;;;;;IAMH;;;;;OAKG;;;;;IAMH;;;;OAIG;;;;IAKH;;;;OAIG;;;;;;;;;;;;;;6BAwH2B,IAAI;2BASN,IAAI;;IAnKhC;;;;OAIG;;;;;IAMH;;;;;OAKG;;;;;IAMH;;;;OAIG;;;;IAKH;;;;OAIG;;;;;;;;;;;AAvCP,wBA4LG"}
@@ -1,5 +1,5 @@
1
1
  import { BooleanFilter, Suggestion } from '@empathyco/x-types';
2
- import Vue from 'vue';
2
+ import { PropType } from 'vue';
3
3
  import { QueryFeature } from '../../types';
4
4
  import { VueCSSClasses } from '../../utils/types';
5
5
  import { XEventsTypes } from '../../wiring/events.types';
@@ -12,83 +12,102 @@ import { XEventsTypes } from '../../wiring/events.types';
12
12
  *
13
13
  * @public
14
14
  */
15
- export default class BaseSuggestion extends Vue {
15
+ declare const _default: import("vue").DefineComponent<{
16
16
  /**
17
17
  * The normalized query of the module using this component.
18
18
  *
19
19
  * @public
20
20
  */
21
- protected query: string;
21
+ query: {
22
+ type: StringConstructor;
23
+ default: string;
24
+ };
22
25
  /**
23
26
  * The suggestion to render and use in the default slot.
24
27
  *
25
28
  * @public
26
29
  */
27
- protected suggestion: Suggestion;
30
+ suggestion: {
31
+ type: PropType<Suggestion>;
32
+ required: true;
33
+ };
28
34
  /**
29
35
  * The feature from which the events will be emitted.
30
36
  *
31
37
  * @public
32
38
  */
33
- protected feature?: QueryFeature;
39
+ feature: {
40
+ type: PropType<QueryFeature>;
41
+ };
34
42
  /**
35
43
  * The {@link XEvent | XEvents} that will be emitted when selecting a suggestion.
36
44
  *
37
45
  * @public
38
46
  */
39
- protected suggestionSelectedEvents: Partial<XEventsTypes>;
47
+ suggestionSelectedEvents: {
48
+ type: PropType<Partial<XEventsTypes>>;
49
+ required: true;
50
+ };
40
51
  /**
41
52
  * Indicates if the curated suggestion should be highlighted.
42
53
  *
43
54
  * @public
44
55
  */
45
- protected highlightCurated: boolean;
56
+ highlightCurated: {
57
+ type: BooleanConstructor;
58
+ };
59
+ }, {
60
+ el: import("vue").Ref<HTMLElement | null>;
61
+ filter: import("vue").ComputedRef<BooleanFilter | undefined>;
62
+ emitEvents: () => void;
63
+ dynamicCSSClasses: import("vue").ComputedRef<VueCSSClasses>;
64
+ }, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
46
65
  /**
47
- * The event handler that will be triggered when clicking on a suggestion.
48
- *
49
- * @remarks
50
- * UserAcceptedAQuery: suggestion.query
51
- * UserSelectedASuggestion: suggestion
52
- * UserClickedAFilter: suggestion.facets[0].filters[0]
53
- * Merges the events defined in the suggestionSelectedEvents prop and also emits them
66
+ * The normalized query of the module using this component.
54
67
  *
55
- * @returns The {@link XEvent | XEvents} to emit.
56
68
  * @public
57
69
  */
58
- protected get events(): Partial<XEventsTypes>;
70
+ query: {
71
+ type: StringConstructor;
72
+ default: string;
73
+ };
59
74
  /**
60
- * Emits the events when the button is clicked.
75
+ * The suggestion to render and use in the default slot.
61
76
  *
62
77
  * @public
63
78
  */
64
- protected emitEvents(): void;
79
+ suggestion: {
80
+ type: PropType<Suggestion>;
81
+ required: true;
82
+ };
65
83
  /**
66
- * Returns the suggestion filter object.
67
- * It is a BooleanFilter because the label is needed.
68
- * It returns only the first element because the facets and filters are being planned
69
- * in the BaseSuggestions component.
84
+ * The feature from which the events will be emitted.
70
85
  *
71
- * @returns The filter.
72
86
  * @public
73
87
  */
74
- protected get filter(): BooleanFilter | undefined;
88
+ feature: {
89
+ type: PropType<QueryFeature>;
90
+ };
75
91
  /**
76
- * Checks if the suggestion is curated and if it should be highlighted.
77
- *
78
- * @returns True if the suggestion is curated and should be highlighted.
92
+ * The {@link XEvent | XEvents} that will be emitted when selecting a suggestion.
79
93
  *
80
- * @internal
94
+ * @public
81
95
  */
82
- protected get shouldHighlightCurated(): boolean;
96
+ suggestionSelectedEvents: {
97
+ type: PropType<Partial<XEventsTypes>>;
98
+ required: true;
99
+ };
83
100
  /**
84
- * Generates css classes dynamically.
85
- *
86
- * @remarks
87
- * 'x-suggestion--matching added when the query should be matched.
101
+ * Indicates if the curated suggestion should be highlighted.
88
102
  *
89
- * @returns The {@link VueCSSClasses} classes.
90
103
  * @public
91
104
  */
92
- protected get dynamicCSSClasses(): VueCSSClasses;
93
- }
105
+ highlightCurated: {
106
+ type: BooleanConstructor;
107
+ };
108
+ }>>, {
109
+ query: string;
110
+ highlightCurated: boolean;
111
+ }>;
112
+ export default _default;
94
113
  //# sourceMappingURL=base-suggestion.vue?rollup-plugin-vue=script.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"base-suggestion.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../src/components/suggestions/base-suggestion.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAgBE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE/D,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAGzD;;;;;;;;GAQG;AAIH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,GAAG;IAC7C;;;;OAIG;IAEH,SAAS,CAAC,KAAK,EAAG,MAAM,CAAC;IAEzB;;;;OAIG;IAEH,SAAS,CAAC,UAAU,EAAG,UAAU,CAAC;IAElC;;;;OAIG;IAEH,SAAS,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC;IAEjC;;;;OAIG;IAEH,SAAS,CAAC,wBAAwB,EAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAE3D;;;;OAIG;IAEH,SAAS,CAAC,gBAAgB,EAAG,OAAO,CAAC;IAErC;;;;;;;;;;;OAWG;IACH,SAAS,KAAK,MAAM,IAAI,OAAO,CAAC,YAAY,CAAC,CAU5C;IAED;;;;OAIG;IACH,SAAS,CAAC,UAAU,IAAI,IAAI;IAS5B;;;;;;;;OAQG;IACH,SAAS,KAAK,MAAM,IAAI,aAAa,GAAG,SAAS,CAEhD;IAED;;;;;;OAMG;IACH,SAAS,KAAK,sBAAsB,IAAI,OAAO,CAE9C;IAED;;;;;;;;OAQG;IACH,SAAS,KAAK,iBAAiB,IAAI,aAAa,CAI/C;CACF"}
1
+ {"version":3,"file":"base-suggestion.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../src/components/suggestions/base-suggestion.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAgBE,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAE/D,OAAO,EAA6B,QAAQ,EAAO,MAAM,KAAK,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAIzD;;;;;;;;GAQG;;IAIC;;;;OAIG;;;;;IAMH;;;;OAIG;;;;;IAMH;;;;OAIG;;;;IAMH;;;;OAIG;;;;;IAMH;;;;OAIG;;;;;;;sBAqDoB,IAAI;;;IAjG3B;;;;OAIG;;;;;IAMH;;;;OAIG;;;;;IAMH;;;;OAIG;;;;IAMH;;;;OAIG;;;;;IAMH;;;;OAIG;;;;;;;;AA/CP,wBA4IG"}
@@ -1,13 +0,0 @@
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; [BaseCurrency](./x-components.basecurrency.md) &gt; [format](./x-components.basecurrency.format.md)
4
-
5
- ## BaseCurrency.format property
6
-
7
- The format as string.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- protected format?: string;
13
- ```
@@ -1,13 +0,0 @@
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; [BaseCurrency](./x-components.basecurrency.md) &gt; [injectedFormat](./x-components.basecurrency.injectedformat.md)
4
-
5
- ## BaseCurrency.injectedFormat property
6
-
7
- The injected format as string.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- injectedFormat: string;
13
- ```
@@ -1,18 +0,0 @@
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; [BaseCurrency](./x-components.basecurrency.md) &gt; [value](./x-components.basecurrency.value.md)
4
-
5
- ## BaseCurrency.value property
6
-
7
- Numeric value to be formatted.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- protected value: number;
13
- ```
14
-
15
- ## Remarks
16
-
17
- Be careful using numbers under Number.MAX\_SAFE\_INTEGER to avoid unexpected errors.
18
-
@@ -1,18 +0,0 @@
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; [BaseSuggestion](./x-components.basesuggestion.md) &gt; [dynamicCSSClasses](./x-components.basesuggestion.dynamiccssclasses.md)
4
-
5
- ## BaseSuggestion.dynamicCSSClasses property
6
-
7
- Generates css classes dynamically.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- protected get dynamicCSSClasses(): VueCSSClasses;
13
- ```
14
-
15
- ## Remarks
16
-
17
- 'x-suggestion--matching added when the query should be matched.
18
-
@@ -1,17 +0,0 @@
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; [BaseSuggestion](./x-components.basesuggestion.md) &gt; [emitEvents](./x-components.basesuggestion.emitevents.md)
4
-
5
- ## BaseSuggestion.emitEvents() method
6
-
7
- Emits the events when the button is clicked.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- protected emitEvents(): void;
13
- ```
14
- **Returns:**
15
-
16
- void
17
-
@@ -1,18 +0,0 @@
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; [BaseSuggestion](./x-components.basesuggestion.md) &gt; [events](./x-components.basesuggestion.events.md)
4
-
5
- ## BaseSuggestion.events property
6
-
7
- The event handler that will be triggered when clicking on a suggestion.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- protected get events(): Partial<XEventsTypes>;
13
- ```
14
-
15
- ## Remarks
16
-
17
- UserAcceptedAQuery: suggestion.query UserSelectedASuggestion: suggestion UserClickedAFilter: suggestion.facets\[0\].filters\[0\] Merges the events defined in the suggestionSelectedEvents prop and also emits them
18
-
@@ -1,13 +0,0 @@
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; [BaseSuggestion](./x-components.basesuggestion.md) &gt; [feature](./x-components.basesuggestion.feature.md)
4
-
5
- ## BaseSuggestion.feature property
6
-
7
- The feature from which the events will be emitted.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- protected feature?: QueryFeature;
13
- ```
@@ -1,13 +0,0 @@
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; [BaseSuggestion](./x-components.basesuggestion.md) &gt; [filter](./x-components.basesuggestion.filter.md)
4
-
5
- ## BaseSuggestion.filter property
6
-
7
- Returns the suggestion filter object. It is a BooleanFilter because the label is needed. It returns only the first element because the facets and filters are being planned in the BaseSuggestions component.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- protected get filter(): BooleanFilter | undefined;
13
- ```
@@ -1,13 +0,0 @@
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; [BaseSuggestion](./x-components.basesuggestion.md) &gt; [highlightCurated](./x-components.basesuggestion.highlightcurated.md)
4
-
5
- ## BaseSuggestion.highlightCurated property
6
-
7
- Indicates if the curated suggestion should be highlighted.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- protected highlightCurated: boolean;
13
- ```
@@ -1,13 +0,0 @@
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; [BaseSuggestion](./x-components.basesuggestion.md) &gt; [query](./x-components.basesuggestion.query.md)
4
-
5
- ## BaseSuggestion.query property
6
-
7
- The normalized query of the module using this component.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- protected query: string;
13
- ```
@@ -1,13 +0,0 @@
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; [BaseSuggestion](./x-components.basesuggestion.md) &gt; [suggestion](./x-components.basesuggestion.suggestion.md)
4
-
5
- ## BaseSuggestion.suggestion property
6
-
7
- The suggestion to render and use in the default slot.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- protected suggestion: Suggestion;
13
- ```
@@ -1,13 +0,0 @@
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; [BaseSuggestion](./x-components.basesuggestion.md) &gt; [suggestionSelectedEvents](./x-components.basesuggestion.suggestionselectedevents.md)
4
-
5
- ## BaseSuggestion.suggestionSelectedEvents property
6
-
7
- The [XEvents](./x-components.xevent.md) that will be emitted when selecting a suggestion.
8
-
9
- **Signature:**
10
-
11
- ```typescript
12
- protected suggestionSelectedEvents: Partial<XEventsTypes>;
13
- ```