@empathyco/x-components 6.0.0-alpha.2 → 6.0.0-alpha.20
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 +202 -1
- package/core/index.js +1 -0
- package/core/index.js.map +1 -1
- package/design-system/deprecated-full-theme.css +1555 -1555
- package/docs/API-reference/api/x-adapter-platform.md +9 -0
- package/docs/API-reference/api/x-adapter-platform.platformadapter.relatedprompts.md +11 -0
- package/docs/API-reference/api/x-adapter-platform.platformrelatedprompt.md +22 -0
- package/docs/API-reference/api/x-adapter-platform.platformrelatedprompt.nextqueries.md +11 -0
- package/docs/API-reference/api/x-adapter-platform.platformrelatedprompt.suggestiontext.md +11 -0
- package/docs/API-reference/api/x-adapter-platform.platformrelatedprompt.type.md +11 -0
- package/docs/API-reference/api/x-adapter-platform.platformrelatedpromptsrequest.md +15 -0
- package/docs/API-reference/api/x-adapter-platform.platformrelatedpromptsresponse.data.md +13 -0
- package/docs/API-reference/api/x-adapter-platform.platformrelatedpromptsresponse.md +21 -0
- package/docs/API-reference/api/x-adapter-platform.platformrelatedpromptsresponse.status.md +11 -0
- package/docs/API-reference/api/x-adapter-platform.platformsearchresponse.catalog.md +6 -0
- package/docs/API-reference/api/x-adapter-platform.platformsearchresponse.md +1 -1
- package/docs/API-reference/api/x-adapter-platform.relatedpromptschema.md +13 -0
- package/docs/API-reference/api/x-adapter-platform.relatedpromptsendpointadapter.md +13 -0
- package/docs/API-reference/api/x-adapter-platform.relatedpromptsrequestmapper.md +13 -0
- package/docs/API-reference/api/x-adapter-platform.relatedpromptsrequestschema.md +13 -0
- package/docs/API-reference/api/x-adapter-platform.relatedpromptsresponsemapper.md +13 -0
- package/docs/API-reference/api/x-adapter-platform.relatedpromptsresponseschema.md +13 -0
- package/docs/API-reference/api/x-components.animationprop.md +6 -1
- package/docs/API-reference/api/x-components.bannerslist.md +3 -3
- package/docs/API-reference/api/x-components.basedropdown.md +5 -5
- package/docs/API-reference/api/x-components.baseeventsmodal.md +2 -2
- package/docs/API-reference/api/x-components.basegrid.md +3 -3
- package/docs/API-reference/api/x-components.baseheadertogglepanel.md +5 -5
- package/docs/API-reference/api/x-components.baseidmodal.md +2 -2
- package/docs/API-reference/api/x-components.baseidtogglepanel.md +5 -5
- package/docs/API-reference/api/x-components.basemodal.md +10 -10
- package/docs/API-reference/api/x-components.baseresultimage.md +9 -9
- package/docs/API-reference/api/x-components.baseslider.md +70 -0
- package/docs/API-reference/api/x-components.basesuggestions.md +3 -3
- package/docs/API-reference/api/x-components.basetabspanel.md +8 -8
- package/docs/API-reference/api/x-components.basetogglepanel.md +3 -3
- package/docs/API-reference/api/x-components.basevariablecolumngrid.md +3 -3
- package/docs/API-reference/api/x-components.cancelfetchandsaverelatedprompts.md +13 -0
- package/docs/API-reference/api/x-components.empathize.md +5 -5
- package/docs/API-reference/api/x-components.facets.md +3 -3
- package/docs/API-reference/api/x-components.fetchandsaverelatedprompts.md +13 -0
- package/docs/API-reference/api/x-components.fetchrelatedprompts.md +13 -0
- package/docs/API-reference/api/x-components.filterslist.md +3 -3
- package/docs/API-reference/api/x-components.globalxbus.md +6 -0
- package/docs/API-reference/api/x-components.hierarchicalfilter.md +5 -2
- package/docs/API-reference/api/x-components.identifierresults.md +3 -3
- package/docs/API-reference/api/x-components.itemslist.md +3 -3
- package/docs/API-reference/api/x-components.mainmodal.md +2 -2
- package/docs/API-reference/api/x-components.md +17 -0
- package/docs/API-reference/api/x-components.multicolumnmaxwidthlayout.md +5 -5
- package/docs/API-reference/api/x-components.myhistory.md +3 -3
- package/docs/API-reference/api/x-components.nextqueriesgroup.md +22 -0
- package/docs/API-reference/api/x-components.nextqueriesgroup.modelname.md +11 -0
- package/docs/API-reference/api/x-components.nextqueriesgroup.nextqueries.md +11 -0
- package/docs/API-reference/api/x-components.nextquerieslist.md +3 -3
- package/docs/API-reference/api/x-components.partialresultslist.md +3 -3
- package/docs/API-reference/api/x-components.promotedslist.md +3 -3
- package/docs/API-reference/api/x-components.querypreviewlist.md +3 -3
- package/docs/API-reference/api/x-components.recommendations.md +3 -3
- package/docs/API-reference/api/x-components.relatedprompt.md +38 -0
- package/docs/API-reference/api/x-components.relatedpromptrequest.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsactioncontext.md +15 -0
- package/docs/API-reference/api/x-components.relatedpromptsactions.cancelfetchandsaverelatedprompts.md +17 -0
- package/docs/API-reference/api/x-components.relatedpromptsactions.fetchandsaverelatedprompts.md +24 -0
- package/docs/API-reference/api/x-components.relatedpromptsactions.fetchrelatedprompts.md +24 -0
- package/docs/API-reference/api/x-components.relatedpromptsactions.md +22 -0
- package/docs/API-reference/api/x-components.relatedpromptsgetters.md +20 -0
- package/docs/API-reference/api/x-components.relatedpromptsgetters.request.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptslist.md +72 -0
- package/docs/API-reference/api/x-components.relatedpromptsmutations.md +25 -0
- package/docs/API-reference/api/x-components.relatedpromptsmutations.resetrelatedpromptsstate.md +17 -0
- package/docs/API-reference/api/x-components.relatedpromptsmutations.setparams.md +24 -0
- package/docs/API-reference/api/x-components.relatedpromptsmutations.setrelatedpromptsproducts.md +24 -0
- package/docs/API-reference/api/x-components.relatedpromptsmutations.setselectedprompt.md +24 -0
- package/docs/API-reference/api/x-components.relatedpromptsmutations.setselectedquery.md +24 -0
- package/docs/API-reference/api/x-components.relatedpromptsstate.md +24 -0
- package/docs/API-reference/api/x-components.relatedpromptsstate.params.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsstate.relatedprompts.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsstate.selectedprompt.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsstate.selectedquery.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsxevents.md +22 -0
- package/docs/API-reference/api/x-components.relatedpromptsxevents.relatedpromptsrequestupdated.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsxevents.userselectedarelatedprompt.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsxevents.userselectedarelatedpromptquery.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsxmodule.md +13 -0
- package/docs/API-reference/api/x-components.relatedpromptsxstoremodule.md +15 -0
- package/docs/API-reference/api/x-components.relatedtags.md +3 -3
- package/docs/API-reference/api/x-components.resultslist.md +3 -3
- package/docs/API-reference/api/x-components.scrolltotop.md +5 -5
- package/docs/API-reference/api/x-components.searchinputplaceholder.md +3 -3
- package/docs/API-reference/api/x-components.searchmutations.md +1 -0
- package/docs/API-reference/api/x-components.searchmutations.setstats.md +24 -0
- package/docs/API-reference/api/x-components.searchstate.md +1 -0
- package/docs/API-reference/api/x-components.searchstate.stats.md +13 -0
- package/docs/API-reference/api/x-components.selectedfilterslist.md +3 -3
- package/docs/API-reference/api/x-components.simplefilter.md +3 -0
- package/docs/API-reference/api/x-components.singlecolumnlayout.md +3 -3
- package/docs/API-reference/api/x-components.snippetcallbacks.md +3 -0
- package/docs/API-reference/api/x-components.snippetconfigextraparams.md +1 -1
- package/docs/API-reference/api/x-components.sortdropdown.md +1 -1
- package/docs/API-reference/api/x-components.tagging.md +17 -4
- package/docs/API-reference/api/x-components.usealiasapi.md +1 -0
- package/docs/API-reference/api/x-components.usealiasapi.pricestats.md +16 -0
- package/docs/API-reference/api/x-components.xeventstypes.md +3 -3
- package/docs/API-reference/api/x-components.xmodulestree.md +1 -0
- package/docs/API-reference/api/x-components.xmodulestree.relatedprompts.md +11 -0
- package/docs/API-reference/api/x-types.md +4 -0
- package/docs/API-reference/api/x-types.relatedprompt.md +23 -0
- package/docs/API-reference/api/x-types.relatedprompt.nextqueries.md +13 -0
- package/docs/API-reference/api/x-types.relatedprompt.suggestiontext.md +13 -0
- package/docs/API-reference/api/x-types.relatedprompt.type.md +13 -0
- package/docs/API-reference/api/x-types.relatedpromptsrequest.md +15 -0
- package/docs/API-reference/api/x-types.relatedpromptsresponse.md +20 -0
- package/docs/API-reference/api/x-types.relatedpromptsresponse.relatedprompts.md +11 -0
- package/docs/API-reference/api/x-types.searchresponse.md +1 -0
- package/docs/API-reference/api/x-types.searchresponse.stats.md +11 -0
- package/docs/API-reference/api/x-types.stats.md +22 -0
- package/docs/API-reference/api/x-types.stats.price.md +14 -0
- package/docs/API-reference/api/x-types.xcomponentsadapter.md +1 -0
- package/docs/API-reference/api/x-types.xcomponentsadapter.relatedprompts.md +11 -0
- package/docs/API-reference/components/common/result/x-components.base-result-image.md +2 -2
- package/docs/API-reference/components/common/x-components.base-slider.md +189 -0
- package/docs/API-reference/components/common/x-components.items-list.md +1 -1
- package/docs/API-reference/components/facets/x-components.facets/facets.md +1 -1
- package/docs/API-reference/components/facets/x-components.lists/selected-filters-list.md +1 -1
- package/docs/API-reference/components/related-prompts/x-components.related-prompt.md +29 -0
- package/docs/API-reference/components/related-prompts/x-components.related-prompts-list.md +196 -0
- package/docs/API-reference/components/search/x-components.results-list.md +1 -1
- package/docs/API-reference/components/tagging/x-components.tagging.md +2 -2
- package/js/components/base-grid.vue.js.map +1 -1
- package/js/components/base-grid.vue2.js.map +1 -1
- package/js/components/base-grid.vue3.js +1 -1
- package/js/components/base-slider.vue.js +66 -0
- package/js/components/base-slider.vue.js.map +1 -0
- package/js/components/base-slider.vue2.js +109 -0
- package/js/components/base-slider.vue2.js.map +1 -0
- package/js/components/base-slider.vue3.js +7 -0
- package/js/components/base-slider.vue3.js.map +1 -0
- package/js/components/icons/cross-tiny.vue.js +2 -2
- package/js/components/icons/plus.vue.js +2 -2
- package/js/components/items-list.vue.js.map +1 -1
- package/js/components/items-list.vue2.js +2 -2
- package/js/components/items-list.vue2.js.map +1 -1
- package/js/components/result/base-result-image.vue.js.map +1 -1
- package/js/components/result/base-result-image.vue2.js +3 -3
- package/js/components/result/base-result-image.vue2.js.map +1 -1
- package/js/components/scroll/use-scroll.js +1 -1
- package/js/components/scroll/use-scroll.js.map +1 -1
- package/js/components/sliding-panel.vue.js +2 -2
- package/js/composables/use-alias-api.js +3 -0
- package/js/composables/use-alias-api.js.map +1 -1
- package/js/index.js +10 -0
- package/js/index.js.map +1 -1
- package/js/types/animation-prop.js +5 -0
- package/js/types/animation-prop.js.map +1 -1
- package/js/x-modules/empathize/components/empathize.vue2.js +2 -0
- package/js/x-modules/empathize/components/empathize.vue2.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.vue2.js +1 -1
- package/js/x-modules/extra-params/components/snippet-config-extra-params.vue2.js.map +1 -1
- package/js/x-modules/facets/components/facets/facets.vue.js.map +1 -1
- package/js/x-modules/facets/components/facets/facets.vue2.js +2 -2
- package/js/x-modules/facets/components/facets/facets.vue2.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-list.vue2.js +2 -2
- package/js/x-modules/facets/components/lists/selected-filters-list.vue2.js.map +1 -1
- package/js/x-modules/queries-preview/components/query-preview-button.vue2.js +2 -0
- package/js/x-modules/queries-preview/components/query-preview-button.vue2.js.map +1 -1
- package/js/x-modules/queries-preview/components/query-preview-list.vue.js.map +1 -1
- package/js/x-modules/queries-preview/components/query-preview-list.vue2.js +15 -2
- package/js/x-modules/queries-preview/components/query-preview-list.vue2.js.map +1 -1
- package/js/x-modules/queries-preview/components/query-preview.vue.js.map +1 -1
- package/js/x-modules/queries-preview/components/query-preview.vue2.js +3 -1
- package/js/x-modules/queries-preview/components/query-preview.vue2.js.map +1 -1
- package/js/x-modules/queries-preview/store/actions/fetch-and-save-query-preview.action.js +2 -1
- package/js/x-modules/queries-preview/store/actions/fetch-and-save-query-preview.action.js.map +1 -1
- package/js/x-modules/queries-preview/store/module.js +1 -1
- package/js/x-modules/queries-preview/store/module.js.map +1 -1
- package/js/x-modules/queries-preview/utils/get-hash-from-query-preview.js +6 -4
- package/js/x-modules/queries-preview/utils/get-hash-from-query-preview.js.map +1 -1
- package/js/x-modules/related-prompts/components/related-prompt.vue.js +90 -0
- package/js/x-modules/related-prompts/components/related-prompt.vue.js.map +1 -0
- package/js/x-modules/related-prompts/components/related-prompt.vue2.js +54 -0
- package/js/x-modules/related-prompts/components/related-prompt.vue2.js.map +1 -0
- package/js/x-modules/related-prompts/components/related-prompt.vue3.js +7 -0
- package/js/x-modules/related-prompts/components/related-prompt.vue3.js.map +1 -0
- package/js/x-modules/related-prompts/components/related-prompts-list.vue.js +154 -0
- package/js/x-modules/related-prompts/components/related-prompts-list.vue.js.map +1 -0
- package/js/x-modules/related-prompts/components/related-prompts-list.vue2.js +6 -0
- package/js/x-modules/related-prompts/components/related-prompts-list.vue2.js.map +1 -0
- package/js/x-modules/related-prompts/store/actions/fetch-and-save-related-prompts.action.js +29 -0
- package/js/x-modules/related-prompts/store/actions/fetch-and-save-related-prompts.action.js.map +1 -0
- package/js/x-modules/related-prompts/store/actions/fetch-related-prompts.action.js +20 -0
- package/js/x-modules/related-prompts/store/actions/fetch-related-prompts.action.js.map +1 -0
- package/js/x-modules/related-prompts/store/emitters.js +14 -0
- package/js/x-modules/related-prompts/store/emitters.js.map +1 -0
- package/js/x-modules/related-prompts/store/getters/request.getter.js +16 -0
- package/js/x-modules/related-prompts/store/getters/request.getter.js.map +1 -0
- package/js/x-modules/related-prompts/store/module.js +53 -0
- package/js/x-modules/related-prompts/store/module.js.map +1 -0
- package/js/x-modules/related-prompts/wiring.js +88 -0
- package/js/x-modules/related-prompts/wiring.js.map +1 -0
- package/js/x-modules/related-prompts/x-module.js +21 -0
- package/js/x-modules/related-prompts/x-module.js.map +1 -0
- package/js/x-modules/scroll/components/scroll-to-top.vue2.js +2 -0
- package/js/x-modules/scroll/components/scroll-to-top.vue2.js.map +1 -1
- package/js/x-modules/search/components/results-list.vue.js +2 -2
- package/js/x-modules/search/components/results-list.vue.js.map +1 -1
- package/js/x-modules/search/store/actions/save-search-response.action.js +2 -1
- package/js/x-modules/search/store/actions/save-search-response.action.js.map +1 -1
- package/js/x-modules/search/store/module.js +5 -1
- package/js/x-modules/search/store/module.js.map +1 -1
- package/js/x-modules/tagging/components/tagging.vue.js +8 -2
- package/js/x-modules/tagging/components/tagging.vue.js.map +1 -1
- package/package.json +7 -6
- package/related-prompts/index.d.ts +1 -0
- package/related-prompts/index.js +9 -0
- package/report/x-adapter-platform.api.json +575 -1
- package/report/x-components.api.json +4236 -7917
- package/report/x-components.api.md +445 -155
- package/report/x-types.api.json +334 -0
- package/tools/inject-css.js +5 -3
- package/types/adapter/e2e-adapter.d.ts.map +1 -1
- package/types/adapter/mocked-responses.d.ts +3 -0
- package/types/adapter/mocked-responses.d.ts.map +1 -1
- package/types/components/base-dropdown.vue.d.ts +5 -5
- package/types/components/base-grid.vue.d.ts +3 -3
- package/types/components/base-slider.vue.d.ts +74 -0
- package/types/components/base-slider.vue.d.ts.map +1 -0
- package/types/components/base-variable-column-grid.vue.d.ts +3 -3
- package/types/components/global-x-bus.vue.d.ts +6 -0
- package/types/components/global-x-bus.vue.d.ts.map +1 -1
- package/types/components/index.d.ts +1 -0
- package/types/components/index.d.ts.map +1 -1
- package/types/components/items-list.vue.d.ts +3 -3
- package/types/components/layouts/multi-column-max-width-layout.vue.d.ts +5 -5
- package/types/components/layouts/single-column-layout.vue.d.ts +3 -3
- package/types/components/modals/base-events-modal.vue.d.ts +2 -2
- package/types/components/modals/base-id-modal.vue.d.ts +2 -2
- package/types/components/modals/base-modal.vue.d.ts +10 -10
- package/types/components/modals/main-modal.vue.d.ts +2 -2
- package/types/components/panels/base-header-toggle-panel.vue.d.ts +5 -5
- package/types/components/panels/base-id-toggle-panel.vue.d.ts +5 -5
- package/types/components/panels/base-tabs-panel.vue.d.ts +8 -8
- package/types/components/panels/base-toggle-panel.vue.d.ts +3 -3
- package/types/components/result/base-result-image.vue.d.ts +10 -10
- package/types/components/result/base-result-image.vue.d.ts.map +1 -1
- package/types/components/snippet-callbacks.vue.d.ts +3 -0
- package/types/components/snippet-callbacks.vue.d.ts.map +1 -1
- package/types/components/suggestions/base-suggestions.vue.d.ts +3 -3
- package/types/composables/use-alias-api.d.ts +5 -0
- package/types/composables/use-alias-api.d.ts.map +1 -1
- package/types/index.d.ts +1 -0
- package/types/index.d.ts.map +1 -1
- package/types/tailwind/plugin-options.d.ts +1 -2
- package/types/tailwind/plugin-options.d.ts.map +1 -1
- package/types/types/animation-prop.d.ts +6 -2
- package/types/types/animation-prop.d.ts.map +1 -1
- package/types/views/home/types.d.ts +3 -0
- package/types/views/home/types.d.ts.map +1 -1
- package/types/wiring/events.types.d.ts +3 -1
- package/types/wiring/events.types.d.ts.map +1 -1
- package/types/x-modules/empathize/components/empathize.vue.d.ts +5 -5
- package/types/x-modules/extra-params/components/snippet-config-extra-params.vue.d.ts +1 -1
- package/types/x-modules/facets/components/facets/facets.vue.d.ts +3 -3
- package/types/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts +5 -2
- package/types/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts.map +1 -1
- package/types/x-modules/facets/components/filters/simple-filter.vue.d.ts +3 -0
- package/types/x-modules/facets/components/filters/simple-filter.vue.d.ts.map +1 -1
- package/types/x-modules/facets/components/lists/filters-list.vue.d.ts +3 -3
- package/types/x-modules/facets/components/lists/selected-filters-list.vue.d.ts +3 -3
- package/types/x-modules/history-queries/components/my-history.vue.d.ts +3 -3
- package/types/x-modules/identifier-results/components/identifier-results.vue.d.ts +3 -3
- package/types/x-modules/next-queries/components/next-queries-list.vue.d.ts +3 -3
- package/types/x-modules/next-queries/index.d.ts +1 -0
- package/types/x-modules/next-queries/index.d.ts.map +1 -1
- package/types/x-modules/queries-preview/components/query-preview-list.vue.d.ts +3 -3
- package/types/x-modules/queries-preview/components/query-preview-list.vue.d.ts.map +1 -1
- package/types/x-modules/queries-preview/components/query-preview.vue.d.ts.map +1 -1
- package/types/x-modules/queries-preview/store/actions/fetch-and-save-query-preview.action.d.ts.map +1 -1
- package/types/x-modules/queries-preview/store/module.d.ts.map +1 -1
- package/types/x-modules/queries-preview/utils/get-hash-from-query-preview.d.ts +4 -2
- package/types/x-modules/queries-preview/utils/get-hash-from-query-preview.d.ts.map +1 -1
- package/types/x-modules/recommendations/components/recommendations.vue.d.ts +3 -3
- package/types/x-modules/related-prompts/components/index.d.ts +3 -0
- package/types/x-modules/related-prompts/components/index.d.ts.map +1 -0
- package/types/x-modules/related-prompts/components/related-prompt.vue.d.ts +37 -0
- package/types/x-modules/related-prompts/components/related-prompt.vue.d.ts.map +1 -0
- package/types/x-modules/related-prompts/components/related-prompts-list.vue.d.ts +106 -0
- package/types/x-modules/related-prompts/components/related-prompts-list.vue.d.ts.map +1 -0
- package/types/x-modules/related-prompts/events.types.d.ts +26 -0
- package/types/x-modules/related-prompts/events.types.d.ts.map +1 -0
- package/types/x-modules/related-prompts/index.d.ts +6 -0
- package/types/x-modules/related-prompts/index.d.ts.map +1 -0
- package/types/x-modules/related-prompts/store/actions/fetch-and-save-related-prompts.action.d.ts +17 -0
- package/types/x-modules/related-prompts/store/actions/fetch-and-save-related-prompts.action.d.ts.map +1 -0
- package/types/x-modules/related-prompts/store/actions/fetch-related-prompts.action.d.ts +13 -0
- package/types/x-modules/related-prompts/store/actions/fetch-related-prompts.action.d.ts.map +1 -0
- package/types/x-modules/related-prompts/store/emitters.d.ts +9 -0
- package/types/x-modules/related-prompts/store/emitters.d.ts.map +1 -0
- package/types/x-modules/related-prompts/store/getters/request.getter.d.ts +13 -0
- package/types/x-modules/related-prompts/store/getters/request.getter.d.ts.map +1 -0
- package/types/x-modules/related-prompts/store/index.d.ts +7 -0
- package/types/x-modules/related-prompts/store/index.d.ts.map +1 -0
- package/types/x-modules/related-prompts/store/module.d.ts +8 -0
- package/types/x-modules/related-prompts/store/module.d.ts.map +1 -0
- package/types/x-modules/related-prompts/store/types.d.ts +104 -0
- package/types/x-modules/related-prompts/store/types.d.ts.map +1 -0
- package/types/x-modules/related-prompts/types.d.ts +10 -0
- package/types/x-modules/related-prompts/types.d.ts.map +1 -0
- package/types/x-modules/related-prompts/wiring.d.ts +31 -0
- package/types/x-modules/related-prompts/wiring.d.ts.map +1 -0
- package/types/x-modules/related-prompts/x-module.d.ts +16 -0
- package/types/x-modules/related-prompts/x-module.d.ts.map +1 -0
- package/types/x-modules/related-tags/components/related-tags.vue.d.ts +3 -3
- package/types/x-modules/scroll/components/scroll-to-top.vue.d.ts +5 -5
- package/types/x-modules/search/components/banners-list.vue.d.ts +3 -3
- package/types/x-modules/search/components/partial-results-list.vue.d.ts +3 -3
- package/types/x-modules/search/components/promoteds-list.vue.d.ts +3 -3
- package/types/x-modules/search/components/results-list.vue.d.ts +3 -3
- package/types/x-modules/search/components/sort-dropdown.vue.d.ts +1 -1
- package/types/x-modules/search/store/actions/save-search-response.action.d.ts.map +1 -1
- package/types/x-modules/search/store/module.d.ts +2 -0
- package/types/x-modules/search/store/module.d.ts.map +1 -1
- package/types/x-modules/search/store/types.d.ts +9 -1
- package/types/x-modules/search/store/types.d.ts.map +1 -1
- package/types/x-modules/search-box/components/search-input-placeholder.vue.d.ts +3 -3
- package/types/x-modules/tagging/components/tagging.vue.d.ts +17 -4
- package/types/x-modules/tagging/components/tagging.vue.d.ts.map +1 -1
- package/types/x-modules/x-modules.types.d.ts +2 -0
- package/types/x-modules/x-modules.types.d.ts.map +1 -1
- package/js/utils/options-api.js +0 -4
- package/js/utils/options-api.js.map +0 -1
- package/types/utils/options-api.d.ts +0 -3
- package/types/utils/options-api.d.ts.map +0 -1
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [RelatedPromptsResponse](./x-types.relatedpromptsresponse.md)
|
|
4
|
+
|
|
5
|
+
## RelatedPromptsResponse interface
|
|
6
|
+
|
|
7
|
+
Response for the related prompts endpoint.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface RelatedPromptsResponse
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [relatedPrompts](./x-types.relatedpromptsresponse.relatedprompts.md) | | [RelatedPrompt](./x-types.relatedprompt.md)<!-- -->\[\] | |
|
|
20
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [RelatedPromptsResponse](./x-types.relatedpromptsresponse.md) > [relatedPrompts](./x-types.relatedpromptsresponse.relatedprompts.md)
|
|
4
|
+
|
|
5
|
+
## RelatedPromptsResponse.relatedPrompts property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
relatedPrompts: RelatedPrompt[];
|
|
11
|
+
```
|
|
@@ -25,5 +25,6 @@ export interface SearchResponse
|
|
|
25
25
|
| [redirections?](./x-types.searchresponse.redirections.md) | | [Redirection](./x-types.redirection.md)<!-- -->\[\] | _(Optional)_ |
|
|
26
26
|
| [results](./x-types.searchresponse.results.md) | | [Result](./x-types.result.md)<!-- -->\[\] | |
|
|
27
27
|
| [spellcheck?](./x-types.searchresponse.spellcheck.md) | | string | _(Optional)_ |
|
|
28
|
+
| [stats?](./x-types.searchresponse.stats.md) | | [Stats](./x-types.stats.md) | _(Optional)_ |
|
|
28
29
|
| [totalResults](./x-types.searchresponse.totalresults.md) | | number | |
|
|
29
30
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [SearchResponse](./x-types.searchresponse.md) > [stats](./x-types.searchresponse.stats.md)
|
|
4
|
+
|
|
5
|
+
## SearchResponse.stats property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
stats?: Stats;
|
|
11
|
+
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [Stats](./x-types.stats.md)
|
|
4
|
+
|
|
5
|
+
## Stats interface
|
|
6
|
+
|
|
7
|
+
Statistics for the current search results.
|
|
8
|
+
|
|
9
|
+
Price - interval of the prices of the results.
|
|
10
|
+
|
|
11
|
+
**Signature:**
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
export interface Stats
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
| Property | Modifiers | Type | Description |
|
|
20
|
+
| --- | --- | --- | --- |
|
|
21
|
+
| [price](./x-types.stats.price.md) | | { min: number \| undefined; max: number \| undefined; } | |
|
|
22
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [Stats](./x-types.stats.md) > [price](./x-types.stats.price.md)
|
|
4
|
+
|
|
5
|
+
## Stats.price property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
price: {
|
|
11
|
+
min: number | undefined;
|
|
12
|
+
max: number | undefined;
|
|
13
|
+
};
|
|
14
|
+
```
|
|
@@ -20,6 +20,7 @@ export interface XComponentsAdapter
|
|
|
20
20
|
| [popularSearches](./x-types.xcomponentsadapter.popularsearches.md) | | EndpointAdapter<[PopularSearchesRequest](./x-types.popularsearchesrequest.md)<!-- -->, [PopularSearchesResponse](./x-types.popularsearchesresponse.md)<!-- -->> | |
|
|
21
21
|
| [querySuggestions](./x-types.xcomponentsadapter.querysuggestions.md) | | EndpointAdapter<[QuerySuggestionsRequest](./x-types.querysuggestionsrequest.md)<!-- -->, [QuerySuggestionsResponse](./x-types.querysuggestionsresponse.md)<!-- -->> | |
|
|
22
22
|
| [recommendations](./x-types.xcomponentsadapter.recommendations.md) | | EndpointAdapter<[RecommendationsRequest](./x-types.recommendationsrequest.md)<!-- -->, [RecommendationsResponse](./x-types.recommendationsresponse.md)<!-- -->> | |
|
|
23
|
+
| [relatedPrompts](./x-types.xcomponentsadapter.relatedprompts.md) | | EndpointAdapter<[RelatedPromptsRequest](./x-types.relatedpromptsrequest.md)<!-- -->, [RelatedPromptsResponse](./x-types.relatedpromptsresponse.md)<!-- -->> | |
|
|
23
24
|
| [relatedTags](./x-types.xcomponentsadapter.relatedtags.md) | | EndpointAdapter<[RelatedTagsRequest](./x-types.relatedtagsrequest.md)<!-- -->, [RelatedTagsResponse](./x-types.relatedtagsresponse.md)<!-- -->> | |
|
|
24
25
|
| [search](./x-types.xcomponentsadapter.search.md) | | EndpointAdapter<[SearchRequest](./x-types.searchrequest.md)<!-- -->, [SearchResponse](./x-types.searchresponse.md)<!-- -->> | |
|
|
25
26
|
| [semanticQueries](./x-types.xcomponentsadapter.semanticqueries.md) | | EndpointAdapter<[SemanticQueriesRequest](./x-types.semanticqueriesrequest.md)<!-- -->, [SemanticQueriesResponse](./x-types.semanticqueriesresponse.md)<!-- -->> | |
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-types](./x-types.md) > [XComponentsAdapter](./x-types.xcomponentsadapter.md) > [relatedPrompts](./x-types.xcomponentsadapter.relatedprompts.md)
|
|
4
|
+
|
|
5
|
+
## XComponentsAdapter.relatedPrompts property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
relatedPrompts: EndpointAdapter<RelatedPromptsRequest, RelatedPromptsResponse>;
|
|
11
|
+
```
|
|
@@ -13,8 +13,8 @@ Component to be reused that renders an `<img>`.
|
|
|
13
13
|
| Name | Description | Type | Default |
|
|
14
14
|
| --------------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------ |
|
|
15
15
|
| <code>result</code> | (Required) The @empathyco/x-types#Result information. | <code>Result</code> | <code></code> |
|
|
16
|
-
| <code>loadAnimation</code> | Animation to use when switching between the placeholder, the loaded image, or the failed<br />image fallback. | <code>
|
|
17
|
-
| <code>hoverAnimation</code> | Animation to use when switching between the loaded image and the hover image. | <code>
|
|
16
|
+
| <code>loadAnimation</code> | Animation to use when switching between the placeholder, the loaded image, or the failed<br />image fallback. | <code>AnimationProp</code> | <code>() => NoAnimation</code> |
|
|
17
|
+
| <code>hoverAnimation</code> | Animation to use when switching between the loaded image and the hover image. | <code>AnimationProp</code> | <code></code> |
|
|
18
18
|
| <code>showNextImageOnHover</code> | Indicates if the next valid image should be displayed on hover. | <code>boolean</code> | <code>false</code> |
|
|
19
19
|
|
|
20
20
|
## Slots
|
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
---
|
|
2
|
+
|
|
3
|
+
title: BaseSlider
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# BaseSlider
|
|
8
|
+
|
|
9
|
+
This component implements a range slider and prints the selected values. It receives a threshold
|
|
10
|
+
prop to set the limits and uses v-model to get and set the selected values.
|
|
11
|
+
|
|
12
|
+
It makes use of the nouslider library @see https://refreshless.com/nouislider/ for the slider
|
|
13
|
+
implementation.
|
|
14
|
+
|
|
15
|
+
## Props
|
|
16
|
+
|
|
17
|
+
| Name | Description | Type | Default |
|
|
18
|
+
| ------------------------- | ----------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------- |
|
|
19
|
+
| <code>threshold</code> | The threshold prop sets the limits for the slider. | <code>{ min: number; max: number }</code> | <code>() => ({ min: 0, max: Number.MAX_SAFE_INTEGER })</code> |
|
|
20
|
+
| <code>modelValue</code> | The modelValue prop sets the initial values for the slider. | <code>{ min: number; max: number }</code> | <code></code> |
|
|
21
|
+
| <code>contentClass</code> | Class to be able to customize slider styles. | <code>string</code> | <code>''</code> |
|
|
22
|
+
|
|
23
|
+
## Events
|
|
24
|
+
|
|
25
|
+
| Event name | Properties | Description |
|
|
26
|
+
| ----------------- | ---------- | ----------- |
|
|
27
|
+
| update:modelValue | |
|
|
28
|
+
|
|
29
|
+
## Slots
|
|
30
|
+
|
|
31
|
+
| Name | Description | Bindings<br />(name - type - description) |
|
|
32
|
+
| -------------------- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
|
|
33
|
+
| <code>default</code> | Default selected range rendering. This slot will be used by default for rendering | **rangeSelected** <code>number[]</code> - The selected range values. Min position 0, Max position 1. |
|
|
34
|
+
|
|
35
|
+
## Examples
|
|
36
|
+
|
|
37
|
+
This component renders a slider and the selected values. The component needs the threshold for the
|
|
38
|
+
slider, although is not required (If not passed, fallback is min: 0, max: Number.MAX_SAFE_INTEGER ),
|
|
39
|
+
which are passed using the `threshold` prop and the selected range, which is passed in using the
|
|
40
|
+
v-model.
|
|
41
|
+
|
|
42
|
+
### Default usage
|
|
43
|
+
|
|
44
|
+
It is required to send the value prop which holds the selected values.
|
|
45
|
+
|
|
46
|
+
```vue live
|
|
47
|
+
<template>
|
|
48
|
+
<BaseSlider v-model="selectedRange" />
|
|
49
|
+
</template>
|
|
50
|
+
|
|
51
|
+
<script>
|
|
52
|
+
import { BaseSlider } from '@empathyco/x-components';
|
|
53
|
+
|
|
54
|
+
export default {
|
|
55
|
+
name: 'BaseSliderDemo',
|
|
56
|
+
components: {
|
|
57
|
+
BaseSlider
|
|
58
|
+
},
|
|
59
|
+
setup() {
|
|
60
|
+
const selectedRange = ref({ min: 0, max: 1000 });
|
|
61
|
+
|
|
62
|
+
return {
|
|
63
|
+
selectedRange
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
};
|
|
67
|
+
</script>
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
#### With threshold
|
|
71
|
+
|
|
72
|
+
```vue live
|
|
73
|
+
<template>
|
|
74
|
+
<BaseSlider v-model="selectedRange" :threshold="threshold" />
|
|
75
|
+
</template>
|
|
76
|
+
|
|
77
|
+
<script>
|
|
78
|
+
import { BaseSlider } from '@empathyco/x-components';
|
|
79
|
+
|
|
80
|
+
export default {
|
|
81
|
+
name: 'BaseSliderDemo',
|
|
82
|
+
components: {
|
|
83
|
+
BaseSliderDemo
|
|
84
|
+
},
|
|
85
|
+
setup() {
|
|
86
|
+
const threshold = ref({ min: 0, max: 1000 });
|
|
87
|
+
const selectedRange = ref(threshold.value);
|
|
88
|
+
|
|
89
|
+
return {
|
|
90
|
+
selectedRange,
|
|
91
|
+
threshold
|
|
92
|
+
};
|
|
93
|
+
}
|
|
94
|
+
};
|
|
95
|
+
</script>
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Customized usage
|
|
99
|
+
|
|
100
|
+
#### Overriding the slots
|
|
101
|
+
|
|
102
|
+
It is possible to override the default slot to customize the layout for the selected values.
|
|
103
|
+
|
|
104
|
+
```vue live
|
|
105
|
+
<template>
|
|
106
|
+
<BaseSlider v-model="selectedRange" :threshold="threshold" v-slot="{ rangeSelected }">
|
|
107
|
+
<p class="x-base-slider__selected-min">
|
|
108
|
+
<span>min value</span>
|
|
109
|
+
<span>
|
|
110
|
+
{{ rangeSelected[0] }}
|
|
111
|
+
</span>
|
|
112
|
+
</p>
|
|
113
|
+
<p class="x-base-slider__selected-max">
|
|
114
|
+
<span>max value</span>
|
|
115
|
+
<span>
|
|
116
|
+
{{ rangeSelected[1] }}
|
|
117
|
+
</span>
|
|
118
|
+
</p>
|
|
119
|
+
</BaseSlider>
|
|
120
|
+
</template>
|
|
121
|
+
|
|
122
|
+
<script>
|
|
123
|
+
import { BaseSlider } from '@empathyco/x-components';
|
|
124
|
+
|
|
125
|
+
export default {
|
|
126
|
+
name: 'BaseSliderDemo',
|
|
127
|
+
components: {
|
|
128
|
+
BaseSliderDemo
|
|
129
|
+
},
|
|
130
|
+
setup() {
|
|
131
|
+
const threshold = ref({ min: 0, max: 1000 });
|
|
132
|
+
const selectedRange = ref(threshold.value);
|
|
133
|
+
|
|
134
|
+
return {
|
|
135
|
+
selectedRange,
|
|
136
|
+
threshold
|
|
137
|
+
};
|
|
138
|
+
}
|
|
139
|
+
};
|
|
140
|
+
</script>
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
It is also possible to add inputs to complement the slider and allow to change the selected values
|
|
144
|
+
manually.
|
|
145
|
+
|
|
146
|
+
```vue live
|
|
147
|
+
<template>
|
|
148
|
+
<BaseSlider v-model="selectedRange" :threshold="threshold">
|
|
149
|
+
<input
|
|
150
|
+
@change="selectedRange.min = $event.target?.valueAsNumber || 0"
|
|
151
|
+
class="x-input"
|
|
152
|
+
name="min"
|
|
153
|
+
type="number"
|
|
154
|
+
:value="selectedRange.min"
|
|
155
|
+
:aria-label="'min'"
|
|
156
|
+
/>
|
|
157
|
+
|
|
158
|
+
<input
|
|
159
|
+
@change="selectedRange.max = $event.target?.valueAsNumber || 1000000"
|
|
160
|
+
style="display: block"
|
|
161
|
+
class="x-input"
|
|
162
|
+
name="max"
|
|
163
|
+
type="number"
|
|
164
|
+
:value="selectedRange.max"
|
|
165
|
+
:aria-label="'max'"
|
|
166
|
+
/>
|
|
167
|
+
</BaseSlider>
|
|
168
|
+
</template>
|
|
169
|
+
|
|
170
|
+
<script>
|
|
171
|
+
import { BaseSlider } from '@empathyco/x-components';
|
|
172
|
+
|
|
173
|
+
export default {
|
|
174
|
+
name: 'BaseSliderDemo',
|
|
175
|
+
components: {
|
|
176
|
+
BaseSliderDemo
|
|
177
|
+
},
|
|
178
|
+
setup() {
|
|
179
|
+
const threshold = ref({ min: 0, max: 1000 });
|
|
180
|
+
const selectedRange = ref(threshold.value);
|
|
181
|
+
|
|
182
|
+
return {
|
|
183
|
+
selectedRange,
|
|
184
|
+
threshold
|
|
185
|
+
};
|
|
186
|
+
}
|
|
187
|
+
};
|
|
188
|
+
</script>
|
|
189
|
+
```
|
|
@@ -13,7 +13,7 @@ It renders a list of ListItem providing a slot for each `slotName` which depends
|
|
|
13
13
|
|
|
14
14
|
| Name | Description | Type | Default |
|
|
15
15
|
| ---------------------- | ---------------------------------------------------------- | -------------------------- | ----------------- |
|
|
16
|
-
| <code>animation</code> | Animation component that will be used to animate the list. | <code>
|
|
16
|
+
| <code>animation</code> | Animation component that will be used to animate the list. | <code>AnimationProp</code> | <code>'ul'</code> |
|
|
17
17
|
| <code>items</code> | List of items. | <code>ListItem[]</code> | <code></code> |
|
|
18
18
|
| <code>itemClass</code> | Item's classes. | <code>string</code> | <code></code> |
|
|
19
19
|
|
|
@@ -19,7 +19,7 @@ differently based on their purpose and this can be achieved using the exposed sl
|
|
|
19
19
|
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ----------------- |
|
|
20
20
|
| <code>facetsIds</code> | Array of facets ids used to get the selected filters for those facets. | <code>Array<Facet['id']></code> | <code></code> |
|
|
21
21
|
| <code>alwaysVisible</code> | Flag to render the component even if there are no filters selected. | <code>boolean</code> | <code></code> |
|
|
22
|
-
| <code>animation</code> | Animation component that will be used to animate the facets. | <code>
|
|
22
|
+
| <code>animation</code> | Animation component that will be used to animate the facets. | <code>AnimationProp</code> | <code>'ul'</code> |
|
|
23
23
|
| <code>renderableFacets</code> | Discriminates the facets rendered by this component. It expects a string containing facets<br />ids, comma separated. This property will include or exclude facets based on its value.<br />The default value is an empty string and the component will render all existing facets. | <code>string</code> | <code></code> |
|
|
24
24
|
|
|
25
25
|
## Slots
|
|
@@ -20,7 +20,7 @@ The property "alwaysVisible" handles if the component is rendered if no filters
|
|
|
20
20
|
| -------------------------- | --------------------------------------------------------------------------- | ------------------------------- | ----------------- |
|
|
21
21
|
| <code>facetsIds</code> | Array of facets ids used to get the selected filters for those facets. | <code>Array<Facet['id']></code> | <code></code> |
|
|
22
22
|
| <code>alwaysVisible</code> | Flag to render the component even if there are no filters selected. | <code>boolean</code> | <code></code> |
|
|
23
|
-
| <code>animation</code> | Animation component that will be used to animate the selected filters list. | <code>
|
|
23
|
+
| <code>animation</code> | Animation component that will be used to animate the selected filters list. | <code>AnimationProp</code> | <code>'ul'</code> |
|
|
24
24
|
|
|
25
25
|
## Slots
|
|
26
26
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
|
|
3
|
+
title: RelatedPrompt
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# RelatedPrompt
|
|
8
|
+
|
|
9
|
+
This component shows a suggested related prompt with the associated next queries. It allows to
|
|
10
|
+
select one of the next query and show it.
|
|
11
|
+
|
|
12
|
+
It provide slots to customize the header, the next queries list, the individual next query inside
|
|
13
|
+
the list and the selected query.
|
|
14
|
+
|
|
15
|
+
## Props
|
|
16
|
+
|
|
17
|
+
| Name | Description | Type | Default |
|
|
18
|
+
| --------------------------------- | ----------- | -------------------------- | -------------------------------- |
|
|
19
|
+
| <code>relatedPrompt</code> | | <code>RelatedPrompt</code> | <code></code> |
|
|
20
|
+
| <code>nextQueryButtonClass</code> | | <code>string</code> | <code>'x-button-outlined'</code> |
|
|
21
|
+
|
|
22
|
+
## Slots
|
|
23
|
+
|
|
24
|
+
| Name | Description | Bindings<br />(name - type - description) |
|
|
25
|
+
| --------------------------- | ----------- | ----------------------------------------- |
|
|
26
|
+
| <code>header</code> | | |
|
|
27
|
+
| <code>next-queries</code> | | |
|
|
28
|
+
| <code>next-query</code> | | |
|
|
29
|
+
| <code>selected-query</code> | | |
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
---
|
|
2
|
+
|
|
3
|
+
title: RelatedPromptsList
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# RelatedPromptsList
|
|
8
|
+
|
|
9
|
+
Component that inserts groups of related prompts in different positions of the injected search items
|
|
10
|
+
list, based on the provided configuration.
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
| Name | Description | Type | Default |
|
|
15
|
+
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------- | ---------------------- |
|
|
16
|
+
| <code>animation</code> | Animation component that will be used to animate the related prompts groups. | <code>AnimationProp</code> | <code>'ul'</code> |
|
|
17
|
+
| <code>offset</code> | The first index to insert a group of related prompts at. | <code>number</code> | <code>24</code> |
|
|
18
|
+
| <code>frequency</code> | The items cycle size to keep inserting related prompts groups at. | <code>number</code> | <code>24</code> |
|
|
19
|
+
| <code>maxRelatedPromptsPerGroup</code> | The maximum amount of related prompts to add in a single group. | <code>number</code> | <code>4</code> |
|
|
20
|
+
| <code>maxGroups</code> | The maximum number of groups to insert into the injected list items list. | <code>number</code> | <code>undefined</code> |
|
|
21
|
+
| <code>showOnlyAfterOffset</code> | Determines if a group is added to the injected items list in case the number<br />of items is smaller than the offset. | <code>boolean</code> | <code>false</code> |
|
|
22
|
+
|
|
23
|
+
## Events
|
|
24
|
+
|
|
25
|
+
This component emits no events.
|
|
26
|
+
|
|
27
|
+
## See it in action
|
|
28
|
+
|
|
29
|
+
<!-- prettier-ignore-start -->
|
|
30
|
+
|
|
31
|
+
:::warning Backend microservice required To use this component, the <b>QuerySignals</b> microservice
|
|
32
|
+
must be implemented. :::
|
|
33
|
+
|
|
34
|
+
<!-- prettier-ignore-end -->
|
|
35
|
+
|
|
36
|
+
Usually, this component is going to be used together with the `ResultsList` one. Related prompts
|
|
37
|
+
groups will be inserted between the results, guiding users to discover new searches directly from
|
|
38
|
+
the results list.
|
|
39
|
+
|
|
40
|
+
```vue live
|
|
41
|
+
<template>
|
|
42
|
+
<div>
|
|
43
|
+
<SearchInput />
|
|
44
|
+
<ResultsList>
|
|
45
|
+
<RelatedPromptsList />
|
|
46
|
+
</ResultsList>
|
|
47
|
+
</div>
|
|
48
|
+
</template>
|
|
49
|
+
|
|
50
|
+
<script>
|
|
51
|
+
import { RelatedPromptsList } from '@empathyco/x-components/related-prompts';
|
|
52
|
+
import { ResultsList } from '@empathyco/x-components/search';
|
|
53
|
+
import { SearchInput } from '@empathyco/x-components/search-box';
|
|
54
|
+
|
|
55
|
+
export default {
|
|
56
|
+
name: 'RelatedPromptsListDemo',
|
|
57
|
+
components: {
|
|
58
|
+
RelatedPromptsList,
|
|
59
|
+
ResultsList,
|
|
60
|
+
SearchInput
|
|
61
|
+
}
|
|
62
|
+
};
|
|
63
|
+
</script>
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Play with the index that related prompts groups are inserted at
|
|
67
|
+
|
|
68
|
+
The component allows to customise where are the related prompts groups inserted. In the following
|
|
69
|
+
example, the first group of related prompts will be inserted at the index `48` (`offset`), and then
|
|
70
|
+
a second group will be inserted at index `120` because of the `frequency` prop configured to `72`.
|
|
71
|
+
Finally, a third group will be inserted at index `192`. Because `maxGroups` is configured to `3`, no
|
|
72
|
+
more groups will be inserted. Each one of this groups will have up to `6` related prompts
|
|
73
|
+
(`maxRelatedPromptsPerGroup`).
|
|
74
|
+
|
|
75
|
+
```vue live
|
|
76
|
+
<template>
|
|
77
|
+
<div>
|
|
78
|
+
<SearchInput />
|
|
79
|
+
<ResultsList>
|
|
80
|
+
<RelatedPromptsList
|
|
81
|
+
:offset="48"
|
|
82
|
+
:frequency="72"
|
|
83
|
+
:maxRelatedPromptsPerGroup="6"
|
|
84
|
+
:maxGroups="3"
|
|
85
|
+
/>
|
|
86
|
+
</ResultsList>
|
|
87
|
+
</div>
|
|
88
|
+
</template>
|
|
89
|
+
|
|
90
|
+
<script>
|
|
91
|
+
import { RelatedPromptsList } from '@empathyco/x-components/related-prompts';
|
|
92
|
+
import { ResultsList } from '@empathyco/x-components/search';
|
|
93
|
+
import { SearchInput } from '@empathyco/x-components/search-box';
|
|
94
|
+
|
|
95
|
+
export default {
|
|
96
|
+
name: 'RelatedPromptsListDemo',
|
|
97
|
+
components: {
|
|
98
|
+
RelatedPromptsList,
|
|
99
|
+
ResultsList,
|
|
100
|
+
SearchInput
|
|
101
|
+
}
|
|
102
|
+
};
|
|
103
|
+
</script>
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Showing/hiding first related prompts group when no more items
|
|
107
|
+
|
|
108
|
+
By default, the first related prompts group will be inserted when the total number of results is
|
|
109
|
+
smaller than the offset, but this behavior can be deactivated by setting the `showOnlyAfterOffset`
|
|
110
|
+
to `true`.
|
|
111
|
+
|
|
112
|
+
```vue live
|
|
113
|
+
<template>
|
|
114
|
+
<div>
|
|
115
|
+
<SearchInput />
|
|
116
|
+
<ResultsList>
|
|
117
|
+
<RelatedPromptsList
|
|
118
|
+
:offset="48"
|
|
119
|
+
:frequency="72"
|
|
120
|
+
:maxRelatedPromptsPerGroup="1"
|
|
121
|
+
:showOnlyAfterOffset="true"
|
|
122
|
+
/>
|
|
123
|
+
</ResultsList>
|
|
124
|
+
</div>
|
|
125
|
+
</template>
|
|
126
|
+
|
|
127
|
+
<script>
|
|
128
|
+
import { RelatedPromptsList } from '@empathyco/x-components/related-prompts';
|
|
129
|
+
import { ResultsList } from '@empathyco/x-components/search';
|
|
130
|
+
import { SearchInput } from '@empathyco/x-components/search-box';
|
|
131
|
+
|
|
132
|
+
export default {
|
|
133
|
+
name: 'RelatedPromptsListDemo',
|
|
134
|
+
components: {
|
|
135
|
+
RelatedPromptsList,
|
|
136
|
+
ResultsList,
|
|
137
|
+
SearchInput
|
|
138
|
+
}
|
|
139
|
+
};
|
|
140
|
+
</script>
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Customise the layout of the component
|
|
144
|
+
|
|
145
|
+
This component will render by default the `id` of each search item, both the injected, and for the
|
|
146
|
+
groups of related prompts generated, but the common case is to integrate it with another layout
|
|
147
|
+
component, for example the `BaseGrid`. To do so, you can use the `default` slot
|
|
148
|
+
|
|
149
|
+
```vue
|
|
150
|
+
<template>
|
|
151
|
+
<div>
|
|
152
|
+
<SearchInput />
|
|
153
|
+
<ResultsList>
|
|
154
|
+
<RelatedPromptsList
|
|
155
|
+
:offset="48"
|
|
156
|
+
:frequency="72"
|
|
157
|
+
:maxRelatedPromptsPerGroup="6"
|
|
158
|
+
:maxGroups="3"
|
|
159
|
+
#default="{ items }"
|
|
160
|
+
>
|
|
161
|
+
<BaseGrid :items="items" :animation="animation">
|
|
162
|
+
<template #related-prompts-group="{ item }">
|
|
163
|
+
<span v-for="const prompt of items.relatedPrompts">
|
|
164
|
+
RelatedPromptsGroup:
|
|
165
|
+
<pre>{{ prompt }}</pre>
|
|
166
|
+
</span>
|
|
167
|
+
</template>
|
|
168
|
+
<template #result="{ item }">
|
|
169
|
+
<span>Result: {{ item.name }}</span>
|
|
170
|
+
</template>
|
|
171
|
+
<template #default="{ item }">
|
|
172
|
+
<span>Default: {{ item }}</span>
|
|
173
|
+
</template>
|
|
174
|
+
</BaseGrid>
|
|
175
|
+
</RelatedPromptsList>
|
|
176
|
+
</ResultsList>
|
|
177
|
+
</div>
|
|
178
|
+
</template>
|
|
179
|
+
|
|
180
|
+
<script>
|
|
181
|
+
import { RelatedPromptsList } from '@empathyco/x-components/related-prompts';
|
|
182
|
+
import { ResultsList } from '@empathyco/x-components/search';
|
|
183
|
+
import { SearchInput } from '@empathyco/x-components/search-box';
|
|
184
|
+
import { BaseGrid } from '@empathyco/x-components';
|
|
185
|
+
|
|
186
|
+
export default {
|
|
187
|
+
name: 'RelatedPromptsListDemo',
|
|
188
|
+
components: {
|
|
189
|
+
RelatedPromptsLis,
|
|
190
|
+
ResultsList,
|
|
191
|
+
BaseGrid,
|
|
192
|
+
SearchInput
|
|
193
|
+
}
|
|
194
|
+
};
|
|
195
|
+
</script>
|
|
196
|
+
```
|
|
@@ -17,7 +17,7 @@ result bound.
|
|
|
17
17
|
|
|
18
18
|
| Name | Description | Type | Default |
|
|
19
19
|
| ---------------------- | ------------------------------------------------------------- | -------------------------- | ----------------- |
|
|
20
|
-
| <code>animation</code> | Animation component that will be used to animate the results. | <code>
|
|
20
|
+
| <code>animation</code> | Animation component that will be used to animate the results. | <code>AnimationProp</code> | <code>'ul'</code> |
|
|
21
21
|
|
|
22
22
|
## Events
|
|
23
23
|
|
|
@@ -17,8 +17,8 @@ It allows you to activate or deactivate the session id management through the `c
|
|
|
17
17
|
| <code>clickedResultStorageTTLMs</code> | The TTL in milliseconds for storing the clicked result info. | <code>number</code> | <code>30000</code> |
|
|
18
18
|
| <code>clickedResultStorageKey</code> | The Object key of the @empathyco/x-types#Result clicked by the user<br />that will be used as id for the storage. By default, the Result url will be used. | <code>string</code> | <code>'url'</code> |
|
|
19
19
|
| <code>sessionTTLMs</code> | The session TTL in milliseconds. | <code>number</code> | <code></code> |
|
|
20
|
-
| <code>queryTaggingDebounceMs</code> | The debounce time in milliseconds to track the query. | <code>number</code> | <code
|
|
21
|
-
| <code>consent</code> | The consent to be emitted. | <code>boolean</code> | <code
|
|
20
|
+
| <code>queryTaggingDebounceMs</code> | The debounce time in milliseconds to track the query. | <code>number</code> | <code>2000</code> |
|
|
21
|
+
| <code>consent</code> | The consent to be emitted. | <code>boolean</code> | <code>null</code> |
|
|
22
22
|
|
|
23
23
|
## Events
|
|
24
24
|
|