@empathyco/x-components 3.0.0-alpha.364 → 3.0.0-alpha.366
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 +26 -0
- package/design-system/deprecated-full-theme.css +71 -71
- package/docs/API-reference/api/x-components.baseaddtocart.md +14 -11
- package/docs/API-reference/api/x-components.baseheadertogglepanel.animation.md +1 -1
- package/docs/API-reference/api/x-components.baseheadertogglepanel.md +1 -1
- package/docs/API-reference/api/x-components.basepricefilterlabel.md +46 -21
- package/docs/API-reference/api/x-components.baseratingfilterlabel.md +24 -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.basetogglepanel.md +24 -11
- package/docs/API-reference/api/x-components.md +9 -9
- package/js/components/filters/labels/base-price-filter-label.vue.js.map +1 -1
- package/js/components/filters/labels/base-price-filter-label.vue_rollup-plugin-vue_script.vue.js +79 -60
- package/js/components/filters/labels/base-price-filter-label.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/filters/labels/base-rating-filter-label.vue.js.map +1 -1
- package/js/components/filters/labels/base-rating-filter-label.vue_rollup-plugin-vue_script.vue.js +41 -29
- package/js/components/filters/labels/base-rating-filter-label.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/panels/base-header-toggle-panel.vue.js +1 -1
- package/js/components/panels/base-header-toggle-panel.vue.js.map +1 -1
- package/js/components/panels/base-header-toggle-panel.vue_rollup-plugin-vue_script.vue.js.map +1 -1
- package/js/components/panels/base-header-toggle-panel.vue_rollup-plugin-vue_styles.0.vue.js +1 -1
- package/js/components/panels/base-toggle-panel.vue.js.map +1 -1
- package/js/components/panels/base-toggle-panel.vue_rollup-plugin-vue_script.vue.js +25 -15
- package/js/components/panels/base-toggle-panel.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 +125 -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/utils/options-api.js +4 -0
- package/js/utils/options-api.js.map +1 -0
- package/package.json +6 -6
- package/report/x-components.api.json +3107 -1695
- package/report/x-components.api.md +228 -82
- package/types/components/filters/labels/base-price-filter-label.vue.d.ts +59 -13
- package/types/components/filters/labels/base-price-filter-label.vue.d.ts.map +1 -1
- package/types/components/filters/labels/base-rating-filter-label.vue.d.ts +33 -11
- package/types/components/filters/labels/base-rating-filter-label.vue.d.ts.map +1 -1
- package/types/components/panels/base-header-toggle-panel.vue.d.ts +2 -1
- package/types/components/panels/base-header-toggle-panel.vue.d.ts.map +1 -1
- package/types/components/panels/base-toggle-panel.vue.d.ts +35 -5
- package/types/components/panels/base-toggle-panel.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/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.basepricefilterlabel.filter.md +0 -15
- package/docs/API-reference/api/x-components.basepricefilterlabel.format.md +0 -13
- package/docs/API-reference/api/x-components.basepricefilterlabel.from.md +0 -13
- package/docs/API-reference/api/x-components.basepricefilterlabel.fromto.md +0 -13
- package/docs/API-reference/api/x-components.basepricefilterlabel.label.md +0 -13
- package/docs/API-reference/api/x-components.basepricefilterlabel.lessthan.md +0 -13
- package/docs/API-reference/api/x-components.basepricefilterlabel.render.md +0 -22
- package/docs/API-reference/api/x-components.baseratingfilterlabel.filter.md +0 -13
- package/docs/API-reference/api/x-components.baseratingfilterlabel.max.md +0 -13
- 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.basetogglepanel.animation.md +0 -13
- package/docs/API-reference/api/x-components.basetogglepanel.open.md +0 -13
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,32 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See
|
|
4
4
|
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [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)
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
- migrate results to vue 3 syntax (#1145)
|
|
11
|
+
([820622a](https://github.com/empathyco/x/commit/820622ab6a37d03de1e4843df2bdbb9daea57e58))
|
|
12
|
+
|
|
13
|
+
# Change Log
|
|
14
|
+
|
|
15
|
+
All notable changes to this project will be documented in this file. See
|
|
16
|
+
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
17
|
+
|
|
18
|
+
## [3.0.0-alpha.365](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.364...@empathyco/x-components@3.0.0-alpha.365) (2023-05-03)
|
|
19
|
+
|
|
20
|
+
### Features
|
|
21
|
+
|
|
22
|
+
- migrate filters to vue 3 syntax (#1144)
|
|
23
|
+
([6413883](https://github.com/empathyco/x/commit/641388380620ab0d66cea627244912b6f3b2210d))
|
|
24
|
+
- migrate panels components to vue 3 syntax (#1150)
|
|
25
|
+
([5ef137c](https://github.com/empathyco/x/commit/5ef137cbf84d5f68a611a5ecb51cb8454c0a7422))
|
|
26
|
+
|
|
27
|
+
# Change Log
|
|
28
|
+
|
|
29
|
+
All notable changes to this project will be documented in this file. See
|
|
30
|
+
[Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
31
|
+
|
|
6
32
|
## [3.0.0-alpha.364](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.363...@empathyco/x-components@3.0.0-alpha.364) (2023-05-03)
|
|
7
33
|
|
|
8
34
|
### Features
|
|
@@ -2279,77 +2279,6 @@
|
|
|
2279
2279
|
margin-bottom: var(--x-size-gap-list-20);
|
|
2280
2280
|
}
|
|
2281
2281
|
}
|
|
2282
|
-
:root {
|
|
2283
|
-
--x-string-justify-message-default: center;
|
|
2284
|
-
--x-size-gap-message-default: var(--x-size-base-03);
|
|
2285
|
-
--x-size-padding-message-default: var(--x-size-base-06);
|
|
2286
|
-
--x-color-background-message-default: var(--x-color-base-neutral-95);
|
|
2287
|
-
--x-color-border-message-default: var(--x-color-background-message-default);
|
|
2288
|
-
--x-color-text-message-default: var(--x-color-text-default);
|
|
2289
|
-
--x-size-border-radius-message-default: var(--x-size-border-radius-base-m);
|
|
2290
|
-
--x-size-border-radius-top-left-message-default: var(--x-size-border-radius-message-default);
|
|
2291
|
-
--x-size-border-radius-top-right-message-default: var(--x-size-border-radius-message-default);
|
|
2292
|
-
--x-size-border-radius-bottom-right-message-default: var(--x-size-border-radius-message-default);
|
|
2293
|
-
--x-size-border-radius-bottom-left-message-default: var(--x-size-border-radius-message-default);
|
|
2294
|
-
--x-size-border-width-message-default: var(--x-size-border-width-base);
|
|
2295
|
-
--x-size-border-width-top-message-default: var(--x-size-border-width-message-default);
|
|
2296
|
-
--x-size-border-width-right-message-default: var(--x-size-border-width-message-default);
|
|
2297
|
-
--x-size-border-width-bottom-message-default: var(--x-size-border-width-message-default);
|
|
2298
|
-
--x-size-border-width-left-message-default: var(--x-size-border-width-message-default);
|
|
2299
|
-
--x-font-family-message-default: var(--x-font-family-title3);
|
|
2300
|
-
--x-size-font-message-default: var(--x-size-font-title3);
|
|
2301
|
-
--x-number-font-weight-message-default: var(--x-number-font-weight-title3);
|
|
2302
|
-
}
|
|
2303
|
-
|
|
2304
|
-
[dir="ltr"] .x-message {
|
|
2305
|
-
border-left-width: var(--x-size-border-width-left-message-default);
|
|
2306
|
-
}
|
|
2307
|
-
|
|
2308
|
-
[dir="rtl"] .x-message {
|
|
2309
|
-
border-right-width: var(--x-size-border-width-left-message-default);
|
|
2310
|
-
}
|
|
2311
|
-
|
|
2312
|
-
[dir="ltr"] .x-message {
|
|
2313
|
-
border-right-width: var(--x-size-border-width-right-message-default);
|
|
2314
|
-
}
|
|
2315
|
-
|
|
2316
|
-
[dir="rtl"] .x-message {
|
|
2317
|
-
border-left-width: var(--x-size-border-width-right-message-default);
|
|
2318
|
-
}
|
|
2319
|
-
|
|
2320
|
-
.x-message {
|
|
2321
|
-
display: flex;
|
|
2322
|
-
flex-flow: column nowrap;
|
|
2323
|
-
justify-content: var(--x-string-justify-message-default);
|
|
2324
|
-
align-items: center;
|
|
2325
|
-
box-sizing: border-box;
|
|
2326
|
-
gap: var(--x-size-gap-message-default);
|
|
2327
|
-
padding: var(--x-size-padding-message-default);
|
|
2328
|
-
background-color: var(--x-color-background-message-default);
|
|
2329
|
-
border-color: var(--x-color-border-message-default);
|
|
2330
|
-
border-style: solid;
|
|
2331
|
-
border-top-width: var(--x-size-border-width-top-message-default);
|
|
2332
|
-
border-bottom-width: var(--x-size-border-width-bottom-message-default);
|
|
2333
|
-
border-radius: var(--x-size-border-radius-top-left-message-default) var(--x-size-border-radius-top-right-message-default) var(--x-size-border-radius-bottom-right-message-default) var(--x-size-border-radius-bottom-left-message-default);
|
|
2334
|
-
font-family: var(--x-font-family-message-default);
|
|
2335
|
-
font-size: var(--x-size-font-message-default);
|
|
2336
|
-
font-weight: var(--x-number-font-weight-message-default);
|
|
2337
|
-
}
|
|
2338
|
-
@media not all and (min-resolution: 0.001dpcm) {
|
|
2339
|
-
.x-message {
|
|
2340
|
-
gap: 0;
|
|
2341
|
-
}
|
|
2342
|
-
.x-message > *:not(:last-child) {
|
|
2343
|
-
margin-right: var(--x-size-gap-message-default);
|
|
2344
|
-
}
|
|
2345
|
-
}
|
|
2346
|
-
.x-message,
|
|
2347
|
-
.x-message > a {
|
|
2348
|
-
color: var(--x-color-text-message-default);
|
|
2349
|
-
}
|
|
2350
|
-
.x-message > p {
|
|
2351
|
-
margin: 0;
|
|
2352
|
-
}
|
|
2353
2282
|
/* @deprecated */
|
|
2354
2283
|
:root {
|
|
2355
2284
|
--x-size-padding-list-01: var(--x-size-base-01);
|
|
@@ -2690,6 +2619,77 @@
|
|
|
2690
2619
|
margin-right: var(--x-size-gap-list-13);
|
|
2691
2620
|
}
|
|
2692
2621
|
}
|
|
2622
|
+
:root {
|
|
2623
|
+
--x-string-justify-message-default: center;
|
|
2624
|
+
--x-size-gap-message-default: var(--x-size-base-03);
|
|
2625
|
+
--x-size-padding-message-default: var(--x-size-base-06);
|
|
2626
|
+
--x-color-background-message-default: var(--x-color-base-neutral-95);
|
|
2627
|
+
--x-color-border-message-default: var(--x-color-background-message-default);
|
|
2628
|
+
--x-color-text-message-default: var(--x-color-text-default);
|
|
2629
|
+
--x-size-border-radius-message-default: var(--x-size-border-radius-base-m);
|
|
2630
|
+
--x-size-border-radius-top-left-message-default: var(--x-size-border-radius-message-default);
|
|
2631
|
+
--x-size-border-radius-top-right-message-default: var(--x-size-border-radius-message-default);
|
|
2632
|
+
--x-size-border-radius-bottom-right-message-default: var(--x-size-border-radius-message-default);
|
|
2633
|
+
--x-size-border-radius-bottom-left-message-default: var(--x-size-border-radius-message-default);
|
|
2634
|
+
--x-size-border-width-message-default: var(--x-size-border-width-base);
|
|
2635
|
+
--x-size-border-width-top-message-default: var(--x-size-border-width-message-default);
|
|
2636
|
+
--x-size-border-width-right-message-default: var(--x-size-border-width-message-default);
|
|
2637
|
+
--x-size-border-width-bottom-message-default: var(--x-size-border-width-message-default);
|
|
2638
|
+
--x-size-border-width-left-message-default: var(--x-size-border-width-message-default);
|
|
2639
|
+
--x-font-family-message-default: var(--x-font-family-title3);
|
|
2640
|
+
--x-size-font-message-default: var(--x-size-font-title3);
|
|
2641
|
+
--x-number-font-weight-message-default: var(--x-number-font-weight-title3);
|
|
2642
|
+
}
|
|
2643
|
+
|
|
2644
|
+
[dir="ltr"] .x-message {
|
|
2645
|
+
border-left-width: var(--x-size-border-width-left-message-default);
|
|
2646
|
+
}
|
|
2647
|
+
|
|
2648
|
+
[dir="rtl"] .x-message {
|
|
2649
|
+
border-right-width: var(--x-size-border-width-left-message-default);
|
|
2650
|
+
}
|
|
2651
|
+
|
|
2652
|
+
[dir="ltr"] .x-message {
|
|
2653
|
+
border-right-width: var(--x-size-border-width-right-message-default);
|
|
2654
|
+
}
|
|
2655
|
+
|
|
2656
|
+
[dir="rtl"] .x-message {
|
|
2657
|
+
border-left-width: var(--x-size-border-width-right-message-default);
|
|
2658
|
+
}
|
|
2659
|
+
|
|
2660
|
+
.x-message {
|
|
2661
|
+
display: flex;
|
|
2662
|
+
flex-flow: column nowrap;
|
|
2663
|
+
justify-content: var(--x-string-justify-message-default);
|
|
2664
|
+
align-items: center;
|
|
2665
|
+
box-sizing: border-box;
|
|
2666
|
+
gap: var(--x-size-gap-message-default);
|
|
2667
|
+
padding: var(--x-size-padding-message-default);
|
|
2668
|
+
background-color: var(--x-color-background-message-default);
|
|
2669
|
+
border-color: var(--x-color-border-message-default);
|
|
2670
|
+
border-style: solid;
|
|
2671
|
+
border-top-width: var(--x-size-border-width-top-message-default);
|
|
2672
|
+
border-bottom-width: var(--x-size-border-width-bottom-message-default);
|
|
2673
|
+
border-radius: var(--x-size-border-radius-top-left-message-default) var(--x-size-border-radius-top-right-message-default) var(--x-size-border-radius-bottom-right-message-default) var(--x-size-border-radius-bottom-left-message-default);
|
|
2674
|
+
font-family: var(--x-font-family-message-default);
|
|
2675
|
+
font-size: var(--x-size-font-message-default);
|
|
2676
|
+
font-weight: var(--x-number-font-weight-message-default);
|
|
2677
|
+
}
|
|
2678
|
+
@media not all and (min-resolution: 0.001dpcm) {
|
|
2679
|
+
.x-message {
|
|
2680
|
+
gap: 0;
|
|
2681
|
+
}
|
|
2682
|
+
.x-message > *:not(:last-child) {
|
|
2683
|
+
margin-right: var(--x-size-gap-message-default);
|
|
2684
|
+
}
|
|
2685
|
+
}
|
|
2686
|
+
.x-message,
|
|
2687
|
+
.x-message > a {
|
|
2688
|
+
color: var(--x-color-text-message-default);
|
|
2689
|
+
}
|
|
2690
|
+
.x-message > p {
|
|
2691
|
+
margin: 0;
|
|
2692
|
+
}
|
|
2693
2693
|
:root {
|
|
2694
2694
|
--x-modal-overlay-color: rgb(0, 0, 0);
|
|
2695
2695
|
--x-modal-overlay-opacity: 0.7;
|
|
@@ -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
|
-
|
|
@@ -17,6 +17,6 @@ export default class BaseHeaderTogglePanel extends Vue
|
|
|
17
17
|
|
|
18
18
|
| Property | Modifiers | Type | Description |
|
|
19
19
|
| --- | --- | --- | --- |
|
|
20
|
-
| [animation](./x-components.baseheadertogglepanel.animation.md) | <code>protected</code> |
|
|
20
|
+
| [animation](./x-components.baseheadertogglepanel.animation.md) | <code>protected</code> | typeof [AnimationProp](./x-components.animationprop.md) | Animation component that will be used to animate the base-toggle-panel. |
|
|
21
21
|
| [startCollapsed](./x-components.baseheadertogglepanel.startcollapsed.md) | <code>protected</code> | boolean | Handles if the panel is open by default. |
|
|
22
22
|
|
|
@@ -2,31 +2,56 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BasePriceFilterLabel](./x-components.basepricefilterlabel.md)
|
|
4
4
|
|
|
5
|
-
## BasePriceFilterLabel
|
|
5
|
+
## BasePriceFilterLabel variable
|
|
6
6
|
|
|
7
7
|
Renders a label for a price filter, allowing to select different messages depending on the value of the filter.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
_default: import("vue").DefineComponent<{
|
|
13
|
+
filter: {
|
|
14
|
+
type: PropType<{
|
|
15
|
+
range: RangeValue;
|
|
16
|
+
}>;
|
|
17
|
+
required: true;
|
|
18
|
+
};
|
|
19
|
+
format: {
|
|
20
|
+
type: StringConstructor;
|
|
21
|
+
};
|
|
22
|
+
lessThan: {
|
|
23
|
+
type: StringConstructor;
|
|
24
|
+
required: true;
|
|
25
|
+
};
|
|
26
|
+
fromTo: {
|
|
27
|
+
type: StringConstructor;
|
|
28
|
+
required: true;
|
|
29
|
+
};
|
|
30
|
+
from: {
|
|
31
|
+
type: StringConstructor;
|
|
32
|
+
required: true;
|
|
33
|
+
};
|
|
34
|
+
}, () => VNode, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
|
|
35
|
+
filter: {
|
|
36
|
+
type: PropType<{
|
|
37
|
+
range: RangeValue;
|
|
38
|
+
}>;
|
|
39
|
+
required: true;
|
|
40
|
+
};
|
|
41
|
+
format: {
|
|
42
|
+
type: StringConstructor;
|
|
43
|
+
};
|
|
44
|
+
lessThan: {
|
|
45
|
+
type: StringConstructor;
|
|
46
|
+
required: true;
|
|
47
|
+
};
|
|
48
|
+
fromTo: {
|
|
49
|
+
type: StringConstructor;
|
|
50
|
+
required: true;
|
|
51
|
+
};
|
|
52
|
+
from: {
|
|
53
|
+
type: StringConstructor;
|
|
54
|
+
required: true;
|
|
55
|
+
};
|
|
56
|
+
}>>, {}>
|
|
13
57
|
```
|
|
14
|
-
**Extends:** Vue
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
| Property | Modifiers | Type | Description |
|
|
19
|
-
| --- | --- | --- | --- |
|
|
20
|
-
| [filter](./x-components.basepricefilterlabel.filter.md) | | { range: RangeValue; } | The filter data for get min and max value. |
|
|
21
|
-
| [format?](./x-components.basepricefilterlabel.format.md) | | string | _(Optional)_ Configuration for show the label. |
|
|
22
|
-
| [from](./x-components.basepricefilterlabel.from.md) | | string | Message shown when the filter hasn't got max value defined. |
|
|
23
|
-
| [fromTo](./x-components.basepricefilterlabel.fromto.md) | | string | Message shown when the filter has both the min and max values defined. |
|
|
24
|
-
| [label](./x-components.basepricefilterlabel.label.md) | <p><code>protected</code></p><p><code>readonly</code></p> | string | The active label, retrieved from the provided props. It depends on the min and max values of the filter. |
|
|
25
|
-
| [lessThan](./x-components.basepricefilterlabel.lessthan.md) | | string | Message shown when the filter hasn't got the min value defined. |
|
|
26
|
-
|
|
27
|
-
## Methods
|
|
28
|
-
|
|
29
|
-
| Method | Modifiers | Description |
|
|
30
|
-
| --- | --- | --- |
|
|
31
|
-
| [render(createElement)](./x-components.basepricefilterlabel.render.md) | | |
|
|
32
|
-
|
|
@@ -2,21 +2,34 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseRatingFilterLabel](./x-components.baseratingfilterlabel.md)
|
|
4
4
|
|
|
5
|
-
## BaseRatingFilterLabel
|
|
5
|
+
## BaseRatingFilterLabel variable
|
|
6
6
|
|
|
7
7
|
Renders a label for a rating filter, allowing to override the elements used to paint the rating.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
_default: import("vue").DefineComponent<{
|
|
13
|
+
filter: {
|
|
14
|
+
type: PropType<BooleanFilter>;
|
|
15
|
+
required: true;
|
|
16
|
+
};
|
|
17
|
+
max: {
|
|
18
|
+
type: NumberConstructor;
|
|
19
|
+
default: number;
|
|
20
|
+
};
|
|
21
|
+
}, {
|
|
22
|
+
value: import("vue").ComputedRef<number>;
|
|
23
|
+
}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
|
|
24
|
+
filter: {
|
|
25
|
+
type: PropType<BooleanFilter>;
|
|
26
|
+
required: true;
|
|
27
|
+
};
|
|
28
|
+
max: {
|
|
29
|
+
type: NumberConstructor;
|
|
30
|
+
default: number;
|
|
31
|
+
};
|
|
32
|
+
}>>, {
|
|
33
|
+
max: number;
|
|
34
|
+
}>
|
|
13
35
|
```
|
|
14
|
-
**Extends:** Vue
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
| Property | Modifiers | Type | Description |
|
|
19
|
-
| --- | --- | --- | --- |
|
|
20
|
-
| [filter](./x-components.baseratingfilterlabel.filter.md) | | BooleanFilter | The filter data to render. |
|
|
21
|
-
| [max](./x-components.baseratingfilterlabel.max.md) | <code>protected</code> | number | Maximum number of elements to paint. |
|
|
22
|
-
|
|
@@ -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,21 +2,34 @@
|
|
|
2
2
|
|
|
3
3
|
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseTogglePanel](./x-components.basetogglepanel.md)
|
|
4
4
|
|
|
5
|
-
## BaseTogglePanel
|
|
5
|
+
## BaseTogglePanel variable
|
|
6
6
|
|
|
7
7
|
Simple panel that receives its open state via prop, which is responsible of rendering default slot inside a configurable transition.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
|
|
12
|
+
_default: import("vue").DefineComponent<{
|
|
13
|
+
open: {
|
|
14
|
+
type: BooleanConstructor;
|
|
15
|
+
required: true;
|
|
16
|
+
};
|
|
17
|
+
animation: {
|
|
18
|
+
type: import("vue").PropType<string | import("vue").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: string;
|
|
20
|
+
};
|
|
21
|
+
}, {}, {}, {}, {}, import("vue/types/v3-component-options").ComponentOptionsMixin, import("vue/types/v3-component-options").ComponentOptionsMixin, {}, string, Readonly<import("vue").ExtractPropTypes<{
|
|
22
|
+
open: {
|
|
23
|
+
type: BooleanConstructor;
|
|
24
|
+
required: true;
|
|
25
|
+
};
|
|
26
|
+
animation: {
|
|
27
|
+
type: import("vue").PropType<string | import("vue").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<{}>>, {}>>;
|
|
28
|
+
default: string;
|
|
29
|
+
};
|
|
30
|
+
}>>, {
|
|
31
|
+
animation: string | import("vue").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, {}> & {
|
|
32
|
+
props: {};
|
|
33
|
+
});
|
|
34
|
+
}>
|
|
13
35
|
```
|
|
14
|
-
**Extends:** Vue
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
| Property | Modifiers | Type | Description |
|
|
19
|
-
| --- | --- | --- | --- |
|
|
20
|
-
| [animation](./x-components.basetogglepanel.animation.md) | <code>protected</code> | Vue \| string | Animation component that will be used to animate the panel content. |
|
|
21
|
-
| [open](./x-components.basetogglepanel.open.md) | <code>protected</code> | boolean | Handles if the panel is rendered. It is used with v-if instead of v-show to get better performance. |
|
|
22
|
-
|