@empathyco/x-components 3.0.0-alpha.34 → 3.0.0-alpha.35
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 +52 -0
- package/core/index.js +23 -22
- package/core/index.js.map +1 -1
- package/docs/API-reference/api/x-components.baseidtogglepanel.md +0 -1
- package/docs/API-reference/api/x-components.baseresultlink.md +1 -1
- package/docs/API-reference/api/x-components.fixedheaderandasideslayout.isbackdropvisible.md +11 -0
- package/docs/API-reference/api/x-components.fixedheaderandasideslayout.leftasideanimation.md +11 -0
- package/docs/API-reference/api/x-components.fixedheaderandasideslayout.md +30 -0
- package/docs/API-reference/api/x-components.fixedheaderandasideslayout.rightasideanimation.md +11 -0
- package/docs/API-reference/api/x-components.fixedheaderandasideslayout.scrollposition.md +11 -0
- package/docs/API-reference/api/x-components.fixedheaderandasideslayout.setposition.md +22 -0
- package/docs/API-reference/api/x-components.getrootxcomponent.md +2 -2
- package/docs/API-reference/api/x-components.isxcomponent.md +2 -2
- package/docs/API-reference/api/x-components.maybearray.md +13 -0
- package/docs/API-reference/api/x-components.md +11 -7
- package/docs/API-reference/api/x-components.namespaceddebounce.md +2 -2
- package/docs/API-reference/api/x-components.namespacedthrottle.md +2 -2
- package/docs/API-reference/api/{x-components.namespacedtimeretrieving.md → x-components.namespacedtimeselector.md} +3 -3
- package/docs/API-reference/api/x-components.namespacedtimewireoperator.md +3 -3
- package/docs/API-reference/api/x-components.searchxevents.md +2 -0
- package/docs/API-reference/api/x-components.searchxevents.userclickedabanner.md +13 -0
- package/docs/API-reference/api/x-components.searchxevents.userclickedapromoted.md +13 -0
- package/docs/API-reference/api/x-components.setconsent.md +1 -1
- package/docs/API-reference/api/x-components.setquerytaggingdebounce.md +1 -1
- package/docs/API-reference/api/x-components.setsessionduration.md +1 -1
- package/docs/API-reference/api/x-components.throttle.md +3 -3
- package/docs/API-reference/api/x-components.timedwireoperatoroptions.cancelon.md +13 -0
- package/docs/API-reference/api/x-components.timedwireoperatoroptions.forceon.md +13 -0
- package/docs/API-reference/api/x-components.timedwireoperatoroptions.md +21 -0
- package/docs/API-reference/api/{x-components.timeretrieving.md → x-components.timeselector.md} +3 -3
- package/docs/API-reference/api/x-components.trackaddtocartwire.md +13 -0
- package/docs/API-reference/api/{x-components.trackwire.md → x-components.trackquerywire.md} +3 -3
- package/docs/API-reference/api/x-components.trackresultclickedwire.md +13 -0
- package/docs/API-reference/api/x-components.xeventstypes.md +0 -1
- package/docs/API-reference/api/x-components.xinstaller.md +1 -1
- package/docs/API-reference/components/common/animations/x-components.animate-width.md +1 -1
- package/docs/API-reference/components/common/animations/x-components.collapse-from-top.md +1 -1
- package/docs/API-reference/components/common/animations/x-components.collapse-height.md +1 -1
- package/docs/API-reference/components/common/animations/x-components.collapse-width.md +1 -1
- package/docs/API-reference/components/common/animations/x-components.cross-fade.md +1 -1
- package/docs/API-reference/components/common/animations/x-components.fade-and-slide.md +1 -1
- package/docs/API-reference/components/common/{x-components.staggering-transition-group.md → animations/x-components.staggering-transition-group.md} +2 -2
- package/docs/API-reference/components/common/animations/x-components.translate-from-left.md +1 -1
- package/docs/API-reference/components/common/animations/x-components.translate-from-right.md +1 -1
- package/docs/API-reference/components/common/column-picker/x-components.base-column-picker-dropdown.md +5 -5
- package/docs/API-reference/components/common/column-picker/x-components.base-column-picker-list.md +5 -5
- package/docs/API-reference/components/common/currency/x-components.base-currency.md +2 -4
- package/docs/API-reference/components/common/filters/labels/x-components.base-price-filter-label.md +2 -2
- package/docs/API-reference/components/common/filters/labels/x-components.base-rating-filter-label.md +4 -4
- package/docs/API-reference/components/common/layouts/x-components.fixed-header-and-asides-layout.md +2 -2
- package/docs/API-reference/components/common/layouts/x-components.multi-column-max-width-layout.md +2 -2
- package/docs/API-reference/components/common/modals/x-components.base-events-modal-close.md +3 -3
- package/docs/API-reference/components/common/modals/x-components.base-events-modal-open.md +3 -3
- package/docs/API-reference/components/common/modals/x-components.base-events-modal.md +3 -3
- package/docs/API-reference/components/common/modals/x-components.base-id-modal-close.md +2 -2
- package/docs/API-reference/components/common/modals/x-components.base-id-modal-open.md +2 -2
- package/docs/API-reference/components/common/modals/x-components.base-id-modal.md +2 -2
- package/docs/API-reference/components/common/modals/x-components.base-modal.md +1 -1
- package/docs/API-reference/components/common/panels/x-components.base-header-toggle-panel.md +4 -4
- package/docs/API-reference/components/common/panels/x-components.base-id-toggle-panel-button.md +2 -2
- package/docs/API-reference/components/common/panels/x-components.base-id-toggle-panel.md +2 -2
- package/docs/API-reference/components/common/panels/x-components.base-toggle-panel.md +2 -2
- package/docs/API-reference/components/common/result/x-components.base-result-add-to-cart.md +2 -2
- package/docs/API-reference/components/common/result/x-components.base-result-current-price.md +3 -3
- package/docs/API-reference/components/common/result/x-components.base-result-image.md +3 -3
- package/docs/API-reference/components/common/result/x-components.base-result-link.md +11 -19
- package/docs/API-reference/components/common/result/x-components.base-result-previous-price.md +3 -3
- package/docs/API-reference/components/common/scroll/x-components.base-scroll.md +2 -2
- package/docs/API-reference/components/common/suggestions/x-components.base-suggestion.md +3 -3
- package/docs/API-reference/components/common/suggestions/x-components.base-suggestions.md +1 -1
- package/docs/API-reference/components/common/x-components.base-dropdown.md +1 -1
- package/docs/API-reference/components/common/x-components.base-event-button.md +2 -2
- package/docs/API-reference/components/common/x-components.base-grid.md +4 -4
- package/docs/API-reference/components/common/x-components.base-keyboard-navigation.md +4 -4
- package/docs/API-reference/components/common/x-components.base-rating.md +3 -3
- package/docs/API-reference/components/common/x-components.base-variable-column-grid.md +1 -1
- package/docs/API-reference/components/common/x-components.sliding-panel.md +4 -4
- package/docs/API-reference/components/empathize/x-components.empathize.md +2 -2
- package/docs/API-reference/components/extra-params/x-components.renderless-extra-param.md +2 -2
- package/docs/API-reference/components/facets/x-components.clear-filters.md +3 -3
- package/docs/API-reference/components/facets/x-components.facets/facets-provider.md +1 -1
- package/docs/API-reference/components/facets/x-components.facets/facets.md +6 -6
- package/docs/API-reference/components/facets/x-components.filters/all-filter.md +5 -5
- package/docs/API-reference/components/facets/x-components.filters/base-filter.md +4 -4
- package/docs/API-reference/components/facets/x-components.filters/editable-number-range-filter.md +5 -5
- package/docs/API-reference/components/facets/x-components.filters/hierarchical-filter.md +4 -4
- package/docs/API-reference/components/facets/x-components.filters/number-range-filter.md +3 -3
- package/docs/API-reference/components/facets/x-components.filters/renderless-filter.md +3 -3
- package/docs/API-reference/components/facets/x-components.filters/simple-filter.md +4 -4
- package/docs/API-reference/components/facets/x-components.lists/exclude-filters-with-no-results.md +3 -3
- package/docs/API-reference/components/facets/x-components.lists/filters-list.md +3 -3
- package/docs/API-reference/components/facets/x-components.lists/filters-search.md +3 -3
- package/docs/API-reference/components/facets/x-components.lists/selected-filters-list.md +5 -5
- package/docs/API-reference/components/facets/x-components.lists/selected-filters.md +4 -4
- package/docs/API-reference/components/facets/x-components.lists/sliced-filters.md +3 -3
- package/docs/API-reference/components/facets/x-components.lists/sorted-filters.md +5 -5
- package/docs/API-reference/components/history-queries/x-components.clear-history-queries.md +2 -2
- package/docs/API-reference/components/history-queries/x-components.history-queries.md +4 -4
- package/docs/API-reference/components/history-queries/x-components.history-query.md +3 -3
- package/docs/API-reference/components/history-queries/x-components.remove-history-query.md +2 -2
- package/docs/API-reference/components/identifier-results/x-components.identifier-result.md +2 -2
- package/docs/API-reference/components/identifier-results/x-components.identifier-results.md +2 -2
- package/docs/API-reference/components/next-queries/x-components.next-queries.md +4 -4
- package/docs/API-reference/components/next-queries/x-components.next-query.md +3 -3
- package/docs/API-reference/components/popular-searches/x-components.popular-search.md +3 -3
- package/docs/API-reference/components/popular-searches/x-components.popular-searches.md +4 -4
- package/docs/API-reference/components/recommendations/x-components.recommendations.md +4 -4
- package/docs/API-reference/components/scroll/x-components.scroll-to-top.md +2 -2
- package/docs/API-reference/components/scroll/x-components.scroll.md +18 -22
- package/docs/API-reference/components/scroll/x-components.window-scroll.md +5 -7
- package/docs/API-reference/components/search/x-components.partial-query-button.md +3 -3
- package/docs/API-reference/components/search/x-components.partial-results-list.md +4 -4
- package/docs/API-reference/components/search/x-components.redirection.md +1 -1
- package/docs/API-reference/components/search/x-components.sort-dropdown.md +1 -1
- package/docs/API-reference/components/search/x-components.sort-list.md +1 -1
- package/docs/API-reference/components/search/x-components.spellcheck-button.md +3 -3
- package/docs/API-reference/components/search/x-components.spellcheck.md +3 -3
- package/docs/build-search-ui/web-archetype-development-guide.md +178 -0
- package/docs/build-search-ui/web-archetype-integration-guide.md +146 -138
- package/docs/build-search-ui/web-x-components-integration-guide.md +3 -3
- package/js/components/animations/animate-width.vue.js +2 -2
- package/js/components/animations/animate-width.vue.js.map +1 -1
- package/js/components/animations/collapse-from-top.vue.js +2 -2
- package/js/components/animations/collapse-from-top.vue.js.map +1 -1
- package/js/components/animations/collapse-height.vue.js +2 -2
- package/js/components/animations/collapse-height.vue.js.map +1 -1
- package/js/components/animations/collapse-width.vue.js +2 -2
- package/js/components/animations/collapse-width.vue.js.map +1 -1
- package/js/components/animations/cross-fade.vue.js +2 -2
- package/js/components/animations/cross-fade.vue.js.map +1 -1
- package/js/components/animations/fade-and-slide.vue.js +2 -2
- package/js/components/animations/fade-and-slide.vue.js.map +1 -1
- package/js/components/animations/staggered-fade-and-slide.vue.js +2 -2
- package/js/components/animations/staggered-fade-and-slide.vue.js.map +1 -1
- package/js/components/animations/staggered-fade-and-slide.vue_rollup-plugin-vue=script.js +1 -1
- package/js/components/animations/staggered-fade-and-slide.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/components/{staggering-transition-group.vue.js → animations/staggering-transition-group.vue.js} +2 -2
- package/js/components/animations/staggering-transition-group.vue.js.map +1 -0
- package/js/components/{staggering-transition-group.vue_rollup-plugin-vue=script.js → animations/staggering-transition-group.vue_rollup-plugin-vue=script.js} +17 -17
- package/js/components/animations/staggering-transition-group.vue_rollup-plugin-vue=script.js.map +1 -0
- package/js/components/animations/translate-from-left.vue.js +2 -2
- package/js/components/animations/translate-from-left.vue.js.map +1 -1
- package/js/components/animations/translate-from-right.vue.js +2 -2
- package/js/components/animations/translate-from-right.vue.js.map +1 -1
- package/js/components/base-dropdown.vue.js +2 -2
- package/js/components/base-dropdown.vue.js.map +1 -1
- package/js/components/base-event-button.vue.js.map +1 -1
- package/js/components/base-grid.vue.js +2 -2
- package/js/components/base-grid.vue.js.map +1 -1
- package/js/components/base-keyboard-navigation.vue.js.map +1 -1
- package/js/components/base-rating.vue.js +2 -2
- package/js/components/base-rating.vue.js.map +1 -1
- package/js/components/base-variable-column-grid.vue.js.map +1 -1
- package/js/components/column-picker/base-column-picker-dropdown.vue.js.map +1 -1
- package/js/components/column-picker/base-column-picker-list.vue.js +2 -2
- package/js/components/column-picker/base-column-picker-list.vue.js.map +1 -1
- package/js/components/currency/base-currency.vue.js.map +1 -1
- package/js/components/filters/labels/base-price-filter-label.vue.js.map +1 -1
- package/js/components/filters/labels/base-rating-filter-label.vue.js.map +1 -1
- package/js/components/global-x-bus.vue.js.map +1 -1
- package/js/components/global-x-bus.vue_rollup-plugin-vue=script.js +2 -1
- package/js/components/global-x-bus.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/components/layouts/fixed-header-and-asides-layout.vue.js +212 -0
- package/js/components/layouts/fixed-header-and-asides-layout.vue.js.map +1 -0
- package/js/components/layouts/fixed-header-and-asides-layout.vue_rollup-plugin-vue=script.js +57 -0
- package/js/components/layouts/fixed-header-and-asides-layout.vue_rollup-plugin-vue=script.js.map +1 -0
- package/js/components/layouts/multi-column-max-width-layout.vue.js +3 -3
- package/js/components/layouts/multi-column-max-width-layout.vue.js.map +1 -1
- package/js/components/layouts/multi-column-max-width-layout.vue_rollup-plugin-vue=script.js +1 -1
- package/js/components/layouts/single-column-layout.vue_rollup-plugin-vue=script.js +1 -1
- package/js/components/modals/base-events-modal-close.vue.js.map +1 -1
- package/js/components/modals/base-events-modal-open.vue.js.map +1 -1
- package/js/components/modals/base-events-modal.vue.js.map +1 -1
- package/js/components/modals/base-id-modal-close.vue.js.map +1 -1
- package/js/components/modals/base-id-modal-open.vue.js.map +1 -1
- package/js/components/modals/base-id-modal.vue.js.map +1 -1
- package/js/components/modals/base-modal.vue.js +2 -2
- package/js/components/modals/base-modal.vue.js.map +1 -1
- package/js/components/panels/base-header-toggle-panel.vue.js +2 -2
- package/js/components/panels/base-header-toggle-panel.vue.js.map +1 -1
- package/js/components/panels/base-id-toggle-panel-button.vue.js.map +1 -1
- package/js/components/panels/base-id-toggle-panel.vue.js.map +1 -1
- package/js/components/panels/base-id-toggle-panel.vue_rollup-plugin-vue=script.js +4 -9
- package/js/components/panels/base-id-toggle-panel.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/components/panels/base-toggle-panel.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-current-price.vue.js.map +1 -1
- package/js/components/result/base-result-image.vue.js +2 -2
- package/js/components/result/base-result-image.vue.js.map +1 -1
- package/js/components/result/base-result-link.vue.js +5 -5
- package/js/components/result/base-result-link.vue.js.map +1 -1
- package/js/components/result/base-result-link.vue_rollup-plugin-vue=script.js +3 -12
- package/js/components/result/base-result-link.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/components/result/base-result-previous-price.vue.js.map +1 -1
- package/js/components/scroll/base-scroll.vue.js +2 -2
- package/js/components/scroll/base-scroll.vue.js.map +1 -1
- package/js/components/sliding-panel.vue.js +2 -2
- package/js/components/sliding-panel.vue.js.map +1 -1
- package/js/components/suggestions/base-suggestion.vue.js.map +1 -1
- package/js/components/suggestions/base-suggestions.vue.js +2 -2
- package/js/components/suggestions/base-suggestions.vue.js.map +1 -1
- package/js/components/x-component.mixin.js +1 -4
- package/js/components/x-component.mixin.js.map +1 -1
- package/js/components/x-component.utils.js +4 -20
- package/js/components/x-component.utils.js.map +1 -1
- package/js/index.js +31 -30
- package/js/index.js.map +1 -1
- package/js/plugins/x-plugin.alias.js +21 -20
- package/js/plugins/x-plugin.alias.js.map +1 -1
- package/js/plugins/x-plugin.mixin.js +2 -2
- package/js/plugins/x-plugin.mixin.js.map +1 -1
- package/js/wiring/namespaced-wires.operators.js +3 -4
- package/js/wiring/namespaced-wires.operators.js.map +1 -1
- package/js/wiring/wires-operators.utils.js +55 -0
- package/js/wiring/wires-operators.utils.js.map +1 -0
- package/js/wiring/wires.operators.js +17 -12
- package/js/wiring/wires.operators.js.map +1 -1
- package/js/x-installer/x-installer/x-installer.js +1 -1
- package/js/x-installer/x-installer/x-installer.js.map +1 -1
- package/js/x-modules/empathize/components/empathize.vue.js.map +1 -1
- package/js/x-modules/empathize/components/empathize.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/extra-params/components/extra-params.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/extra-params/components/extra-params.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/extra-params/components/renderless-extra-param.vue.js.map +1 -1
- package/js/x-modules/extra-params/components/renderless-extra-param.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/extra-params/components/renderless-extra-param.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/extra-params/components/snippet-config-extra-params.vue.js.map +1 -1
- package/js/x-modules/extra-params/components/snippet-config-extra-params.vue_rollup-plugin-vue=script.js +22 -12
- package/js/x-modules/extra-params/components/snippet-config-extra-params.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/clear-filters.vue.js.map +1 -1
- package/js/x-modules/facets/components/clear-filters.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/clear-filters.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/facets/facets-provider.vue.js +2 -2
- package/js/x-modules/facets/components/facets/facets-provider.vue.js.map +1 -1
- package/js/x-modules/facets/components/facets/facets-provider.vue_rollup-plugin-vue=script.js +17 -23
- package/js/x-modules/facets/components/facets/facets-provider.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/facets/facets.vue.js +2 -2
- package/js/x-modules/facets/components/facets/facets.vue.js.map +1 -1
- package/js/x-modules/facets/components/filters/all-filter.vue.js.map +1 -1
- package/js/x-modules/facets/components/filters/all-filter.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/filters/all-filter.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/filters/base-filter.vue.js.map +1 -1
- package/js/x-modules/facets/components/filters/base-filter.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/filters/base-filter.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/filters/editable-number-range-filter.vue.js +1 -1
- package/js/x-modules/facets/components/filters/editable-number-range-filter.vue.js.map +1 -1
- package/js/x-modules/facets/components/filters/hierarchical-filter.vue.js.map +1 -1
- package/js/x-modules/facets/components/filters/hierarchical-filter.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/filters/hierarchical-filter.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/filters/number-range-filter.vue.js.map +1 -1
- package/js/x-modules/facets/components/filters/number-range-filter.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/filters/number-range-filter.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/filters/renderless-filter.vue.js.map +1 -1
- package/js/x-modules/facets/components/filters/renderless-filter.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/filters/renderless-filter.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/filters/simple-filter.vue.js.map +1 -1
- package/js/x-modules/facets/components/filters/simple-filter.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/filters/simple-filter.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/lists/exclude-filters-with-no-results.vue.js.map +1 -1
- package/js/x-modules/facets/components/lists/exclude-filters-with-no-results.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/lists/exclude-filters-with-no-results.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/lists/filters-list.vue.js +2 -2
- package/js/x-modules/facets/components/lists/filters-list.vue.js.map +1 -1
- package/js/x-modules/facets/components/lists/filters-list.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/lists/filters-list.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/lists/filters-search.vue.js +2 -2
- package/js/x-modules/facets/components/lists/filters-search.vue.js.map +1 -1
- package/js/x-modules/facets/components/lists/filters-search.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/lists/filters-search.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/lists/selected-filters-list.vue.js.map +1 -1
- package/js/x-modules/facets/components/lists/selected-filters.vue.js.map +1 -1
- package/js/x-modules/facets/components/lists/selected-filters.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/lists/selected-filters.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/lists/sliced-filters.vue.js.map +1 -1
- package/js/x-modules/facets/components/lists/sliced-filters.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/lists/sliced-filters.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/facets/components/lists/sorted-filters.vue.js.map +1 -1
- package/js/x-modules/facets/components/lists/sorted-filters.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/facets/components/lists/sorted-filters.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/history-queries/components/clear-history-queries.vue.js.map +1 -1
- package/js/x-modules/history-queries/components/history-queries.vue.js.map +1 -1
- package/js/x-modules/history-queries/components/history-queries.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/history-queries/components/history-query.vue.js.map +1 -1
- package/js/x-modules/history-queries/components/history-query.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/history-queries/components/remove-history-query.vue.js.map +1 -1
- package/js/x-modules/history-queries/wiring.js +1 -1
- package/js/x-modules/history-queries/wiring.js.map +1 -1
- package/js/x-modules/identifier-results/components/identifier-result.vue.js.map +1 -1
- package/js/x-modules/identifier-results/components/identifier-results.vue.js.map +1 -1
- package/js/x-modules/identifier-results/wiring.js +1 -1
- package/js/x-modules/identifier-results/wiring.js.map +1 -1
- package/js/x-modules/next-queries/components/next-queries-list.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/next-queries/components/next-queries.vue.js.map +1 -1
- package/js/x-modules/next-queries/components/next-queries.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/next-queries/components/next-query.vue.js.map +1 -1
- package/js/x-modules/next-queries/components/next-query.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/popular-searches/components/popular-search.vue.js.map +1 -1
- package/js/x-modules/popular-searches/components/popular-search.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/popular-searches/components/popular-searches.vue.js.map +1 -1
- package/js/x-modules/popular-searches/components/popular-searches.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/query-suggestions/components/query-suggestion.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/query-suggestions/components/query-suggestions.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/query-suggestions/wiring.js +1 -1
- package/js/x-modules/query-suggestions/wiring.js.map +1 -1
- package/js/x-modules/recommendations/components/recommendations.vue.js +2 -2
- package/js/x-modules/recommendations/components/recommendations.vue.js.map +1 -1
- package/js/x-modules/scroll/components/main-scroll-item.vue_rollup-plugin-vue=script.js +15 -14
- package/js/x-modules/scroll/components/main-scroll-item.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/scroll/components/scroll-to-top.vue.js.map +1 -1
- package/js/x-modules/scroll/components/scroll-to-top.vue_rollup-plugin-vue=script.js +15 -14
- package/js/x-modules/scroll/components/scroll-to-top.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/scroll/components/scroll.vue.js.map +1 -1
- package/js/x-modules/scroll/components/scroll.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/scroll/components/window-scroll.vue.js.map +1 -1
- package/js/x-modules/scroll/components/window-scroll.vue_rollup-plugin-vue=script.js +15 -14
- package/js/x-modules/scroll/components/window-scroll.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/search/components/banner.vue.js +2 -1
- package/js/x-modules/search/components/banner.vue.js.map +1 -1
- package/js/x-modules/search/components/banner.vue_rollup-plugin-vue=script.js +8 -0
- package/js/x-modules/search/components/banner.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/search/components/banners-list.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/search/components/partial-query-button.vue.js.map +1 -1
- package/js/x-modules/search/components/partial-results-list.vue.js +2 -2
- package/js/x-modules/search/components/partial-results-list.vue.js.map +1 -1
- package/js/x-modules/search/components/promoted.vue.js +2 -1
- package/js/x-modules/search/components/promoted.vue.js.map +1 -1
- package/js/x-modules/search/components/promoted.vue_rollup-plugin-vue=script.js +8 -0
- package/js/x-modules/search/components/promoted.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/search/components/promoteds-list.vue_rollup-plugin-vue=script.js +1 -1
- package/js/x-modules/search/components/redirection.vue.js.map +1 -1
- package/js/x-modules/search/components/redirection.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/search/components/results-list.vue_rollup-plugin-vue=script.js +2 -2
- package/js/x-modules/search/components/sort-dropdown.vue.js.map +1 -1
- package/js/x-modules/search/components/sort-list.vue.js +2 -2
- package/js/x-modules/search/components/sort-list.vue.js.map +1 -1
- package/js/x-modules/search/components/sort-list.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/search/components/sort-list.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/search/components/sort.mixin.js +13 -12
- package/js/x-modules/search/components/sort.mixin.js.map +1 -1
- package/js/x-modules/search/components/spellcheck-button.vue.js.map +1 -1
- package/js/x-modules/search/components/spellcheck.vue.js.map +1 -1
- package/js/x-modules/search/components/spellcheck.vue_rollup-plugin-vue=script.js +13 -12
- package/js/x-modules/search/components/spellcheck.vue_rollup-plugin-vue=script.js.map +1 -1
- package/js/x-modules/tagging/store/actions/track.action.js +2 -2
- package/js/x-modules/tagging/store/actions/track.action.js.map +1 -1
- package/js/x-modules/tagging/wiring.js +48 -4
- package/js/x-modules/tagging/wiring.js.map +1 -1
- package/package.json +7 -7
- package/report/tsdoc-metadata.json +1 -1
- package/report/x-adapter.api.json +1 -1
- package/report/x-components.api.json +572 -222
- package/report/x-components.api.md +60 -33
- package/report/x-types.api.json +1 -1
- package/tagging/index.js +1 -1
- package/types/adapter/mocked-adapter.d.ts.map +1 -1
- package/types/components/animations/index.d.ts +1 -0
- package/types/components/animations/index.d.ts.map +1 -1
- package/types/components/{staggering-transition-group.vue.d.ts → animations/staggering-transition-group.vue.d.ts} +0 -0
- package/types/components/animations/staggering-transition-group.vue.d.ts.map +1 -0
- package/types/components/global-x-bus.vue.d.ts.map +1 -1
- package/types/components/index.d.ts +1 -4
- package/types/components/index.d.ts.map +1 -1
- package/types/components/layouts/fixed-header-and-asides-layout.vue.d.ts +17 -0
- package/types/components/layouts/fixed-header-and-asides-layout.vue.d.ts.map +1 -0
- package/types/components/layouts/index.d.ts +4 -0
- package/types/components/layouts/index.d.ts.map +1 -0
- package/types/components/panels/base-id-toggle-panel.vue.d.ts +0 -5
- package/types/components/panels/base-id-toggle-panel.vue.d.ts.map +1 -1
- package/types/components/result/base-result-link.vue.d.ts +3 -10
- package/types/components/result/base-result-link.vue.d.ts.map +1 -1
- package/types/components/x-component.mixin.d.ts.map +1 -1
- package/types/components/x-component.utils.d.ts +1 -16
- package/types/components/x-component.utils.d.ts.map +1 -1
- package/types/plugins/x-plugin.alias.d.ts +4 -6
- package/types/plugins/x-plugin.alias.d.ts.map +1 -1
- package/types/plugins/x-plugin.mixin.d.ts +13 -3
- package/types/plugins/x-plugin.mixin.d.ts.map +1 -1
- package/types/utils/types.d.ts +6 -0
- package/types/utils/types.d.ts.map +1 -1
- package/types/wiring/events.types.d.ts +0 -5
- package/types/wiring/events.types.d.ts.map +1 -1
- package/types/wiring/namespaced-wires.operators.d.ts +2 -3
- package/types/wiring/namespaced-wires.operators.d.ts.map +1 -1
- package/types/wiring/namespaced-wiring.types.d.ts +9 -10
- package/types/wiring/namespaced-wiring.types.d.ts.map +1 -1
- package/types/wiring/wires-operators.utils.d.ts +36 -0
- package/types/wiring/wires-operators.utils.d.ts.map +1 -0
- package/types/wiring/wires.operators.d.ts +5 -8
- package/types/wiring/wires.operators.d.ts.map +1 -1
- package/types/wiring/wiring.types.d.ts +17 -4
- package/types/wiring/wiring.types.d.ts.map +1 -1
- package/types/x-installer/x-installer/x-installer.d.ts +1 -1
- package/types/x-modules/extra-params/components/snippet-config-extra-params.vue.d.ts +6 -0
- package/types/x-modules/extra-params/components/snippet-config-extra-params.vue.d.ts.map +1 -1
- package/types/x-modules/facets/components/facets/facets-provider.vue.d.ts +0 -8
- package/types/x-modules/facets/components/facets/facets-provider.vue.d.ts.map +1 -1
- package/types/x-modules/history-queries/wiring.d.ts +1 -1
- package/types/x-modules/identifier-results/wiring.d.ts +1 -1
- package/types/x-modules/query-suggestions/wiring.d.ts +1 -1
- package/types/x-modules/search/components/banner.vue.d.ts +6 -0
- package/types/x-modules/search/components/banner.vue.d.ts.map +1 -1
- package/types/x-modules/search/components/promoted.vue.d.ts +6 -0
- package/types/x-modules/search/components/promoted.vue.d.ts.map +1 -1
- package/types/x-modules/search/components/redirection.vue.d.ts +1 -1
- package/types/x-modules/search/components/redirection.vue.d.ts.map +1 -1
- package/types/x-modules/search/events.types.d.ts +11 -1
- package/types/x-modules/search/events.types.d.ts.map +1 -1
- package/types/x-modules/tagging/wiring.d.ts +29 -9
- package/types/x-modules/tagging/wiring.d.ts.map +1 -1
- package/docs/API-reference/api/x-components.baseidtogglepanel.created.md +0 -17
- package/docs/API-reference/api/x-components.xcomponent.md +0 -15
- package/docs/API-reference/api/x-components.xeventstypes.userrightclickedaresult.md +0 -13
- package/js/components/staggering-transition-group.vue.js.map +0 -1
- package/js/components/staggering-transition-group.vue_rollup-plugin-vue=script.js.map +0 -1
- package/js/wiring/utils/wire-racing-handling.js +0 -108
- package/js/wiring/utils/wire-racing-handling.js.map +0 -1
- package/types/components/staggering-transition-group.vue.d.ts.map +0 -1
- package/types/components/x-component.types.d.ts +0 -19
- package/types/components/x-component.types.d.ts.map +0 -1
- package/types/wiring/utils/wire-racing-handling.d.ts +0 -27
- package/types/wiring/utils/wire-racing-handling.d.ts.map +0 -1
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { XModuleName } from '../x-modules/x-modules.types';
|
|
2
2
|
import { NamespacedTimeWireOperator } from './namespaced-wiring.types';
|
|
3
|
-
import { AnyWire } from './wiring.types';
|
|
4
3
|
/**
|
|
5
4
|
* Type safe debounce operator which creates a function which can only access the Module of
|
|
6
5
|
* the {@link https://vuex.vuejs.org/ | Vuex} Store passed as parameter.
|
|
@@ -12,7 +11,7 @@ import { AnyWire } from './wiring.types';
|
|
|
12
11
|
*
|
|
13
12
|
* @public
|
|
14
13
|
*/
|
|
15
|
-
export declare function namespacedDebounce<ModuleName extends XModuleName>(moduleName: ModuleName): NamespacedTimeWireOperator<ModuleName
|
|
14
|
+
export declare function namespacedDebounce<ModuleName extends XModuleName>(moduleName: ModuleName): NamespacedTimeWireOperator<ModuleName>;
|
|
16
15
|
/**
|
|
17
16
|
* Type safe throttle operator which creates a function which can only access the Module of
|
|
18
17
|
* the {@link https://vuex.vuejs.org/ | Vuex} Store passed as parameter.
|
|
@@ -24,5 +23,5 @@ export declare function namespacedDebounce<ModuleName extends XModuleName>(modul
|
|
|
24
23
|
*
|
|
25
24
|
* @public
|
|
26
25
|
*/
|
|
27
|
-
export declare function namespacedThrottle<ModuleName extends XModuleName>(moduleName: ModuleName): NamespacedTimeWireOperator<ModuleName
|
|
26
|
+
export declare function namespacedThrottle<ModuleName extends XModuleName>(moduleName: ModuleName): NamespacedTimeWireOperator<ModuleName>;
|
|
28
27
|
//# sourceMappingURL=namespaced-wires.operators.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"namespaced-wires.operators.d.ts","sourceRoot":"","sources":["../../../src/wiring/namespaced-wires.operators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;
|
|
1
|
+
{"version":3,"file":"namespaced-wires.operators.d.ts","sourceRoot":"","sources":["../../../src/wiring/namespaced-wires.operators.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC;AAIvE;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,SAAS,WAAW,EAC/D,UAAU,EAAE,UAAU,GACrB,0BAA0B,CAAC,UAAU,CAAC,CAExC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,SAAS,WAAW,EAC/D,UAAU,EAAE,UAAU,GACrB,0BAA0B,CAAC,UAAU,CAAC,CAExC"}
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { ActionNamesFor, ExtractActionPayload, ExtractActions, ExtractMutationPayload, ExtractMutations, ExtractPayload, MutationNamesFor, StoreModuleStateAndGetters } from '../store/store.types';
|
|
2
2
|
import { PropsWithType } from '../utils/types';
|
|
3
3
|
import { XModuleName, XModulesTree } from '../x-modules/x-modules.types';
|
|
4
|
-
import {
|
|
5
|
-
import { AnyWire, Wire, WireMetadata } from './wiring.types';
|
|
4
|
+
import { AnyWire, TimedWireOperatorOptions, Wire, WireMetadata } from './wiring.types';
|
|
6
5
|
/**
|
|
7
6
|
* Function type which receives the State and the Getters of the namespace {@link XStoreModule}
|
|
8
7
|
* to retrieve the time from there.
|
|
@@ -12,22 +11,22 @@ import { AnyWire, Wire, WireMetadata } from './wiring.types';
|
|
|
12
11
|
*
|
|
13
12
|
* @public
|
|
14
13
|
*/
|
|
15
|
-
export declare type
|
|
14
|
+
export declare type NamespacedTimeSelector<ModuleName extends XModuleName> = (storeModule: StoreModuleStateAndGetters<ModuleName>) => number;
|
|
16
15
|
/**
|
|
17
|
-
* Function type which receives the wire to modify and the {@link
|
|
16
|
+
* Function type which receives the wire to modify and the {@link NamespacedTimeSelector} to
|
|
18
17
|
* retrieve the time from the {@link XStoreModule}.
|
|
19
18
|
*
|
|
20
19
|
* @param ModuleName - The {@link XModuleName} of the module to create a namespaced
|
|
21
|
-
* {@link
|
|
20
|
+
* {@link NamespacedTimeSelector}.
|
|
22
21
|
* @param Wire - The wire which will be piped with a timing operator.
|
|
23
|
-
* @param
|
|
24
|
-
* {@link XStoreModule} to retrieve the time
|
|
25
|
-
* @param
|
|
26
|
-
*
|
|
22
|
+
* @param timeInMs - Function that receives the state and the getters of the given module
|
|
23
|
+
* {@link XStoreModule} to retrieve the time.
|
|
24
|
+
* @param options - Options to configure events that should make the planned wire execution happen
|
|
25
|
+
* immediately or be aborted.
|
|
27
26
|
*
|
|
28
27
|
* @public
|
|
29
28
|
*/
|
|
30
|
-
export declare type NamespacedTimeWireOperator<ModuleName extends XModuleName
|
|
29
|
+
export declare type NamespacedTimeWireOperator<ModuleName extends XModuleName> = <Payload>(wire: Wire<Payload>, timeInMs: NamespacedTimeSelector<ModuleName>, options?: TimedWireOperatorOptions) => Wire<Payload>;
|
|
31
30
|
/**
|
|
32
31
|
* Namespaced payload to commit a mutation. Either a function that receives the
|
|
33
32
|
* {@link StoreModuleStateAndGetters | module state and getters} and returns the payload for
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"namespaced-wiring.types.d.ts","sourceRoot":"","sources":["../../../src/wiring/namespaced-wiring.types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,0BAA0B,EAC3B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"namespaced-wiring.types.d.ts","sourceRoot":"","sources":["../../../src/wiring/namespaced-wiring.types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,oBAAoB,EACpB,cAAc,EACd,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,0BAA0B,EAC3B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACzE,OAAO,EAAE,OAAO,EAAE,wBAAwB,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEvF;;;;;;;;GAQG;AACH,oBAAY,sBAAsB,CAAC,UAAU,SAAS,WAAW,IAAI,CACnE,WAAW,EAAE,0BAA0B,CAAC,UAAU,CAAC,KAChD,MAAM,CAAC;AAEZ;;;;;;;;;;;;;GAaG;AACH,oBAAY,0BAA0B,CAAC,UAAU,SAAS,WAAW,IAAI,CAAC,OAAO,EAC/E,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EACnB,QAAQ,EAAE,sBAAsB,CAAC,UAAU,CAAC,EAC5C,OAAO,CAAC,EAAE,wBAAwB,KAC/B,IAAI,CAAC,OAAO,CAAC,CAAC;AAEnB;;;;;;;;;GASG;AACH,oBAAY,2BAA2B,CACrC,UAAU,SAAS,WAAW,EAC9B,YAAY,SAAS,gBAAgB,CAAC,UAAU,CAAC,IAE/C,sBAAsB,CAAC,UAAU,EAAE,YAAY,CAAC,GAChD,CAAC,CACC,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC,KACzC,sBAAsB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC;AAE3D;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,oBAAoB,CAAC,UAAU,SAAS,WAAW;IAClE,CAAC,YAAY,SAAS,gBAAgB,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,YAAY,GAAG,IAAI,CAC/E,sBAAsB,CAAC,UAAU,EAAE,YAAY,CAAC,CACjD,CAAC;IACF,CAAC,YAAY,SAAS,gBAAgB,CAAC,UAAU,CAAC,EAChD,QAAQ,EAAE,YAAY,EACtB,OAAO,EAAE,2BAA2B,CAAC,UAAU,EAAE,YAAY,CAAC,GAC7D,OAAO,CAAC;CACZ;AAED;;;;;;;GAOG;AACH,oBAAY,kCAAkC,CAAC,UAAU,SAAS,WAAW,IAAI,CAC/E,YAAY,SAAS,aAAa,CAAC,gBAAgB,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,EAEzF,QAAQ,EAAE,YAAY,KACnB,OAAO,CAAC;AAEb;;;;;;;;;GASG;AACH,oBAAY,6BAA6B,CACvC,UAAU,SAAS,WAAW,EAC9B,UAAU,SAAS,cAAc,CAAC,UAAU,CAAC,IAE3C,oBAAoB,CAAC,UAAU,EAAE,UAAU,CAAC,GAC5C,CAAC,CACC,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC,KACzC,oBAAoB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC;AAEvD;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,sBAAsB,CAAC,UAAU,SAAS,WAAW;IACpE,CAAC,UAAU,SAAS,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,GAAG,IAAI,CACvE,oBAAoB,CAAC,UAAU,EAAE,UAAU,CAAC,CAC7C,CAAC;IACF,CAAC,UAAU,SAAS,cAAc,CAAC,UAAU,CAAC,EAC5C,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,6BAA6B,CAAC,UAAU,EAAE,UAAU,CAAC,GAC7D,OAAO,CAAC;CACZ;AAED;;;;;;;GAOG;AACH,oBAAY,oCAAoC,CAAC,UAAU,SAAS,WAAW,IAAI,CACjF,UAAU,SAAS,aAAa,CAAC,cAAc,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,EAErF,MAAM,EAAE,UAAU,KACf,OAAO,CAAC;AAEb;;;;;GAKG;AACH,oBAAY,oBAAoB,CAAC,UAAU,SAAS,WAAW,IAC7D,0BAA0B,CAAC,UAAU,CAAC,GAAG;IACvC,YAAY,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;IACzC,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { Observable } from 'rxjs';
|
|
2
|
+
import { Store } from 'vuex';
|
|
3
|
+
import { XBus } from '../plugins/x-bus.types';
|
|
4
|
+
import { RootXStoreState } from '../store/store.types';
|
|
5
|
+
import { MaybeArray } from '../utils/types';
|
|
6
|
+
import { XEvent } from './events.types';
|
|
7
|
+
import { TimedWireOperatorOptions, TimeSelector } from './wiring.types';
|
|
8
|
+
/**
|
|
9
|
+
* Creates the observable for the events that will be racing the wire's execution.
|
|
10
|
+
*
|
|
11
|
+
* @param events - The events to merge its observables.
|
|
12
|
+
* @param on - The on function of the {@link XBus} where the events will run.
|
|
13
|
+
* @returns The observable for the racing events.
|
|
14
|
+
* @internal
|
|
15
|
+
*/
|
|
16
|
+
export declare function mergeEvents(events: MaybeArray<XEvent>, on: XBus['on']): Observable<void>;
|
|
17
|
+
/**
|
|
18
|
+
* Checks how to retrieve the timeout time, retrieves it and returns it in ms.
|
|
19
|
+
*
|
|
20
|
+
* @param timeInMs - Time for the timeout in ms.
|
|
21
|
+
* @param store - The store of the wire that will be timed out.
|
|
22
|
+
* @returns The time in ms for the timeout.
|
|
23
|
+
* @internal
|
|
24
|
+
*/
|
|
25
|
+
export declare function normalizeTime(timeInMs: TimeSelector | number, store: Store<RootXStoreState>): number;
|
|
26
|
+
/**
|
|
27
|
+
* Creates a timer observable that depending on the provided options might be aborted or forced.
|
|
28
|
+
*
|
|
29
|
+
* @param durationInMs - The duration in ms for the timer.
|
|
30
|
+
* @param options - Options to configure the timer, like an events to force it or cancel it.
|
|
31
|
+
* @param on - The {@link XBus.on} method.
|
|
32
|
+
* @returns A timer observable that can be aborted or forced depending on the provided options.
|
|
33
|
+
* @internal
|
|
34
|
+
*/
|
|
35
|
+
export declare function createTimer(durationInMs: number, { cancelOn, forceOn }: TimedWireOperatorOptions, on: XBus['on']): Observable<unknown>;
|
|
36
|
+
//# sourceMappingURL=wires-operators.utils.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"wires-operators.utils.d.ts","sourceRoot":"","sources":["../../../src/wiring/wires-operators.utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,UAAU,EAAe,MAAM,MAAM,CAAC;AAExD,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,wBAAwB,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAExE;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,CAUxF;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,YAAY,GAAG,MAAM,EAC/B,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,GAC5B,MAAM,CAER;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CACzB,YAAY,EAAE,MAAM,EACpB,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,wBAAwB,EAC/C,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,GACb,UAAU,CAAC,OAAO,CAAC,CAWrB"}
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { XModuleName } from '../x-modules/x-modules.types';
|
|
2
|
-
import {
|
|
3
|
-
import { TimeRetrieving, Wire, WireParams } from './wiring.types';
|
|
2
|
+
import { TimedWireOperatorOptions, TimeSelector, Wire, WireParams } from './wiring.types';
|
|
4
3
|
/**
|
|
5
4
|
* Creates a {@link Wire} that is only executed whenever the condition in the filterFn is true.
|
|
6
5
|
*
|
|
@@ -63,13 +62,12 @@ export declare function filterBlacklistedModules<Payload>(wire: Wire<Payload>, b
|
|
|
63
62
|
* @param wire - The wire to debounce.
|
|
64
63
|
* @param timeInMs - The time in milliseconds to debounce the wire execution or a function to
|
|
65
64
|
* retrieve it from the store.
|
|
66
|
-
* @param
|
|
67
|
-
* of them executes first.
|
|
65
|
+
* @param options - Options to configure this wire with, like an event to force it or cancel it.
|
|
68
66
|
* @returns The Wire function with a debounced timing.
|
|
69
67
|
*
|
|
70
68
|
* @public
|
|
71
69
|
*/
|
|
72
|
-
export declare function debounce<Payload>(wire: Wire<Payload>, timeInMs:
|
|
70
|
+
export declare function debounce<Payload>(wire: Wire<Payload>, timeInMs: TimeSelector | number, options?: TimedWireOperatorOptions): Wire<Payload>;
|
|
73
71
|
/**
|
|
74
72
|
* Creates a throttled {@link Wire}. Being throttled means that it will only be executed once
|
|
75
73
|
* every couple of milliseconds given by the `timeInMs` parameter.
|
|
@@ -77,13 +75,12 @@ export declare function debounce<Payload>(wire: Wire<Payload>, timeInMs: TimeRet
|
|
|
77
75
|
* @param wire - The wire to throttle.
|
|
78
76
|
* @param timeInMs - The time in milliseconds to throttle the wire execution or a function to
|
|
79
77
|
* retrieve it from the store.
|
|
80
|
-
* @param
|
|
81
|
-
* of them executes first.
|
|
78
|
+
* @param options - Options to configure this wire with, like an event to force it or cancel it.
|
|
82
79
|
* @returns The Wire function with a throttle timing.
|
|
83
80
|
*
|
|
84
81
|
* @public
|
|
85
82
|
*/
|
|
86
|
-
export declare function throttle<Payload>(wire: Wire<Payload>, timeInMs:
|
|
83
|
+
export declare function throttle<Payload>(wire: Wire<Payload>, timeInMs: TimeSelector | number, options?: TimedWireOperatorOptions): Wire<Payload>;
|
|
87
84
|
/**
|
|
88
85
|
* Creates a {@link Wire} from other `toWire` wire. It uses `mapFn` to transform the
|
|
89
86
|
* `FromPayload` received to `ToPayload` which `toWire` requires. This is
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"wires.operators.d.ts","sourceRoot":"","sources":["../../../src/wiring/wires.operators.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;
|
|
1
|
+
{"version":3,"file":"wires.operators.d.ts","sourceRoot":"","sources":["../../../src/wiring/wires.operators.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,OAAO,EAAE,wBAAwB,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAE1F;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAC5B,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EACnB,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,OAAO,GACrD,IAAI,CAAC,OAAO,CAAC,CAGf;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAE9E;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAE/E;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAC9C,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EACnB,SAAS,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,GACnC,IAAI,CAAC,OAAO,CAAC,CAGf;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,EAC9C,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EACnB,SAAS,EAAE,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,GACnC,IAAI,CAAC,OAAO,CAAC,CAGf;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAC9B,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EACnB,QAAQ,EAAE,YAAY,GAAG,MAAM,EAC/B,OAAO,GAAE,wBAA6B,GACrC,IAAI,CAAC,OAAO,CAAC,CAQf;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAC9B,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EACnB,QAAQ,EAAE,YAAY,GAAG,MAAM,EAC/B,OAAO,GAAE,wBAA6B,GACrC,IAAI,CAAC,OAAO,CAAC,CAaf;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,OAAO,CAAC,WAAW,EAAE,SAAS,EAC5C,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,EACvB,KAAK,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,SAAS,GACzC,IAAI,CAAC,WAAW,CAAC,CAWnB"}
|
|
@@ -3,7 +3,7 @@ import { Store } from 'vuex';
|
|
|
3
3
|
import { XBus } from '../plugins/x-bus.types';
|
|
4
4
|
import { RootStoreStateAndGetters, RootXStoreState } from '../store';
|
|
5
5
|
import { FeatureLocation, QueryFeature } from '../types/origin';
|
|
6
|
-
import { Dictionary, FirstParameter, MonadicFunction, NiladicFunction, PropsWithType } from '../utils';
|
|
6
|
+
import { Dictionary, FirstParameter, MaybeArray, MonadicFunction, NiladicFunction, PropsWithType } from '../utils';
|
|
7
7
|
import { XModuleName } from '../x-modules/x-modules.types';
|
|
8
8
|
import { XEvent, XEventPayload } from './events.types';
|
|
9
9
|
/**
|
|
@@ -96,7 +96,18 @@ export interface WireParams<Payload> extends WirePayload<Payload> {
|
|
|
96
96
|
*
|
|
97
97
|
* @public
|
|
98
98
|
*/
|
|
99
|
-
export declare type
|
|
99
|
+
export declare type TimeSelector = (storeModule: Store<RootXStoreState>) => number;
|
|
100
|
+
/**
|
|
101
|
+
* Options for wire operators that delay subscribers.
|
|
102
|
+
*
|
|
103
|
+
* @public
|
|
104
|
+
*/
|
|
105
|
+
export interface TimedWireOperatorOptions {
|
|
106
|
+
/** Events that will prevent the next planned execution of the wire to be executed. */
|
|
107
|
+
cancelOn?: MaybeArray<XEvent>;
|
|
108
|
+
/** Events that will make the next planned execution happen immediately. */
|
|
109
|
+
forceOn?: MaybeArray<XEvent>;
|
|
110
|
+
}
|
|
100
111
|
/**
|
|
101
112
|
* Wires factory to invoke methods from a given service.
|
|
102
113
|
*
|
|
@@ -109,14 +120,16 @@ export interface WireService<SomeService> {
|
|
|
109
120
|
*
|
|
110
121
|
* @param method - The method to invoke.
|
|
111
122
|
* @returns A Wire that expects to receive the function parameter as payload.
|
|
112
|
-
*/
|
|
123
|
+
*/
|
|
124
|
+
<SomeMethod extends PropsWithType<SomeService, MonadicFunction>>(method: SomeMethod): Wire<FirstParameter<SomeService[SomeMethod]>>;
|
|
113
125
|
/**
|
|
114
126
|
* Creates a wire that will invoke the given service function with the provided static payload.
|
|
115
127
|
*
|
|
116
128
|
* @param method - The method to invoke.
|
|
117
129
|
* @param payload - The payload to invoke the service with.
|
|
118
130
|
* @returns A Wire that can be used anywhere.
|
|
119
|
-
*/
|
|
131
|
+
*/
|
|
132
|
+
<SomeMethod extends PropsWithType<SomeService, MonadicFunction>>(method: SomeMethod, payload: FirstParameter<SomeService[SomeMethod]>): AnyWire;
|
|
120
133
|
}
|
|
121
134
|
/**
|
|
122
135
|
* Wires factory to invoke methods from a given service.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"wiring.types.d.ts","sourceRoot":"","sources":["../../../src/wiring/wiring.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACL,UAAU,EACV,cAAc,EACd,eAAe,EACf,eAAe,EACf,aAAa,EACd,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEvD;;;;;;;GAOG;AACH,oBAAY,IAAI,CAAC,WAAW,IAAI,CAC9B,UAAU,EAAE,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAChD,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,EAC7B,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,KACX,YAAY,CAAC;AAElB;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,sCAAsC;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,yEAAyE;IACzE,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B;yBACqB;IACrB,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;IAC/B,yDAAyD;IACzD,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW,CAAC,WAAW;IACtC,6EAA6E;IAC7E,YAAY,EAAE,WAAW,CAAC;IAC1B,wEAAwE;IACxE,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED;;;;;GAKG;AACH,oBAAY,kBAAkB,CAAC,OAAO,IAAI,wBAAwB,GAAG;IACnE,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;;;GAMG;AACH,oBAAY,YAAY,CAAC,KAAK,SAAS,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AAE5E;;;;GAIG;AACH,oBAAY,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;AAEhC;;;;;GAKG;AACH,oBAAY,MAAM,GAAG;KAClB,CAAC,IAAI,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,UAAU,CAAC,OAAO,CAAE,SAAQ,WAAW,CAAC,OAAO,CAAC;IAC/D,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC/B;AAED;;;;GAIG;AACH,oBAAY,
|
|
1
|
+
{"version":3,"file":"wiring.types.d.ts","sourceRoot":"","sources":["../../../src/wiring/wiring.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAChD,OAAO,EAAE,KAAK,EAAE,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,wBAAwB,CAAC;AAC9C,OAAO,EAAE,wBAAwB,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,EACL,UAAU,EACV,cAAc,EACd,UAAU,EACV,eAAe,EACf,eAAe,EACf,aAAa,EACd,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC3D,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEvD;;;;;;;GAOG;AACH,oBAAY,IAAI,CAAC,WAAW,IAAI,CAC9B,UAAU,EAAE,UAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC,EAChD,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,EAC7B,EAAE,EAAE,IAAI,CAAC,IAAI,CAAC,KACX,YAAY,CAAC;AAElB;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,0DAA0D;IAC1D,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,sCAAsC;IACtC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,yEAAyE;IACzE,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B;yBACqB;IACrB,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;IAC/B,yDAAyD;IACzD,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW,CAAC,WAAW;IACtC,6EAA6E;IAC7E,YAAY,EAAE,WAAW,CAAC;IAC1B,wEAAwE;IACxE,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED;;;;;GAKG;AACH,oBAAY,kBAAkB,CAAC,OAAO,IAAI,wBAAwB,GAAG;IACnE,YAAY,EAAE,OAAO,CAAC;IACtB,QAAQ,EAAE,YAAY,CAAC;CACxB,CAAC;AAEF;;;;;;GAMG;AACH,oBAAY,YAAY,CAAC,KAAK,SAAS,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;AAE5E;;;;GAIG;AACH,oBAAY,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;AAEhC;;;;;GAKG;AACH,oBAAY,MAAM,GAAG;KAClB,CAAC,IAAI,MAAM,GAAG,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,WAAW,UAAU,CAAC,OAAO,CAAE,SAAQ,WAAW,CAAC,OAAO,CAAC;IAC/D,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC/B;AAED;;;;GAIG;AACH,oBAAY,YAAY,GAAG,CAAC,WAAW,EAAE,KAAK,CAAC,eAAe,CAAC,KAAK,MAAM,CAAC;AAE3E;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,sFAAsF;IACtF,QAAQ,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;IAC9B,2EAA2E;IAC3E,OAAO,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW,CAAC,WAAW;IACtC;;;;;;OAMG;IACH,CAAC,UAAU,SAAS,aAAa,CAAC,WAAW,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,UAAU,GAAG,IAAI,CACxF,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CACxC,CAAC;IACF;;;;;;OAMG;IACH,CAAC,UAAU,SAAS,aAAa,CAAC,WAAW,EAAE,eAAe,CAAC,EAC7D,MAAM,EAAE,UAAU,EAClB,OAAO,EAAE,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,GAC/C,OAAO,CAAC;CACZ;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB,CAAC,WAAW;IACpD;;;;;OAKG,CAAC,CAAC,UAAU,SAAS,aAAa,CAAC,WAAW,EAAE,eAAe,CAAC,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC;CACnG"}
|
|
@@ -37,7 +37,7 @@ declare global {
|
|
|
37
37
|
* ```
|
|
38
38
|
*
|
|
39
39
|
* 2.2 If the API option is enabled (`createAPI` is `true` in {@link InstallXOptions}, or
|
|
40
|
-
* is not present as the default
|
|
40
|
+
* is not present as the default value is `true`) then this init step can be done with
|
|
41
41
|
* the Public API:
|
|
42
42
|
*
|
|
43
43
|
* ```
|
|
@@ -23,6 +23,12 @@ export default class SnippetConfigExtraParams extends Vue {
|
|
|
23
23
|
* @internal
|
|
24
24
|
*/
|
|
25
25
|
protected extraParams: Dictionary<unknown>;
|
|
26
|
+
/**
|
|
27
|
+
* Collection of properties from the snippet config not allowed to be sent as extra params.
|
|
28
|
+
*
|
|
29
|
+
* @internal
|
|
30
|
+
*/
|
|
31
|
+
protected notAllowedExtraParams: Array<keyof SnippetConfig>;
|
|
26
32
|
/**
|
|
27
33
|
* Updates the extraParams object when the snippet config changes.
|
|
28
34
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"snippet-config-extra-params.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/extra-params/components/snippet-config-extra-params.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAKA,OAAO,GAAG,MAAM,KAAK,CAAC;AAGtB,OAAO,EAAE,UAAU,EAAW,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAIrD;;;;;GAKG;AAKH,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,GAAG;IACvD;;;;OAIG;IAEI,aAAa,EAAG,aAAa,CAAC;IAErC;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,CAAM;IAEhD;;;;;;OAMG;IAEH,eAAe,CAAC,EACd,QAAQ,EACR,KAAK,EACL,IAAI,EACJ,UAAU,EACV,OAAO,EACP,iBAAiB,EACjB,QAAQ,EACR,GAAG,kBAAkB,EACtB,EAAE,aAAa,GAAG,IAAI;
|
|
1
|
+
{"version":3,"file":"snippet-config-extra-params.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/extra-params/components/snippet-config-extra-params.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAKA,OAAO,GAAG,MAAM,KAAK,CAAC;AAGtB,OAAO,EAAE,UAAU,EAAW,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAIrD;;;;;GAKG;AAKH,MAAM,CAAC,OAAO,OAAO,wBAAyB,SAAQ,GAAG;IACvD;;;;OAIG;IAEI,aAAa,EAAG,aAAa,CAAC;IAErC;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,CAAM;IAEhD;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,EAAE,KAAK,CAAC,MAAM,aAAa,CAAC,CAAiB;IAE5E;;;;;;OAMG;IAEH,eAAe,CAAC,EACd,QAAQ,EACR,KAAK,EACL,IAAI,EACJ,UAAU,EACV,OAAO,EACP,iBAAiB,EACjB,QAAQ,EACR,GAAG,kBAAkB,EACtB,EAAE,aAAa,GAAG,IAAI;CAQxB"}
|
|
@@ -32,14 +32,6 @@ export default class FacetsProvider extends Vue {
|
|
|
32
32
|
* @internal
|
|
33
33
|
*/
|
|
34
34
|
protected selectedFilters: Filter[] | null;
|
|
35
|
-
/**
|
|
36
|
-
* Creates a watcher for the `facetsGroup`, if they're set, emitting an
|
|
37
|
-
* event whenever they change. This is done this way because the {@link XBus} is not injected
|
|
38
|
-
* until the component is created.
|
|
39
|
-
*
|
|
40
|
-
* @internal
|
|
41
|
-
*/
|
|
42
|
-
protected created(): void;
|
|
43
35
|
/**
|
|
44
36
|
* A computed property to group the facets and the groupId. This is used by the watcher.
|
|
45
37
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"facets-provider.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../../src/x-modules/facets/components/facets/facets-provider.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,GAAG,MAAM,KAAK,CAAC;AAKtB,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAG5C;;;;;;;GAOG;AAIH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,GAAG;IAC7C;;;;;OAKG;IAEI,OAAO,EAAG,OAAO,CAAC;IAEzB;;;;;OAKG;IAEI,MAAM,EAAG,KAAK,EAAE,CAAC;IAExB;;;;;OAKG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,EAAE,GAAG,IAAI,CAAQ;IAElD;;;;;;OAMG;IACH,SAAS,
|
|
1
|
+
{"version":3,"file":"facets-provider.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../../src/x-modules/facets/components/facets/facets-provider.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,GAAG,MAAM,KAAK,CAAC;AAKtB,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAG5C;;;;;;;GAOG;AAIH,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,GAAG;IAC7C;;;;;OAKG;IAEI,OAAO,EAAG,OAAO,CAAC;IAEzB;;;;;OAKG;IAEI,MAAM,EAAG,KAAK,EAAE,CAAC;IAExB;;;;;OAKG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,EAAE,GAAG,IAAI,CAAQ;IAElD;;;;;;OAMG;IACH,SAAS,KAAK,WAAW,IAAI,WAAW,CAEvC;IAED;;;;;;OAMG;IAEH,0BAA0B,CAAC,eAAe,EAAE,MAAM,EAAE,GAAG,IAAI;IAU3D;;;;OAIG;IAEH,aAAa,IAAI,IAAI;IAOrB;;;;;;OAMG;IACH,SAAS,CAAC,sBAAsB,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI;IAOvD,MAAM,IAAI,IAAI;CACf"}
|
|
@@ -62,7 +62,7 @@ export declare const historyQueriesWiring: {
|
|
|
62
62
|
addQueryToHistoryQueries: import("../..").Wire<string>;
|
|
63
63
|
};
|
|
64
64
|
UserIsTypingAQuery: {
|
|
65
|
-
setHistoryQueriesQueryDebounce: import("../..").
|
|
65
|
+
setHistoryQueriesQueryDebounce: import("../..").Wire<string>;
|
|
66
66
|
};
|
|
67
67
|
UserPressedClearHistoryQueries: {
|
|
68
68
|
clearHistoryQueries: import("../..").AnyWire;
|
|
@@ -41,7 +41,7 @@ export declare const setIdentifierResultsExtraParams: import("../..").Wire<impor
|
|
|
41
41
|
*/
|
|
42
42
|
export declare const identifierResultsWiring: {
|
|
43
43
|
UserIsTypingAQuery: {
|
|
44
|
-
setIdentifierResultsQueryDebounce: import("../..").
|
|
44
|
+
setIdentifierResultsQueryDebounce: import("../..").Wire<string>;
|
|
45
45
|
};
|
|
46
46
|
UserAcceptedAQuery: {
|
|
47
47
|
setIdentifierResultsQuery: import("../..").Wire<string>;
|
|
@@ -35,7 +35,7 @@ export declare const cancelFetchAndSaveSuggestionsWire: import("../..").AnyWire;
|
|
|
35
35
|
*/
|
|
36
36
|
export declare const querySuggestionsWiring: {
|
|
37
37
|
UserIsTypingAQuery: {
|
|
38
|
-
setQuerySuggestionsQueryDebounce: import("../..").
|
|
38
|
+
setQuerySuggestionsQueryDebounce: import("../..").Wire<string>;
|
|
39
39
|
};
|
|
40
40
|
UserAcceptedAQuery: {
|
|
41
41
|
setQuerySuggestionsQuery: import("../..").Wire<string>;
|
|
@@ -15,5 +15,11 @@ export default class Banner extends Vue {
|
|
|
15
15
|
* @public
|
|
16
16
|
*/
|
|
17
17
|
banner: BannerModel;
|
|
18
|
+
/**
|
|
19
|
+
* Emits the banner click event.
|
|
20
|
+
*
|
|
21
|
+
* @internal
|
|
22
|
+
*/
|
|
23
|
+
protected emitClickEvent(): void;
|
|
18
24
|
}
|
|
19
25
|
//# sourceMappingURL=banner.vue?rollup-plugin-vue=script.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"banner.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/search/components/banner.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,MAAM,IAAI,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,GAAG,MAAM,KAAK,CAAC;AAItB;;;;;;;GAOG;AAIH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,GAAG;IACrC;;;;OAIG;IAEI,MAAM,EAAG,WAAW,CAAC;
|
|
1
|
+
{"version":3,"file":"banner.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/search/components/banner.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,MAAM,IAAI,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,GAAG,MAAM,KAAK,CAAC;AAItB;;;;;;;GAOG;AAIH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,GAAG;IACrC;;;;OAIG;IAEI,MAAM,EAAG,WAAW,CAAC;IAE5B;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,IAAI;CAGjC"}
|
|
@@ -14,5 +14,11 @@ export default class Promoted extends Vue {
|
|
|
14
14
|
* @public
|
|
15
15
|
*/
|
|
16
16
|
promoted: PromotedModel;
|
|
17
|
+
/**
|
|
18
|
+
* Emits the promoted click event.
|
|
19
|
+
*
|
|
20
|
+
* @internal
|
|
21
|
+
*/
|
|
22
|
+
protected emitClickEvent(): void;
|
|
17
23
|
}
|
|
18
24
|
//# sourceMappingURL=promoted.vue?rollup-plugin-vue=script.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"promoted.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/search/components/promoted.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,QAAQ,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,GAAG,MAAM,KAAK,CAAC;AAKtB;;;;;;GAMG;AAIH,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,GAAG;IACvC;;;;OAIG;IAEI,QAAQ,EAAG,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"promoted.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/search/components/promoted.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,QAAQ,IAAI,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,GAAG,MAAM,KAAK,CAAC;AAKtB;;;;;;GAMG;AAIH,MAAM,CAAC,OAAO,OAAO,QAAS,SAAQ,GAAG;IACvC;;;;OAIG;IAEI,QAAQ,EAAG,aAAa,CAAC;IAEhC;;;;OAIG;IACH,SAAS,CAAC,cAAc,IAAI,IAAI;CAGjC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redirection.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/search/components/redirection.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,WAAW,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,GAAG,MAAM,KAAK,CAAC;AAOtB;;;;;;GAMG;AAIH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,GAAG;IAEnC,YAAY,EAAG,gBAAgB,EAAE,CAAC;IAEzC;;;;OAIG;IAEI,IAAI,EAAG,MAAM,GAAG,QAAQ,CAAC;IAEhC;;;;;;OAMG;IAEI,cAAc,EAAG,MAAM,CAAC;IAE/B;;;;OAIG;IACH,SAAS,CAAC,SAAS,
|
|
1
|
+
{"version":3,"file":"redirection.vue?rollup-plugin-vue=script.d.ts","sourceRoot":"","sources":["../../../../../src/x-modules/search/components/redirection.vue?rollup-plugin-vue=script.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,WAAW,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACrE,OAAO,GAAG,MAAM,KAAK,CAAC;AAOtB;;;;;;GAMG;AAIH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,GAAG;IAEnC,YAAY,EAAG,gBAAgB,EAAE,CAAC;IAEzC;;;;OAIG;IAEI,IAAI,EAAG,MAAM,GAAG,QAAQ,CAAC;IAEhC;;;;;;OAMG;IAEI,cAAc,EAAG,MAAM,CAAC;IAE/B;;;;OAIG;IACH,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,SAAS,CAAC,aAAa,UAAQ;IAE/B;;;;;;OAMG;IACH,SAAS,KAAK,WAAW,IAAI,gBAAgB,GAAG,IAAI,CAEnD;IAED;;;;;OAKG;IAEH,SAAS,CAAC,iBAAiB,IAAI,IAAI;IAQnC;;;;OAIG;IACH,SAAS,CAAC,QAAQ,IAAI,IAAI;IAM1B;;;;OAIG;IACH,SAAS,CAAC,aAAa,IAAI,IAAI;IAK/B;;;;OAIG;IAEH,cAAc,IAAI,IAAI;CAIvB"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { SearchRequest } from '@empathyco/x-adapter';
|
|
2
|
-
import { Facet, Result, Sort, Redirection, TaggingInfo } from '@empathyco/x-types';
|
|
2
|
+
import { Facet, Result, Sort, Redirection, TaggingInfo, Promoted, Banner } from '@empathyco/x-types';
|
|
3
3
|
/**
|
|
4
4
|
* Dictionary of the events of Search XModule, where each key is the event name, and the value is
|
|
5
5
|
* the event payload type or `void` if it has no payload.
|
|
@@ -70,6 +70,16 @@ export interface SearchXEvents {
|
|
|
70
70
|
* * Payload: The clicked redirection.
|
|
71
71
|
*/
|
|
72
72
|
UserClickedARedirection: Redirection;
|
|
73
|
+
/**
|
|
74
|
+
* The user has clicked a promoted.
|
|
75
|
+
* * Payload: The clicked promoted.
|
|
76
|
+
*/
|
|
77
|
+
UserClickedAPromoted: Promoted;
|
|
78
|
+
/**
|
|
79
|
+
* The user has clicked a banner.
|
|
80
|
+
* * Payload: The clicked banner.
|
|
81
|
+
*/
|
|
82
|
+
UserClickedABanner: Banner;
|
|
73
83
|
/**
|
|
74
84
|
* The user has aborted a redirection.
|
|
75
85
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.types.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/search/events.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,
|
|
1
|
+
{"version":3,"file":"events.types.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/search/events.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EACL,KAAK,EACL,MAAM,EACN,IAAI,EACJ,WAAW,EACX,WAAW,EACX,QAAQ,EACR,MAAM,EACP,MAAM,oBAAoB,CAAC;AAE5B;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,aAAa,EAAE,KAAK,EAAE,CAAC;IACvB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB;;;;OAIG;IACH,oBAAoB,EAAE,aAAa,GAAG,IAAI,CAAC;IAC3C;;;OAGG;IACH,oBAAoB,EAAE,WAAW,CAAC;IAClC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;;OAGG;IACH,gBAAgB,EAAE,IAAI,CAAC;IACvB;;;;;;OAMG;IACH,oBAAoB,EAAE,IAAI,CAAC;IAC3B;;;OAGG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,yBAAyB,EAAE,IAAI,CAAC;IAChC;;;OAGG;IACH,uBAAuB,EAAE,WAAW,CAAC;IACrC;;;OAGG;IACH,oBAAoB,EAAE,QAAQ,CAAC;IAC/B;;;OAGG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,4BAA4B,EAAE,IAAI,CAAC;CACpC"}
|
|
@@ -1,28 +1,42 @@
|
|
|
1
|
+
import { Result } from '@empathyco/x-types';
|
|
2
|
+
import { Wire } from '../../wiring/wiring.types';
|
|
1
3
|
/**
|
|
2
4
|
* Sets the tagging state `consent`.
|
|
3
5
|
*
|
|
4
6
|
* @public
|
|
5
7
|
*/
|
|
6
|
-
export declare const setConsent:
|
|
8
|
+
export declare const setConsent: Wire<boolean>;
|
|
7
9
|
/**
|
|
8
10
|
* Sets the tagging state config `queryTaggingDebounceMs`.
|
|
9
11
|
*
|
|
10
12
|
* @public
|
|
11
13
|
*/
|
|
12
|
-
export declare const setQueryTaggingDebounce:
|
|
14
|
+
export declare const setQueryTaggingDebounce: Wire<number>;
|
|
13
15
|
/**
|
|
14
16
|
* Sets the tagging state `sessionTTLMs`.
|
|
15
17
|
*
|
|
16
18
|
* @public
|
|
17
19
|
*/
|
|
18
|
-
export declare const setSessionDuration:
|
|
20
|
+
export declare const setSessionDuration: Wire<number>;
|
|
19
21
|
/**
|
|
20
22
|
* Tracks the tagging of the query using a debounce which ends if the user
|
|
21
23
|
* accepts a query.
|
|
22
24
|
*
|
|
23
25
|
* @public
|
|
24
26
|
*/
|
|
25
|
-
export declare const
|
|
27
|
+
export declare const trackQueryWire: Wire<import("@empathyco/x-types").TaggingInfo | import("@empathyco/x-types").TaggingInfo[]>;
|
|
28
|
+
/**
|
|
29
|
+
* Tracks the tagging of the result.
|
|
30
|
+
*
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
export declare const trackResultClickedWire: Wire<Result>;
|
|
34
|
+
/**
|
|
35
|
+
* Performs a track of a result added to the cart.
|
|
36
|
+
*
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
export declare const trackAddToCartWire: Wire<Result>;
|
|
26
40
|
/**
|
|
27
41
|
* Wiring configuration for the {@link TaggingXModule | tagging module}.
|
|
28
42
|
*
|
|
@@ -30,19 +44,25 @@ export declare const trackWire: import("../../wiring").AnyWire;
|
|
|
30
44
|
*/
|
|
31
45
|
export declare const taggingWiring: {
|
|
32
46
|
ConsentProvided: {
|
|
33
|
-
setConsent:
|
|
47
|
+
setConsent: Wire<boolean>;
|
|
34
48
|
};
|
|
35
49
|
ConsentChanged: {
|
|
36
|
-
clearSessionWire:
|
|
50
|
+
clearSessionWire: Wire<any>;
|
|
37
51
|
};
|
|
38
52
|
SessionDurationProvided: {
|
|
39
|
-
setSessionDuration:
|
|
53
|
+
setSessionDuration: Wire<number>;
|
|
40
54
|
};
|
|
41
55
|
QueryTaggingDebounceProvided: {
|
|
42
|
-
setQueryTaggingDebounce:
|
|
56
|
+
setQueryTaggingDebounce: Wire<number>;
|
|
43
57
|
};
|
|
44
58
|
SearchTaggingChanged: {
|
|
45
|
-
|
|
59
|
+
trackQueryWire: Wire<import("@empathyco/x-types").TaggingInfo | import("@empathyco/x-types").TaggingInfo[]>;
|
|
60
|
+
};
|
|
61
|
+
UserClickedAResult: {
|
|
62
|
+
trackResultClickedWire: Wire<Result>;
|
|
63
|
+
};
|
|
64
|
+
UserClickedResultAddToCart: {
|
|
65
|
+
trackAddToCartWire: Wire<Result>;
|
|
46
66
|
};
|
|
47
67
|
};
|
|
48
68
|
//# sourceMappingURL=wiring.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/tagging/wiring.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"wiring.d.ts","sourceRoot":"","sources":["../../../../src/x-modules/tagging/wiring.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAQ5C,OAAO,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AA6CjD;;;;GAIG;AACH,eAAO,MAAM,UAAU,eAA2B,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,cAAwC,CAAC;AAE7E;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,cAAmC,CAAC;AAEnE;;;;;GAKG;AACH,eAAO,MAAM,cAAc,6FAa1B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,cAAiC,CAAC;AAErE;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,cAAoC,CAAC;AAiBpE;;;;GAIG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;CAsBxB,CAAC"}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [BaseIdTogglePanel](./x-components.baseidtogglepanel.md) > [created](./x-components.baseidtogglepanel.created.md)
|
|
4
|
-
|
|
5
|
-
## BaseIdTogglePanel.created() method
|
|
6
|
-
|
|
7
|
-
Creates the watcher over `isOpen` state to emit the event [XEventsTypes.TogglePanelStateChanged](./x-components.xeventstypes.togglepanelstatechanged.md)<!-- -->.
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
created(): void;
|
|
13
|
-
```
|
|
14
|
-
<b>Returns:</b>
|
|
15
|
-
|
|
16
|
-
void
|
|
17
|
-
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [XComponent](./x-components.xcomponent.md)
|
|
4
|
-
|
|
5
|
-
## XComponent interface
|
|
6
|
-
|
|
7
|
-
An XComponent is just a normal Vue component that has an [XModule](./x-components.xmodule.md) linked to its usage. If the XComponent is imported in a consumer project, the [XModule](./x-components.xmodule.md) will be registered.
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export interface XComponent extends Vue
|
|
13
|
-
```
|
|
14
|
-
<b>Extends:</b> Vue
|
|
15
|
-
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [XEventsTypes](./x-components.xeventstypes.md) > [UserRightClickedAResult](./x-components.xeventstypes.userrightclickedaresult.md)
|
|
4
|
-
|
|
5
|
-
## XEventsTypes.UserRightClickedAResult property
|
|
6
|
-
|
|
7
|
-
The user has right clicked on a result. \* Payload: The [result](./x-types.result.md) that the user right clicked.
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
UserRightClickedAResult: Result;
|
|
13
|
-
```
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"staggering-transition-group.vue.js","sources":["../../../src/components/staggering-transition-group.vue"],"sourcesContent":["<script lang=\"ts\">\n import Vue, { CreateElement, VNode } from 'vue';\n import { Component, Prop } from 'vue-property-decorator';\n import { noOp } from '../utils';\n\n /* eslint-disable @typescript-eslint/unbound-method */\n /**\n * A replacement component for Vue's transition-group, that also adds the option to stagger\n * the animations.\n *\n * @public\n */\n @Component\n export default class StaggeringTransitionGroup extends Vue {\n /**\n * The name of the transition. Used to generate the CSS classes.\n *\n * @internal\n */\n @Prop({ default: 'v' })\n public name!: string;\n\n /** The CSS move class name.\n *\n * @internal\n */\n @Prop()\n public moveClass!: string;\n\n /**\n * The tag of the node to render to the DOM.\n *\n * @internal\n */\n @Prop({ default: 'div' })\n public tag!: string;\n\n /**\n * The time in ms to stagger each item.\n *\n * @internal\n */\n @Prop({ default: 25 })\n public staggering!: number;\n\n /**\n * The CSS class for the moving transitions.\n *\n * @returns The move transition name.\n * @internal\n */\n protected get moveClassName(): string {\n return this.moveClass ?? `${this.name}-move`;\n }\n\n /**\n * The transition data contains the needed events and props to perform a transition using Vue\n * virtual node's API.\n *\n * The `beforeLeave` hook is extended to also restore the previous position of the element using\n * the position absolute.\n * The `afterEnter` and `afterLeave` hooks are extended to also clean the transition delay\n * applied by the stagger.\n *\n * @returns The transition data for Vue virtual nodes.\n * @internal\n */\n protected get transitionData(): TransitionData {\n const transitionData: TransitionData = { ...this.$props, ...this.$attrs, ...this.$listeners };\n\n transitionData.beforeLeave = this.addRestorePositionHook(transitionData.beforeLeave);\n transitionData.afterEnter = this.addClearStaggeringCall(transitionData.afterEnter);\n transitionData.afterLeave = this.addClearStaggeringCall(transitionData.afterLeave);\n\n return transitionData;\n }\n\n /** The list of old virtual nodes, generated by the previous called render method.\n *\n * @internal */\n protected oldChildren!: TransitionVNode[];\n /** The list of new virtual nodes, generated by the last called render method.\n *\n * @internal */\n protected newChildren!: TransitionVNode[];\n /** A map containing the previous positions relative to the container, for each item\n * rendered inside the slot of this component component.\n * This is used together with the `newPositions` to calculate the move transition.\n *\n * @internal */\n protected oldPositions!: WeakMap<Element, Bounds>;\n /** A map containing the new positions relative to the container, for each item\n * rendered inside the slot of this component component.\n * This is used together with the `newPositions` to calculate the move transition.\n *\n * @internal */\n protected newPositions!: WeakMap<Element, Bounds>;\n /** A map containing the move cleanup functions pending to have been called. When invoked\n * this functions remove all the styles and classes associated to the move transition.\n *\n * @internal */\n protected pendingCleanupMoveCallbacks!: WeakMap<Element, () => void>;\n /** The counter for the stagger, used to calculate the delay for the transition of each child\n * element. It is reset every time the render method is triggered.\n *\n * @internal */\n protected staggerCounter!: number;\n /** The bounds of the container rendered using the `tag` prop. This is used to calculate the\n * relative positions of each leaving child, which are then applied with the position absolute.\n *\n * @internal */\n protected wrapperBounds!: DOMRect;\n\n beforeCreate(): void {\n /* Initialize properties here to avoid making them reactive,\n which would cause infinite loops */\n this.oldChildren = [];\n this.newChildren = [];\n this.oldPositions = new WeakMap();\n this.newPositions = new WeakMap();\n this.pendingCleanupMoveCallbacks = new WeakMap<Element, () => void>();\n this.staggerCounter = 0;\n }\n\n render(createElement: CreateElement): VNode {\n this.staggerCounter = 0;\n // New children are now the old ones\n this.oldChildren = this.newChildren;\n // Only vnodes with a tag (i.e. no HTML comments) and with a `key` property are valid.\n this.newChildren = (this.$slots.default ?? []).filter(this.isTransitionValidVNode);\n\n // Apply transition data to both new and old nodes & store the position of the old nodes.\n this.newChildren.forEach(this.addTransitionData);\n this.oldChildren.forEach(this.syncOldNodes);\n\n return createElement(\n this.tag,\n { staticClass: 'x-staggering-transition-group' },\n this.newChildren\n );\n }\n\n mounted(): void {\n this.newChildren.forEach(this.applyStagger);\n }\n\n beforeUpdate(): void {\n this.wrapperBounds = this.$el.getBoundingClientRect();\n }\n\n updated(): void {\n this.wrapperBounds = this.$el.getBoundingClientRect();\n this.newChildren.forEach(this.recordNewPosition);\n const { leavingNodes, stayingNodes, enteringNodes } = this.getNodesByTransitionType();\n\n leavingNodes.forEach(vNode => {\n this.applyStagger(vNode);\n this.disableClickingEvents(vNode);\n });\n const movedChildren = stayingNodes.filter(this.applyTranslation);\n const movedStagger = movedChildren.map(this.getNextTransitionDelay);\n enteringNodes.forEach(this.applyStagger);\n\n // force reflow to put everything in position\n document.body.getBoundingClientRect();\n\n movedChildren.forEach(this.startMoveAnimation(movedStagger));\n }\n\n /**\n * Extends the provided leave transition hook restoring the position of the element with an\n * absolute position.\n * Additionally, it removes the element position from the maps of positions.\n *\n * @param transitionHook - The leave transition hook to extend.\n * @returns The new leave transition hook extended.\n * @internal\n */\n protected addRestorePositionHook(transitionHook: TransitionHook = noOp): TransitionHook {\n return element => {\n const { top, left, width, height } = this.oldPositions.get(element)!;\n const { marginTop, marginLeft } = window.getComputedStyle(element);\n const style = element.style;\n style.position = 'absolute';\n style.top = `${top - parseFloat(marginTop)}px`;\n style.left = `${left - parseFloat(marginLeft)}px`;\n style.width = `${width}px`;\n style.height = `${height}px`;\n this.newPositions.delete(element);\n this.oldPositions.delete(element);\n const pendingCallback = this.pendingCleanupMoveCallbacks.get(element);\n pendingCallback?.();\n transitionHook(element);\n };\n }\n\n /**\n * Extends the provided transition hook clearing the transition delay.\n *\n * @param transitionHook - The transition hook to extend.\n * @returns The new transition hook, that also clears the transitionDelay from the element.\n * @internal\n */\n protected addClearStaggeringCall(transitionHook: TransitionHook = noOp): TransitionHook {\n return element => {\n element.style.transitionDelay = '';\n transitionHook(element);\n };\n }\n\n /**\n * Returns if the vNode contains a non empty key, and a non empty tag.\n *\n * @param vNode - The VNode to check if it is a valid transition node, containing a `tag` and a\n * `key` property.\n * @returns True when the vNode contains a non empty key and a non empty tag. False otherwise.\n * @internal\n */\n protected isTransitionValidVNode(vNode: VNode): vNode is TransitionVNode {\n // TODO Add warning with logger: <staggering-transition-group> children must be keyed.\n return !!vNode.key && !!vNode.tag;\n }\n\n /**\n * Adds the generated transition data to the vNode, creating the `data` property if necessary.\n *\n * @param vNode - The VNode to add the transition data to.\n * @internal\n */\n protected addTransitionData(vNode: TransitionVNode): void {\n if (!vNode.data) {\n vNode.data = {};\n }\n vNode.data.transition = this.transitionData;\n }\n\n /**\n * Re-applies the transition data to an old node, just in case it changed from the previous\n * render call. It also records the position of the node, to then calculate the move\n * transitions.\n *\n * @param vNode - The vNode to add the transition data to, and record his current position as\n * old.\n * @internal\n */\n protected syncOldNodes(vNode: TransitionVNode): void {\n // Synchronize transition data, in case it changed in the last frame.\n // We can trust data to be defined because each new node has the transition applied\n vNode.data!.transition = this.transitionData;\n this.recordOldPosition(vNode);\n }\n\n /**\n * Saves the position of the vNode in the map of old positions.\n *\n * @param vNode - The node to store its position.\n * @internal\n */\n protected recordOldPosition(vNode: TransitionVNode): void {\n this.oldPositions.set(vNode.elm, this.createRelativeBounds(vNode));\n }\n\n /**\n * Saves the position of the vNode in the map of new positions.\n *\n * @param vNode - The node to store its position.\n * @internal\n */\n protected recordNewPosition(vNode: TransitionVNode): void {\n this.newPositions.set(vNode.elm, this.createRelativeBounds(vNode));\n }\n\n /**\n * Creates an object containing the position of the vNode relative to its container.\n *\n * @param vNode - The virtual node to store its relative position.\n * @returns The relative bounds of the provided virtual node.\n * @internal\n */\n protected createRelativeBounds(vNode: TransitionVNode): Bounds {\n const { left, top, width, height } = vNode.elm.getBoundingClientRect();\n const { left: wrapperLeft, top: wrapperTop } = this.wrapperBounds;\n return {\n left: left - wrapperLeft,\n top: top - wrapperTop,\n width,\n height\n };\n }\n\n /**\n * Splits the children of the component into three groups:\n * - Nodes that are leaving.\n * - Nodes that are entering.\n * - Nodes that stay.\n *\n * This is then used to apply the stagger in the correct order: leave -\\> move -\\> enter.\n *\n * @returns The children nodes, divided in different groups depending on if they are leaving,\n * staying or entering.\n * @internal\n */\n protected getNodesByTransitionType(): TransitionTypeNodes {\n const leave = this.oldChildren.filter(child => !this.newPositions.has(child.elm));\n const enter = this.newChildren.filter(child => !this.oldPositions.has(child.elm));\n const stay = this.oldChildren.filter(child => this.newPositions.has(child.elm));\n return {\n leavingNodes: leave,\n enteringNodes: enter,\n stayingNodes: stay\n };\n }\n\n /**\n * Applies an incremental delay to the virtual node element.\n *\n * @param vNode - The virtual node to apply the stagger to.\n * @internal\n */\n protected applyStagger(vNode: TransitionVNode): void {\n vNode.elm.style.transitionDelay = this.getNextTransitionDelay();\n }\n\n /**\n * Disables listening to click events in a virtual node element.\n *\n * @remarks This is done to avoid letting the user click elements that are performing the moving\n * animation to leave the DOM but are still rendered.\n *\n * @param vNode - The virtual node to disable listening to click events.\n * @internal\n */\n protected disableClickingEvents(vNode: TransitionVNode): void {\n vNode.elm.style.pointerEvents = 'none';\n }\n\n /**\n * Calculates the next transition delay property, incrementing the `staggerCounter` property\n * each time it is called.\n *\n * @returns The value for the next element `style.transitionDelay` property.\n * @internal\n */\n protected getNextTransitionDelay(): string {\n return `${this.staggerCounter++ * this.staggering}ms`;\n }\n\n /**\n * Calculates if the virtual node should have a move transition. If its has it, then it\n * applies it immediately using the `style.transform`.\n *\n * @param vNode - The virtual node to calculate if it should have a move transition.\n * @returns True when a move transition was applied to the virtual node.\n * @internal\n */\n protected applyTranslation(vNode: TransitionVNode): boolean {\n const oldPosition = this.oldPositions.get(vNode.elm as Element)!;\n const newPosition = this.newPositions.get(vNode.elm as Element)!;\n const dx = oldPosition.left - newPosition.left;\n const dy = oldPosition.top - newPosition.top;\n if (dx !== 0 || dy !== 0) {\n const style = vNode.elm.style;\n style.transform = `translate3d(${dx}px,${dy}px,0)`;\n style.transitionDuration = '0s';\n return true;\n }\n return false;\n }\n\n /**\n * Generates a function to start the moving animations to each node that it needs them with the\n * provided stagger.\n *\n * @param moveStagger - A list containing the delay to add to each node.\n * @returns A function that starts the moving animation with the provided stagger to a single\n * virtual node.\n * @internal\n */\n protected startMoveAnimation(\n moveStagger: string[]\n ): (vNode: TransitionVNode, index: number) => void {\n return (vNode, index) => {\n const element = vNode.elm;\n const style = element.style;\n element.classList.add(this.moveClassName);\n style.transform = style.transitionDuration = '';\n style.transitionDelay = moveStagger[index];\n const cleanMoveTransition = (event?: TransitionEvent): void => {\n if (!event || (event.target === element && /transform$/.test(event.propertyName))) {\n element.removeEventListener('transitionend', cleanMoveTransition);\n element.style.transitionDelay = '';\n element.classList.remove(this.moveClassName);\n this.pendingCleanupMoveCallbacks.delete(element);\n }\n };\n this.pendingCleanupMoveCallbacks.set(element, cleanMoveTransition);\n element.addEventListener('transitionend', cleanMoveTransition);\n };\n }\n }\n\n /**\n * Contains arrays of nodes, splitted by the action they should have.\n */\n interface TransitionTypeNodes {\n leavingNodes: TransitionVNode[];\n stayingNodes: TransitionVNode[];\n enteringNodes: TransitionVNode[];\n }\n\n /**\n * Safe transition version of the VNode type, with the required non optional properties.\n */\n interface TransitionVNode extends VNode {\n elm: HTMLElement;\n tag: string;\n key: string;\n }\n\n /**\n * Vue's VNode {@link https://vuejs.org/v2/api/#transition | transition} data props and events.\n */\n interface TransitionData {\n name?: string;\n appear?: boolean;\n css?: boolean;\n type?: 'transition' | 'animation'; // Unused\n mode?: 'out-in' | 'in-out'; // Unused\n duration?: number;\n enterClass?: string;\n leaveClass?: string;\n appearClass?: string;\n enterToClass?: string;\n leaveToClass?: string;\n appearToClass?: string;\n enterActiveClass?: string;\n leaveActiveClass?: string;\n appearActiveClass?: string;\n beforeEnter?: TransitionHook;\n enter?: TransitionHook;\n afterEnter?: TransitionHook;\n beforeLeave?: TransitionHook;\n leave?: TransitionHook;\n afterLeave?: TransitionHook;\n }\n\n /**\n * A function that receives an HTMLElement. Used to perform actions when the different phases\n * of Vue transitions happens.\n */\n type TransitionHook = (element: HTMLElement) => void;\n\n /**\n * Represents the dimensions and positions of an element.\n */\n interface Bounds {\n top: number;\n left: number;\n width: number;\n height: number;\n }\n</script>\n\n<style lang=\"scss\" scoped>\n .x-staggering-transition-group {\n position: relative;\n }\n</style>\n\n<docs lang=\"mdx\">\n# Examples\n\n## Basic example\n\nApart from all the props and events that the classic transition group has, the staggering transition\ngroup also exposes a new `stagger` property, which allows to configure the delay for each one of the\nnodes when animating.\n\n```vue\n<staggering-transition-group appear :stagger=\"50\" name=\"staggered-fade-slide-\">\n <!-- @slot (Required) Transition-group content -->\n <slot />\n</staggering-transition-group>\n```\n</docs>\n"],"names":["const"],"mappings":";;;;;AAEAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
|