@empathyco/x-components 3.0.0-alpha.365 → 3.0.0-alpha.367
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.
- package/CHANGELOG.md +47 -0
- package/design-system/deprecated-full-theme.css +78 -78
- package/docs/API-reference/api/x-components.baseaddtocart.md +14 -11
- package/docs/API-reference/api/x-components.basecurrency.md +20 -11
- package/docs/API-reference/api/x-components.baseresultcurrentprice.md +20 -11
- package/docs/API-reference/api/x-components.baseresultimage.md +50 -13
- package/docs/API-reference/api/x-components.baseresultlink.md +15 -10
- package/docs/API-reference/api/x-components.baseresultpreviousprice.md +18 -11
- package/docs/API-reference/api/x-components.baseresultrating.md +20 -11
- package/docs/API-reference/api/x-components.basesuggestion.md +48 -23
- package/docs/API-reference/api/x-components.md +8 -8
- package/js/components/currency/base-currency.vue.js.map +1 -1
- package/js/components/currency/base-currency.vue_rollup-plugin-vue_script.vue.js +51 -38
- package/js/components/currency/base-currency.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/result/base-result-add-to-cart.vue.js.map +1 -1
- package/js/components/result/base-result-add-to-cart.vue_rollup-plugin-vue_script.vue.js +29 -23
- package/js/components/result/base-result-add-to-cart.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/result/base-result-current-price.vue.js.map +1 -1
- package/js/components/result/base-result-current-price.vue_rollup-plugin-vue_script.vue.js +47 -26
- package/js/components/result/base-result-current-price.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/result/base-result-image.vue.js +1 -1
- package/js/components/result/base-result-image.vue.js.map +1 -1
- package/js/components/result/base-result-image.vue_rollup-plugin-vue_script.vue.js +130 -96
- package/js/components/result/base-result-image.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/result/base-result-image.vue_rollup-plugin-vue_styles.0.vue.js +1 -1
- package/js/components/result/base-result-link.vue.js +2 -1
- package/js/components/result/base-result-link.vue.js.map +1 -1
- package/js/components/result/base-result-link.vue_rollup-plugin-vue_script.vue.js +46 -27
- package/js/components/result/base-result-link.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/result/base-result-link.vue_rollup-plugin-vue_styles.0.vue.js +1 -1
- package/js/components/result/base-result-previous-price.vue.js.map +1 -1
- package/js/components/result/base-result-previous-price.vue_rollup-plugin-vue_script.vue.js +34 -17
- package/js/components/result/base-result-previous-price.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/result/base-result-rating.vue.js +2 -1
- package/js/components/result/base-result-rating.vue.js.map +1 -1
- package/js/components/result/base-result-rating.vue_rollup-plugin-vue_script.vue.js +44 -27
- package/js/components/result/base-result-rating.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/result/base-result-rating.vue_rollup-plugin-vue_styles.0.vue.js +1 -1
- package/js/components/suggestions/base-suggestion.vue.js +6 -2
- package/js/components/suggestions/base-suggestion.vue.js.map +1 -1
- package/js/components/suggestions/base-suggestion.vue_rollup-plugin-vue_script.vue.js +124 -94
- package/js/components/suggestions/base-suggestion.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/utils/options-api.js +4 -0
- package/js/utils/options-api.js.map +1 -0
- package/package.json +2 -2
- package/report/x-components.api.json +1935 -969
- package/report/x-components.api.md +197 -80
- package/types/components/currency/base-currency.vue.d.ts +26 -20
- package/types/components/currency/base-currency.vue.d.ts.map +1 -1
- package/types/components/result/base-result-add-to-cart.vue.d.ts +16 -8
- package/types/components/result/base-result-add-to-cart.vue.d.ts.map +1 -1
- package/types/components/result/base-result-current-price.vue.d.ts +40 -10
- package/types/components/result/base-result-current-price.vue.d.ts.map +1 -1
- package/types/components/result/base-result-image.vue.d.ts +60 -70
- package/types/components/result/base-result-image.vue.d.ts.map +1 -1
- package/types/components/result/base-result-link.vue.d.ts +18 -23
- package/types/components/result/base-result-link.vue.d.ts.map +1 -1
- package/types/components/result/base-result-previous-price.vue.d.ts +40 -5
- package/types/components/result/base-result-previous-price.vue.d.ts.map +1 -1
- package/types/components/result/base-result-rating.vue.d.ts +28 -9
- package/types/components/result/base-result-rating.vue.d.ts.map +1 -1
- package/types/components/suggestions/base-suggestion.vue.d.ts +55 -36
- package/types/components/suggestions/base-suggestion.vue.d.ts.map +1 -1
- package/types/utils/options-api.d.ts +3 -0
- package/types/utils/options-api.d.ts.map +1 -0
- package/docs/API-reference/api/x-components.baseaddtocart.events.md +0 -13
- package/docs/API-reference/api/x-components.baseaddtocart.result.md +0 -13
- package/docs/API-reference/api/x-components.basecurrency.format.md +0 -13
- package/docs/API-reference/api/x-components.basecurrency.injectedformat.md +0 -13
- package/docs/API-reference/api/x-components.basecurrency.value.md +0 -18
- package/docs/API-reference/api/x-components.baseresultcurrentprice.format.md +0 -18
- package/docs/API-reference/api/x-components.baseresultcurrentprice.result.md +0 -13
- package/docs/API-reference/api/x-components.baseresultimage.hoveranimation.md +0 -13
- package/docs/API-reference/api/x-components.baseresultimage.loadanimation.md +0 -13
- package/docs/API-reference/api/x-components.baseresultimage.result.md +0 -13
- package/docs/API-reference/api/x-components.baseresultimage.shownextimageonhover.md +0 -13
- package/docs/API-reference/api/x-components.baseresultlink.result.md +0 -13
- package/docs/API-reference/api/x-components.baseresultpreviousprice.format.md +0 -18
- package/docs/API-reference/api/x-components.baseresultpreviousprice.result.md +0 -13
- package/docs/API-reference/api/x-components.baseresultrating.link.md +0 -13
- package/docs/API-reference/api/x-components.baseresultrating.result.md +0 -13
- package/docs/API-reference/api/x-components.basesuggestion.dynamiccssclasses.md +0 -18
- package/docs/API-reference/api/x-components.basesuggestion.emitevents.md +0 -17
- package/docs/API-reference/api/x-components.basesuggestion.events.md +0 -18
- package/docs/API-reference/api/x-components.basesuggestion.feature.md +0 -13
- package/docs/API-reference/api/x-components.basesuggestion.filter.md +0 -13
- package/docs/API-reference/api/x-components.basesuggestion.highlightcurated.md +0 -13
- package/docs/API-reference/api/x-components.basesuggestion.query.md +0 -13
- package/docs/API-reference/api/x-components.basesuggestion.suggestion.md +0 -13
- package/docs/API-reference/api/x-components.basesuggestion.suggestionselectedevents.md +0 -13
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,52 @@
|
|
|
1
1
|
# Change Log
|
|
2
2
|
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
|
+
|
|
6
|
+
## [3.0.0-alpha.367](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.366...@empathyco/x-components@3.0.0-alpha.367) (2023-05-11)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### ⚠ BREAKING CHANGES
|
|
10
|
+
|
|
11
|
+
* **deps:** minimum version required is node v18
|
|
12
|
+
|
|
13
|
+
EMP-274
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* migrate suggestions and currency components to vue 3 syntax (#1159) ([67beb82](https://github.com/empathyco/x/commit/67beb820722521e0db3cfdc9ae039e52e6d268f7))
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Bug Fixes
|
|
21
|
+
|
|
22
|
+
* `BaseResultImage` not showing the right size on load (#1176) ([c7ebf54](https://github.com/empathyco/x/commit/c7ebf54f03e23bdf8cd1a64e1e008369ca1a643d))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Others
|
|
26
|
+
|
|
27
|
+
* **deps:** update node to v18 (#1175) ([14e64e1](https://github.com/empathyco/x/commit/14e64e11fdf7f3d27d59baf56b027857df9e61e7))
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
### Continuous Integration
|
|
31
|
+
|
|
32
|
+
* parallelize steps (#1174) ([3013595](https://github.com/empathyco/x/commit/3013595857c8dac33f36b2c0d08e747b0735c6a0))
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
# Change Log
|
|
37
|
+
|
|
38
|
+
All notable changes to this project will be documented in this file. See
|
|
39
|
+
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
40
|
+
|
|
41
|
+
## [3.0.0-alpha.366](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.365...@empathyco/x-components@3.0.0-alpha.366) (2023-05-04)
|
|
42
|
+
|
|
43
|
+
### Features
|
|
44
|
+
|
|
45
|
+
- migrate results to vue 3 syntax (#1145)
|
|
46
|
+
([820622a](https://github.com/empathyco/x/commit/820622ab6a37d03de1e4843df2bdbb9daea57e58))
|
|
47
|
+
|
|
48
|
+
# Change Log
|
|
49
|
+
|
|
3
50
|
All notable changes to this project will be documented in this file. See
|
|
4
51
|
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
52
|
|
|
@@ -286,49 +286,6 @@
|
|
|
286
286
|
--x-size-border-width-bottom-button-default: var(--x-size-border-width-bottom-button-tertiary);
|
|
287
287
|
--x-size-border-width-left-button-default: var(--x-size-border-width-left-button-tertiary);
|
|
288
288
|
}
|
|
289
|
-
:root {
|
|
290
|
-
--x-size-gap-dropdown-card: var(--x-size-base-03);
|
|
291
|
-
--x-size-border-radius-dropdown-card: var(--x-size-border-radius-base-s);
|
|
292
|
-
--x-size-border-radius-top-left-dropdown-card: var(--x-size-border-radius-dropdown-card);
|
|
293
|
-
--x-size-border-radius-top-right-dropdown-card: var(--x-size-border-radius-dropdown-card);
|
|
294
|
-
--x-size-border-radius-bottom-right-dropdown-card: var(--x-size-border-radius-dropdown-card);
|
|
295
|
-
--x-size-border-radius-bottom-left-dropdown-card: var(--x-size-border-radius-dropdown-card);
|
|
296
|
-
--x-size-border-width-dropdown-list-card: var(--x-size-border-width-base);
|
|
297
|
-
--x-size-border-width-top-dropdown-list-card: var(--x-size-border-width-dropdown-list-card);
|
|
298
|
-
--x-size-border-width-right-dropdown-list-card: var(--x-size-border-width-dropdown-list-card);
|
|
299
|
-
--x-size-border-width-bottom-dropdown-list-card: var(--x-size-border-width-dropdown-list-card);
|
|
300
|
-
--x-size-border-width-left-dropdown-list-card: var(--x-size-border-width-dropdown-list-card);
|
|
301
|
-
}
|
|
302
|
-
|
|
303
|
-
.x-dropdown--card {
|
|
304
|
-
--x-size-gap-dropdown-default: var(--x-size-gap-dropdown-card);
|
|
305
|
-
--x-size-border-radius-dropdown-default: var(--x-size-border-radius-dropdown-card);
|
|
306
|
-
--x-size-border-radius-top-left-dropdown-default: var(
|
|
307
|
-
--x-size-border-radius-top-left-dropdown-card
|
|
308
|
-
);
|
|
309
|
-
--x-size-border-radius-top-right-dropdown-default: var(
|
|
310
|
-
--x-size-border-radius-top-right-dropdown-card
|
|
311
|
-
);
|
|
312
|
-
--x-size-border-radius-bottom-right-dropdown-default: var(
|
|
313
|
-
--x-size-border-radius-bottom-right-dropdown-card
|
|
314
|
-
);
|
|
315
|
-
--x-size-border-radius-bottom-left-dropdown-default: var(
|
|
316
|
-
--x-size-border-radius-bottom-left-dropdown-card
|
|
317
|
-
);
|
|
318
|
-
--x-size-border-width-dropdown-list-default: var(--x-size-border-width-dropdown-list-card);
|
|
319
|
-
--x-size-border-width-top-dropdown-list-default: var(
|
|
320
|
-
--x-size-border-width-top-dropdown-list-card
|
|
321
|
-
);
|
|
322
|
-
--x-size-border-width-right-dropdown-list-default: var(
|
|
323
|
-
--x-size-border-width-right-dropdown-list-card
|
|
324
|
-
);
|
|
325
|
-
--x-size-border-width-bottom-dropdown-list-default: var(
|
|
326
|
-
--x-size-border-width-bottom-dropdown-list-card
|
|
327
|
-
);
|
|
328
|
-
--x-size-border-width-left-dropdown-list-default: var(
|
|
329
|
-
--x-size-border-width-left-dropdown-list-card
|
|
330
|
-
);
|
|
331
|
-
}
|
|
332
289
|
:root {
|
|
333
290
|
--x-size-border-radius-dropdown-default: var(--x-size-border-radius-base-none);
|
|
334
291
|
--x-size-border-radius-top-left-dropdown-default: var(--x-size-border-radius-dropdown-default);
|
|
@@ -571,6 +528,49 @@
|
|
|
571
528
|
[dir="rtl"] .x-dropdown--right .x-dropdown__items-list {
|
|
572
529
|
left: 0;
|
|
573
530
|
}
|
|
531
|
+
:root {
|
|
532
|
+
--x-size-gap-dropdown-card: var(--x-size-base-03);
|
|
533
|
+
--x-size-border-radius-dropdown-card: var(--x-size-border-radius-base-s);
|
|
534
|
+
--x-size-border-radius-top-left-dropdown-card: var(--x-size-border-radius-dropdown-card);
|
|
535
|
+
--x-size-border-radius-top-right-dropdown-card: var(--x-size-border-radius-dropdown-card);
|
|
536
|
+
--x-size-border-radius-bottom-right-dropdown-card: var(--x-size-border-radius-dropdown-card);
|
|
537
|
+
--x-size-border-radius-bottom-left-dropdown-card: var(--x-size-border-radius-dropdown-card);
|
|
538
|
+
--x-size-border-width-dropdown-list-card: var(--x-size-border-width-base);
|
|
539
|
+
--x-size-border-width-top-dropdown-list-card: var(--x-size-border-width-dropdown-list-card);
|
|
540
|
+
--x-size-border-width-right-dropdown-list-card: var(--x-size-border-width-dropdown-list-card);
|
|
541
|
+
--x-size-border-width-bottom-dropdown-list-card: var(--x-size-border-width-dropdown-list-card);
|
|
542
|
+
--x-size-border-width-left-dropdown-list-card: var(--x-size-border-width-dropdown-list-card);
|
|
543
|
+
}
|
|
544
|
+
|
|
545
|
+
.x-dropdown--card {
|
|
546
|
+
--x-size-gap-dropdown-default: var(--x-size-gap-dropdown-card);
|
|
547
|
+
--x-size-border-radius-dropdown-default: var(--x-size-border-radius-dropdown-card);
|
|
548
|
+
--x-size-border-radius-top-left-dropdown-default: var(
|
|
549
|
+
--x-size-border-radius-top-left-dropdown-card
|
|
550
|
+
);
|
|
551
|
+
--x-size-border-radius-top-right-dropdown-default: var(
|
|
552
|
+
--x-size-border-radius-top-right-dropdown-card
|
|
553
|
+
);
|
|
554
|
+
--x-size-border-radius-bottom-right-dropdown-default: var(
|
|
555
|
+
--x-size-border-radius-bottom-right-dropdown-card
|
|
556
|
+
);
|
|
557
|
+
--x-size-border-radius-bottom-left-dropdown-default: var(
|
|
558
|
+
--x-size-border-radius-bottom-left-dropdown-card
|
|
559
|
+
);
|
|
560
|
+
--x-size-border-width-dropdown-list-default: var(--x-size-border-width-dropdown-list-card);
|
|
561
|
+
--x-size-border-width-top-dropdown-list-default: var(
|
|
562
|
+
--x-size-border-width-top-dropdown-list-card
|
|
563
|
+
);
|
|
564
|
+
--x-size-border-width-right-dropdown-list-default: var(
|
|
565
|
+
--x-size-border-width-right-dropdown-list-card
|
|
566
|
+
);
|
|
567
|
+
--x-size-border-width-bottom-dropdown-list-default: var(
|
|
568
|
+
--x-size-border-width-bottom-dropdown-list-card
|
|
569
|
+
);
|
|
570
|
+
--x-size-border-width-left-dropdown-list-default: var(
|
|
571
|
+
--x-size-border-width-left-dropdown-list-card
|
|
572
|
+
);
|
|
573
|
+
}
|
|
574
574
|
:root {
|
|
575
575
|
--x-size-width-dropdown-l: 202px;
|
|
576
576
|
}
|
|
@@ -1055,12 +1055,6 @@
|
|
|
1055
1055
|
.x-hierarchical-filter-container .x-filter, .x-hierarchical-filter-container .x-facet-filter {
|
|
1056
1056
|
width: 100%;
|
|
1057
1057
|
}
|
|
1058
|
-
.x-filter--justified.x-filter > *:last-child:not(.x-filter__label),
|
|
1059
|
-
.x-filter--justified.x-facet-filter > *:last-child:not(.x-filter__label),
|
|
1060
|
-
.x-filter--justified .x-filter > *:last-child:not(.x-filter__label),
|
|
1061
|
-
.x-filter--justified .x-facet-filter > *:last-child:not(.x-filter__label) {
|
|
1062
|
-
margin-left: auto;
|
|
1063
|
-
}
|
|
1064
1058
|
:root {
|
|
1065
1059
|
--x-size-padding-grid: 0;
|
|
1066
1060
|
--x-size-gap-grid: var(--x-size-base-03);
|
|
@@ -1087,6 +1081,12 @@
|
|
|
1087
1081
|
.x-grid-list--cols-auto .x-grid-list__item {
|
|
1088
1082
|
min-width: var(--x-size-min-width-grid-item);
|
|
1089
1083
|
}
|
|
1084
|
+
.x-filter--justified.x-filter > *:last-child:not(.x-filter__label),
|
|
1085
|
+
.x-filter--justified.x-facet-filter > *:last-child:not(.x-filter__label),
|
|
1086
|
+
.x-filter--justified .x-filter > *:last-child:not(.x-filter__label),
|
|
1087
|
+
.x-filter--justified .x-facet-filter > *:last-child:not(.x-filter__label) {
|
|
1088
|
+
margin-left: auto;
|
|
1089
|
+
}
|
|
1090
1090
|
:root {
|
|
1091
1091
|
--x-color-stroke-icon-default: currentColor;
|
|
1092
1092
|
--x-color-fill-icon-default: none;
|
|
@@ -3484,35 +3484,6 @@
|
|
|
3484
3484
|
.x-row--gap-20 {
|
|
3485
3485
|
--x-size-gap-row: var(--x-size-gap-row-20);
|
|
3486
3486
|
}
|
|
3487
|
-
/* @deprecated */
|
|
3488
|
-
:root {
|
|
3489
|
-
--x-size-padding-row-02: var(--x-size-base-02);
|
|
3490
|
-
--x-size-padding-row-03: var(--x-size-base-03);
|
|
3491
|
-
--x-size-padding-row-04: var(--x-size-base-04);
|
|
3492
|
-
--x-size-padding-row-05: var(--x-size-base-05);
|
|
3493
|
-
--x-size-padding-row-06: var(--x-size-base-06);
|
|
3494
|
-
}
|
|
3495
|
-
|
|
3496
|
-
/* @deprecated */
|
|
3497
|
-
.x-row--padding-02 {
|
|
3498
|
-
--x-size-padding-row: var(--x-size-padding-row-02);
|
|
3499
|
-
}
|
|
3500
|
-
|
|
3501
|
-
.x-row--padding-03 {
|
|
3502
|
-
--x-size-padding-row: var(--x-size-padding-row-03);
|
|
3503
|
-
}
|
|
3504
|
-
|
|
3505
|
-
.x-row--padding-04 {
|
|
3506
|
-
--x-size-padding-row: var(--x-size-padding-row-04);
|
|
3507
|
-
}
|
|
3508
|
-
|
|
3509
|
-
.x-row--padding-05 {
|
|
3510
|
-
--x-size-padding-row: var(--x-size-padding-row-05);
|
|
3511
|
-
}
|
|
3512
|
-
|
|
3513
|
-
.x-row--padding-06 {
|
|
3514
|
-
--x-size-padding-row: var(--x-size-padding-row-06);
|
|
3515
|
-
}
|
|
3516
3487
|
:root {
|
|
3517
3488
|
--x-string-overflow-scroll: auto;
|
|
3518
3489
|
--x-color-background-scroll-bar: transparent;
|
|
@@ -3551,6 +3522,35 @@
|
|
|
3551
3522
|
.x-base-scroll {
|
|
3552
3523
|
overflow-y: var(--x-string-overflow-scroll, auto);
|
|
3553
3524
|
}
|
|
3525
|
+
/* @deprecated */
|
|
3526
|
+
:root {
|
|
3527
|
+
--x-size-padding-row-02: var(--x-size-base-02);
|
|
3528
|
+
--x-size-padding-row-03: var(--x-size-base-03);
|
|
3529
|
+
--x-size-padding-row-04: var(--x-size-base-04);
|
|
3530
|
+
--x-size-padding-row-05: var(--x-size-base-05);
|
|
3531
|
+
--x-size-padding-row-06: var(--x-size-base-06);
|
|
3532
|
+
}
|
|
3533
|
+
|
|
3534
|
+
/* @deprecated */
|
|
3535
|
+
.x-row--padding-02 {
|
|
3536
|
+
--x-size-padding-row: var(--x-size-padding-row-02);
|
|
3537
|
+
}
|
|
3538
|
+
|
|
3539
|
+
.x-row--padding-03 {
|
|
3540
|
+
--x-size-padding-row: var(--x-size-padding-row-03);
|
|
3541
|
+
}
|
|
3542
|
+
|
|
3543
|
+
.x-row--padding-04 {
|
|
3544
|
+
--x-size-padding-row: var(--x-size-padding-row-04);
|
|
3545
|
+
}
|
|
3546
|
+
|
|
3547
|
+
.x-row--padding-05 {
|
|
3548
|
+
--x-size-padding-row: var(--x-size-padding-row-05);
|
|
3549
|
+
}
|
|
3550
|
+
|
|
3551
|
+
.x-row--padding-06 {
|
|
3552
|
+
--x-size-padding-row: var(--x-size-padding-row-06);
|
|
3553
|
+
}
|
|
3554
3554
|
.x-sliding-panel {
|
|
3555
3555
|
z-index: 0;
|
|
3556
3556
|
background-color: var(--x-color-background-sliding-panel);
|
|
@@ -2,21 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseAddToCart](./x-components.baseaddtocart.md)
|
|
4
4
|
|
|
5
|
-
## BaseAddToCart
|
|
5
|
+
## BaseAddToCart variable
|
|
6
6
|
|
|
7
7
|
Renders a button with a default slot. It receives the result with the data and emits [XEventsTypes.UserClickedResultAddToCart](./x-components.xeventstypes.userclickedresultaddtocart.md) to the bus on click mouse event.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
_default: import("vue").DefineComponent<{
|
|
13
|
+
result: {
|
|
14
|
+
type: PropType<Result>;
|
|
15
|
+
required: true;
|
|
16
|
+
};
|
|
17
|
+
}, {
|
|
18
|
+
events: import("vue").ComputedRef<Partial<XEventsTypes>>;
|
|
19
|
+
}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
|
|
20
|
+
result: {
|
|
21
|
+
type: PropType<Result>;
|
|
22
|
+
required: true;
|
|
23
|
+
};
|
|
24
|
+
}>>, {}>
|
|
13
25
|
```
|
|
14
|
-
**Extends:** Vue
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
| Property | Modifiers | Type | Description |
|
|
19
|
-
| --- | --- | --- | --- |
|
|
20
|
-
| [events](./x-components.baseaddtocart.events.md) | <p><code>protected</code></p><p><code>readonly</code></p> | Partial<[XEventsTypes](./x-components.xeventstypes.md)<!-- -->> | The events to be emitted by the button. |
|
|
21
|
-
| [result](./x-components.baseaddtocart.result.md) | <code>protected</code> | Result | (Required) The [result](./x-types.result.md) information. |
|
|
22
|
-
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseCurrency](./x-components.basecurrency.md)
|
|
4
4
|
|
|
5
|
-
## BaseCurrency
|
|
5
|
+
## BaseCurrency variable
|
|
6
6
|
|
|
7
7
|
Renders the value received as a property which always must be a JavaScript number, with the proper format provided as a string property or by injection. The rendered tag is a span in order to render a default inline HTML element.
|
|
8
8
|
|
|
@@ -11,9 +11,26 @@ Regarding the format or mask to be defined as string: - Use 'i' to define intege
|
|
|
11
11
|
**Signature:**
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
|
|
14
|
+
_default: import("vue").DefineComponent<{
|
|
15
|
+
value: {
|
|
16
|
+
type: NumberConstructor;
|
|
17
|
+
required: true;
|
|
18
|
+
};
|
|
19
|
+
format: {
|
|
20
|
+
type: StringConstructor;
|
|
21
|
+
};
|
|
22
|
+
}, {
|
|
23
|
+
currency: import("vue").ComputedRef<string>;
|
|
24
|
+
}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
|
|
25
|
+
value: {
|
|
26
|
+
type: NumberConstructor;
|
|
27
|
+
required: true;
|
|
28
|
+
};
|
|
29
|
+
format: {
|
|
30
|
+
type: StringConstructor;
|
|
31
|
+
};
|
|
32
|
+
}>>, {}>
|
|
15
33
|
```
|
|
16
|
-
**Extends:** Vue
|
|
17
34
|
|
|
18
35
|
## Remarks
|
|
19
36
|
|
|
@@ -33,11 +50,3 @@ It will render: `123.456,7890 €`<!-- -->.
|
|
|
33
50
|
|
|
34
51
|
See docs below for more examples.
|
|
35
52
|
|
|
36
|
-
## Properties
|
|
37
|
-
|
|
38
|
-
| Property | Modifiers | Type | Description |
|
|
39
|
-
| --- | --- | --- | --- |
|
|
40
|
-
| [format?](./x-components.basecurrency.format.md) | <code>protected</code> | string | _(Optional)_ The format as string. |
|
|
41
|
-
| [injectedFormat](./x-components.basecurrency.injectedformat.md) | | string | The injected format as string. |
|
|
42
|
-
| [value](./x-components.basecurrency.value.md) | <code>protected</code> | number | Numeric value to be formatted. |
|
|
43
|
-
|
|
@@ -2,21 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseResultCurrentPrice](./x-components.baseresultcurrentprice.md)
|
|
4
4
|
|
|
5
|
-
## BaseResultCurrentPrice
|
|
5
|
+
## BaseResultCurrentPrice variable
|
|
6
6
|
|
|
7
7
|
Component that renders the [result](./x-types.result.md) current price that may or may not be on sale.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
_default: import("vue").DefineComponent<{
|
|
13
|
+
result: {
|
|
14
|
+
type: PropType<Result>;
|
|
15
|
+
required: true;
|
|
16
|
+
};
|
|
17
|
+
format: {
|
|
18
|
+
type: StringConstructor;
|
|
19
|
+
};
|
|
20
|
+
}, {
|
|
21
|
+
dynamicClasses: import("vue").ComputedRef<VueCSSClasses>;
|
|
22
|
+
}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
|
|
23
|
+
result: {
|
|
24
|
+
type: PropType<Result>;
|
|
25
|
+
required: true;
|
|
26
|
+
};
|
|
27
|
+
format: {
|
|
28
|
+
type: StringConstructor;
|
|
29
|
+
};
|
|
30
|
+
}>>, {}>
|
|
13
31
|
```
|
|
14
|
-
**Extends:** Vue
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
| Property | Modifiers | Type | Description |
|
|
19
|
-
| --- | --- | --- | --- |
|
|
20
|
-
| [format?](./x-components.baseresultcurrentprice.format.md) | <code>protected</code> | string | _(Optional)_ Format or mask to be defined as string. - Use 'i' to define integer numbers. - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the doesn't include decimals, it is filled with zeros until reach the length defined with 'd's. - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group. - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more than one character. - Set whatever you need around the integers and decimals marks. - Default mask: 'i.iii,dd' which returns '1.345,67'. |
|
|
21
|
-
| [result](./x-components.baseresultcurrentprice.result.md) | <code>protected</code> | Result | (Required) The [result](./x-types.result.md) information. |
|
|
22
|
-
|
|
@@ -2,23 +2,60 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseResultImage](./x-components.baseresultimage.md)
|
|
4
4
|
|
|
5
|
-
## BaseResultImage
|
|
5
|
+
## BaseResultImage variable
|
|
6
6
|
|
|
7
7
|
Component to be reused that renders an `<img>`<!-- -->.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
_default: DefineComponent<{
|
|
13
|
+
result: {
|
|
14
|
+
type: PropType<Result>;
|
|
15
|
+
required: true;
|
|
16
|
+
};
|
|
17
|
+
loadAnimation: {
|
|
18
|
+
type: PropType<string | DefineComponent<{}, {}, {}, import("vue").ComponentComputedOptions, import("vue").ComponentMethodOptions, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>>;
|
|
19
|
+
default: () => import("vue/types/vue").ExtendedVue<import("vue").default<Record<string, any>, Record<string, any>, never, never, (event: string, ...args: any[]) => import("vue").default<Record<string, any>, Record<string, any>, never, never, any>>, unknown, unknown, unknown, Record<never, any>, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin>;
|
|
20
|
+
};
|
|
21
|
+
hoverAnimation: {
|
|
22
|
+
type: PropType<string | DefineComponent<{}, {}, {}, import("vue").ComponentComputedOptions, import("vue").ComponentMethodOptions, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>>;
|
|
23
|
+
};
|
|
24
|
+
showNextImageOnHover: {
|
|
25
|
+
type: BooleanConstructor;
|
|
26
|
+
default: boolean;
|
|
27
|
+
};
|
|
28
|
+
}, {
|
|
29
|
+
pendingImages: Ref<string[]>;
|
|
30
|
+
loadedImages: Ref<string[]>;
|
|
31
|
+
isHovering: Ref<boolean>;
|
|
32
|
+
userHasHoveredImage: Ref<boolean>;
|
|
33
|
+
loaderStyles: Partial<CSSStyleDeclaration>;
|
|
34
|
+
animation: import("vue").ComputedRef<string | DefineComponent<{}, {}, {}, import("vue").ComponentComputedOptions, import("vue").ComponentMethodOptions, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>>;
|
|
35
|
+
imageSrc: import("vue").ComputedRef<string>;
|
|
36
|
+
shouldLoadNextImage: import("vue").ComputedRef<boolean>;
|
|
37
|
+
flagImageAsFailed: () => void;
|
|
38
|
+
flagImageLoaded: () => void;
|
|
39
|
+
}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
|
|
40
|
+
result: {
|
|
41
|
+
type: PropType<Result>;
|
|
42
|
+
required: true;
|
|
43
|
+
};
|
|
44
|
+
loadAnimation: {
|
|
45
|
+
type: PropType<string | DefineComponent<{}, {}, {}, import("vue").ComponentComputedOptions, import("vue").ComponentMethodOptions, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>>;
|
|
46
|
+
default: () => import("vue/types/vue").ExtendedVue<import("vue").default<Record<string, any>, Record<string, any>, never, never, (event: string, ...args: any[]) => import("vue").default<Record<string, any>, Record<string, any>, never, never, any>>, unknown, unknown, unknown, Record<never, any>, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin>;
|
|
47
|
+
};
|
|
48
|
+
hoverAnimation: {
|
|
49
|
+
type: PropType<string | DefineComponent<{}, {}, {}, import("vue").ComponentComputedOptions, import("vue").ComponentMethodOptions, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}>>;
|
|
50
|
+
};
|
|
51
|
+
showNextImageOnHover: {
|
|
52
|
+
type: BooleanConstructor;
|
|
53
|
+
default: boolean;
|
|
54
|
+
};
|
|
55
|
+
}>>, {
|
|
56
|
+
loadAnimation: string | DefineComponent<{}, {}, {}, import("vue").ComponentComputedOptions, import("vue").ComponentMethodOptions, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{}>>, {}> | (import("vue/types/v3-component-public-instance").ComponentPublicInstanceConstructor<import("vue/types/v3-component-public-instance").Vue3Instance<{}, Readonly<import("vue").ExtractPropTypes<{}>>, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}, true, import("vue/types/v3-component-options").ComponentOptionsBase<any, any, any, any, any, any, any, any, any, any>> & Readonly<Readonly<import("vue").ExtractPropTypes<{}>>> & import("vue").ShallowUnwrapRef<{}> & import("vue/types/v3-component-options").ExtractComputedReturns<import("vue").ComponentComputedOptions> & import("vue").ComponentMethodOptions & import("vue").ComponentCustomProperties & Readonly<import("vue").ExtractPropTypes<{}>>, any, any, any, import("vue").ComponentComputedOptions, import("vue").ComponentMethodOptions> & import("vue/types/v3-component-options").ComponentOptionsBase<Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}, import("vue").ComponentComputedOptions, import("vue").ComponentMethodOptions, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, {}> & {
|
|
57
|
+
props: {};
|
|
58
|
+
});
|
|
59
|
+
showNextImageOnHover: boolean;
|
|
60
|
+
}>
|
|
13
61
|
```
|
|
14
|
-
**Extends:** Vue
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
| Property | Modifiers | Type | Description |
|
|
19
|
-
| --- | --- | --- | --- |
|
|
20
|
-
| [hoverAnimation](./x-components.baseresultimage.hoveranimation.md) | | string \| typeof Vue \| undefined | Animation to use when switching between the loaded image and the hover image. |
|
|
21
|
-
| [loadAnimation](./x-components.baseresultimage.loadanimation.md) | | string \| typeof Vue | Animation to use when switching between the placeholder, the loaded image, or the failed image fallback. |
|
|
22
|
-
| [result](./x-components.baseresultimage.result.md) | <code>protected</code> | Result | (Required) The [result](./x-types.result.md) information. |
|
|
23
|
-
| [showNextImageOnHover](./x-components.baseresultimage.shownextimageonhover.md) | | boolean | Indicates if the next valid image should be displayed on hover. |
|
|
24
|
-
|
|
@@ -2,24 +2,29 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseResultLink](./x-components.baseresultlink.md)
|
|
4
4
|
|
|
5
|
-
## BaseResultLink
|
|
5
|
+
## BaseResultLink variable
|
|
6
6
|
|
|
7
7
|
Component to be reused that renders an `<a>` wrapping the result contents.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
_default: import("vue").DefineComponent<{
|
|
13
|
+
result: {
|
|
14
|
+
type: PropType<Result>;
|
|
15
|
+
required: true;
|
|
16
|
+
};
|
|
17
|
+
}, {
|
|
18
|
+
emitUserClickedAResult: () => void;
|
|
19
|
+
}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
|
|
20
|
+
result: {
|
|
21
|
+
type: PropType<Result>;
|
|
22
|
+
required: true;
|
|
23
|
+
};
|
|
24
|
+
}>>, {}>
|
|
13
25
|
```
|
|
14
|
-
**Extends:** Vue
|
|
15
26
|
|
|
16
27
|
## Remarks
|
|
17
28
|
|
|
18
|
-
It has the logic to emit [XEventsTypes.UserClickedAResult](./x-components.xeventstypes.userclickedaresult.md) to the bus on click mouse events. Additionally, this component may be injected other events to be emitted on click event, so, depending where it's used its father component may provide this events.
|
|
19
|
-
|
|
20
|
-
## Properties
|
|
21
|
-
|
|
22
|
-
| Property | Modifiers | Type | Description |
|
|
23
|
-
| --- | --- | --- | --- |
|
|
24
|
-
| [result](./x-components.baseresultlink.result.md) | <code>protected</code> | Result | (Required) The [result](./x-types.result.md) information. |
|
|
29
|
+
It has the logic to emit [XEventsTypes.UserClickedAResult](./x-components.xeventstypes.userclickedaresult.md) to the bus on click mouse events. Additionally, this component may be injected other events to be emitted on click event, so, depending on where it's used its father component may provide this events.
|
|
25
30
|
|
|
@@ -2,21 +2,28 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseResultPreviousPrice](./x-components.baseresultpreviousprice.md)
|
|
4
4
|
|
|
5
|
-
## BaseResultPreviousPrice
|
|
5
|
+
## BaseResultPreviousPrice variable
|
|
6
6
|
|
|
7
7
|
Component that renders the [result](./x-types.result.md) previous price.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
_default: import("vue").DefineComponent<{
|
|
13
|
+
result: {
|
|
14
|
+
type: PropType<Result>;
|
|
15
|
+
required: true;
|
|
16
|
+
};
|
|
17
|
+
format: {
|
|
18
|
+
type: StringConstructor;
|
|
19
|
+
};
|
|
20
|
+
}, {}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
|
|
21
|
+
result: {
|
|
22
|
+
type: PropType<Result>;
|
|
23
|
+
required: true;
|
|
24
|
+
};
|
|
25
|
+
format: {
|
|
26
|
+
type: StringConstructor;
|
|
27
|
+
};
|
|
28
|
+
}>>, {}>
|
|
13
29
|
```
|
|
14
|
-
**Extends:** Vue
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
| Property | Modifiers | Type | Description |
|
|
19
|
-
| --- | --- | --- | --- |
|
|
20
|
-
| [format?](./x-components.baseresultpreviousprice.format.md) | <code>protected</code> | string | _(Optional)_ Format or mask to be defined as string. - Use 'i' to define integer numbers. - Use 'd' to define decimal numbers. You can define the length of the decimal part. If the doesn't include decimals, it is filled with zeros until reach the length defined with 'd's. - Integer separator must be defined between the 3rd and the 4th integer 'i' of a group. - Decimal separator must be defined between the last 'i' and the first 'd'. It can be more than one character. - Set whatever you need around the integers and decimals marks. |
|
|
21
|
-
| [result](./x-components.baseresultpreviousprice.result.md) | <code>protected</code> | Result | (Required) The [result](./x-types.result.md) information. |
|
|
22
|
-
|
|
@@ -2,21 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseResultRating](./x-components.baseresultrating.md)
|
|
4
4
|
|
|
5
|
-
## BaseResultRating
|
|
5
|
+
## BaseResultRating variable
|
|
6
6
|
|
|
7
7
|
This component renders a [BaseRating](./x-components.baserating.md) for a result passed as prop.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
_default: import("vue").DefineComponent<{
|
|
13
|
+
result: {
|
|
14
|
+
type: PropType<Result>;
|
|
15
|
+
required: true;
|
|
16
|
+
};
|
|
17
|
+
link: {
|
|
18
|
+
type: StringConstructor;
|
|
19
|
+
};
|
|
20
|
+
}, {
|
|
21
|
+
emitClickedEvent: () => void;
|
|
22
|
+
}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
|
|
23
|
+
result: {
|
|
24
|
+
type: PropType<Result>;
|
|
25
|
+
required: true;
|
|
26
|
+
};
|
|
27
|
+
link: {
|
|
28
|
+
type: StringConstructor;
|
|
29
|
+
};
|
|
30
|
+
}>>, {}>
|
|
13
31
|
```
|
|
14
|
-
**Extends:** Vue
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
| Property | Modifiers | Type | Description |
|
|
19
|
-
| --- | --- | --- | --- |
|
|
20
|
-
| [link](./x-components.baseresultrating.link.md) | <code>protected</code> | string | A link to redirect when rating is clicked. |
|
|
21
|
-
| [result](./x-components.baseresultrating.result.md) | <code>protected</code> | Result | The [Result](./x-types.result.md) to render its rating. |
|
|
22
|
-
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseSuggestion](./x-components.basesuggestion.md)
|
|
4
4
|
|
|
5
|
-
## BaseSuggestion
|
|
5
|
+
## BaseSuggestion variable
|
|
6
6
|
|
|
7
7
|
Renders a button with a default slot. It receives a query, which should be the query of the module using this component, a suggestion, the [XEvents](./x-components.xevent.md) that will be emitted on click with a given feature.
|
|
8
8
|
|
|
@@ -11,26 +11,51 @@ The default slot receives the suggestion and the matched query has props.
|
|
|
11
11
|
**Signature:**
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
|
|
14
|
+
_default: import("vue").DefineComponent<{
|
|
15
|
+
query: {
|
|
16
|
+
type: StringConstructor;
|
|
17
|
+
default: string;
|
|
18
|
+
};
|
|
19
|
+
suggestion: {
|
|
20
|
+
type: PropType<Suggestion>;
|
|
21
|
+
required: true;
|
|
22
|
+
};
|
|
23
|
+
feature: {
|
|
24
|
+
type: PropType<QueryFeature>;
|
|
25
|
+
};
|
|
26
|
+
suggestionSelectedEvents: {
|
|
27
|
+
type: PropType<Partial<XEventsTypes>>;
|
|
28
|
+
required: true;
|
|
29
|
+
};
|
|
30
|
+
highlightCurated: {
|
|
31
|
+
type: BooleanConstructor;
|
|
32
|
+
};
|
|
33
|
+
}, {
|
|
34
|
+
el: import("vue").Ref<HTMLElement | null>;
|
|
35
|
+
filter: import("vue").ComputedRef<BooleanFilter | undefined>;
|
|
36
|
+
emitEvents: () => void;
|
|
37
|
+
dynamicCSSClasses: import("vue").ComputedRef<VueCSSClasses>;
|
|
38
|
+
}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
|
|
39
|
+
query: {
|
|
40
|
+
type: StringConstructor;
|
|
41
|
+
default: string;
|
|
42
|
+
};
|
|
43
|
+
suggestion: {
|
|
44
|
+
type: PropType<Suggestion>;
|
|
45
|
+
required: true;
|
|
46
|
+
};
|
|
47
|
+
feature: {
|
|
48
|
+
type: PropType<QueryFeature>;
|
|
49
|
+
};
|
|
50
|
+
suggestionSelectedEvents: {
|
|
51
|
+
type: PropType<Partial<XEventsTypes>>;
|
|
52
|
+
required: true;
|
|
53
|
+
};
|
|
54
|
+
highlightCurated: {
|
|
55
|
+
type: BooleanConstructor;
|
|
56
|
+
};
|
|
57
|
+
}>>, {
|
|
58
|
+
query: string;
|
|
59
|
+
highlightCurated: boolean;
|
|
60
|
+
}>
|
|
15
61
|
```
|
|
16
|
-
**Extends:** Vue
|
|
17
|
-
|
|
18
|
-
## Properties
|
|
19
|
-
|
|
20
|
-
| Property | Modifiers | Type | Description |
|
|
21
|
-
| --- | --- | --- | --- |
|
|
22
|
-
| [dynamicCSSClasses](./x-components.basesuggestion.dynamiccssclasses.md) | <p><code>protected</code></p><p><code>readonly</code></p> | [VueCSSClasses](./x-components.vuecssclasses.md) | Generates css classes dynamically. |
|
|
23
|
-
| [events](./x-components.basesuggestion.events.md) | <p><code>protected</code></p><p><code>readonly</code></p> | Partial<[XEventsTypes](./x-components.xeventstypes.md)<!-- -->> | The event handler that will be triggered when clicking on a suggestion. |
|
|
24
|
-
| [feature?](./x-components.basesuggestion.feature.md) | <code>protected</code> | [QueryFeature](./x-components.queryfeature.md) | _(Optional)_ The feature from which the events will be emitted. |
|
|
25
|
-
| [filter](./x-components.basesuggestion.filter.md) | <p><code>protected</code></p><p><code>readonly</code></p> | BooleanFilter \| undefined | 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. |
|
|
26
|
-
| [highlightCurated](./x-components.basesuggestion.highlightcurated.md) | <code>protected</code> | boolean | Indicates if the curated suggestion should be highlighted. |
|
|
27
|
-
| [query](./x-components.basesuggestion.query.md) | <code>protected</code> | string | The normalized query of the module using this component. |
|
|
28
|
-
| [suggestion](./x-components.basesuggestion.suggestion.md) | <code>protected</code> | Suggestion | The suggestion to render and use in the default slot. |
|
|
29
|
-
| [suggestionSelectedEvents](./x-components.basesuggestion.suggestionselectedevents.md) | <code>protected</code> | Partial<[XEventsTypes](./x-components.xeventstypes.md)<!-- -->> | The [XEvents](./x-components.xevent.md) that will be emitted when selecting a suggestion. |
|
|
30
|
-
|
|
31
|
-
## Methods
|
|
32
|
-
|
|
33
|
-
| Method | Modifiers | Description |
|
|
34
|
-
| --- | --- | --- |
|
|
35
|
-
| [emitEvents()](./x-components.basesuggestion.emitevents.md) | <code>protected</code> | Emits the events when the button is clicked. |
|
|
36
|
-
|