@empathyco/x-components 7.3.1 → 7.4.1
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 +15 -0
- package/browse/index.d.ts +1 -0
- package/browse/index.js +15 -0
- package/core/index.js.map +1 -1
- package/docs/API-reference/api/x-components.basexapi.browse.md +54 -0
- package/docs/API-reference/api/x-components.basexapi.md +14 -0
- package/docs/API-reference/api/x-components.browseactioncontext.md +15 -0
- package/docs/API-reference/api/x-components.browseactions.cancelfetchandsavebrowseresponse.md +13 -0
- package/docs/API-reference/api/x-components.browseactions.fetchandsavebrowseresponse.md +13 -0
- package/docs/API-reference/api/x-components.browseactions.fetchandsaveresultsenrichment.md +13 -0
- package/docs/API-reference/api/x-components.browseactions.fetchbrowseresponse.md +13 -0
- package/docs/API-reference/api/x-components.browseactions.increasepageappendingresults.md +18 -0
- package/docs/API-reference/api/x-components.browseactions.md +210 -0
- package/docs/API-reference/api/x-components.browseactions.resetrequestonrefinement.md +13 -0
- package/docs/API-reference/api/x-components.browseactions.savebrowseresponse.md +13 -0
- package/docs/API-reference/api/x-components.browseactions.saveorigin.md +13 -0
- package/docs/API-reference/api/x-components.browseactions.seturlparams.md +13 -0
- package/docs/API-reference/api/x-components.browseconfig.md +75 -0
- package/docs/API-reference/api/x-components.browseconfig.pagemode.md +11 -0
- package/docs/API-reference/api/x-components.browseconfig.pagesize.md +13 -0
- package/docs/API-reference/api/x-components.browsegetters.md +58 -0
- package/docs/API-reference/api/x-components.browsegetters.request.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.appendresults.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.md +458 -0
- package/docs/API-reference/api/x-components.browsemutations.resetstate.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.resetstateforreload.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setbanners.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setbrowsetagging.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setdisplaybrowsetagging.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setfacets.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setfromnoresultswithfilters.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setisappendresults.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setisnoresults.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setorigin.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setpage.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setparams.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setpromoteds.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setresults.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setselectedcategory.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setselectedfilters.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setsort.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.setstats.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.settotalresults.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.updateresult.md +13 -0
- package/docs/API-reference/api/x-components.browsemutations.updateresultsfromenrichment.md +13 -0
- package/docs/API-reference/api/x-components.browserequest.md +13 -0
- package/docs/API-reference/api/x-components.browseresultslist.md +31 -0
- package/docs/API-reference/api/x-components.browsesortpickerlist.md +45 -0
- package/docs/API-reference/api/x-components.browsestate.banners.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.browsetagging.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.config.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.displaybrowsetagging.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.facets.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.fromnoresultswithfilters.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.isappendresults.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.isnoresults.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.md +382 -0
- package/docs/API-reference/api/x-components.browsestate.origin.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.page.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.params.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.promoteds.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.results.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.selectedcategory.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.selectedfilters.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.sort.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.stats.md +13 -0
- package/docs/API-reference/api/x-components.browsestate.totalresults.md +13 -0
- package/docs/API-reference/api/x-components.browsexevents.browserequestchanged.md +13 -0
- package/docs/API-reference/api/x-components.browsexevents.browserequestupdated.md +18 -0
- package/docs/API-reference/api/x-components.browsexevents.browseresponsechanged.md +13 -0
- package/docs/API-reference/api/x-components.browsexevents.browsetaggingchanged.md +13 -0
- package/docs/API-reference/api/x-components.browsexevents.md +172 -0
- package/docs/API-reference/api/x-components.browsexevents.selectedbrowsesortprovided.md +18 -0
- package/docs/API-reference/api/x-components.browsexevents.userbrowsedtocategory.md +13 -0
- package/docs/API-reference/api/x-components.browsexevents.userclickedabrowsesort.md +13 -0
- package/docs/API-reference/api/x-components.browsexmodule.md +13 -0
- package/docs/API-reference/api/x-components.browsexstoremodule.md +15 -0
- package/docs/API-reference/api/x-components.cancelfetchandsavebrowseresponse.md +17 -0
- package/docs/API-reference/api/x-components.cancelfetchandsavebrowseresponsewire.md +13 -0
- package/docs/API-reference/api/x-components.clearbrowsequery.md +13 -0
- package/docs/API-reference/api/x-components.fetchandsavebrowseresponse.md +66 -0
- package/docs/API-reference/api/x-components.fetchandsavebrowseresponsewire.md +13 -0
- package/docs/API-reference/api/x-components.fetchandsavebrowseresultsenrichment.md +66 -0
- package/docs/API-reference/api/x-components.fetchandsavebrowseresultsenrichmentwire.md +13 -0
- package/docs/API-reference/api/x-components.fetchbrowseresponse.md +13 -0
- package/docs/API-reference/api/x-components.hierarchicalfilter.md +7 -0
- package/docs/API-reference/api/x-components.increasebrowsepageappendingresults.md +13 -0
- package/docs/API-reference/api/x-components.increasebrowsepageappendingresultswire.md +13 -0
- package/docs/API-reference/api/x-components.internalbrowserequest.md +59 -0
- package/docs/API-reference/api/x-components.internalbrowserequest.page.md +13 -0
- package/docs/API-reference/api/x-components.internalbrowseresponse.md +78 -0
- package/docs/API-reference/api/x-components.internalbrowseresponse.request.md +13 -0
- package/docs/API-reference/api/x-components.internalbrowseresponse.status.md +13 -0
- package/docs/API-reference/api/x-components.md +499 -0
- package/docs/API-reference/api/x-components.resetbrowseappending.md +13 -0
- package/docs/API-reference/api/x-components.resetbrowserequestonrefinement.md +13 -0
- package/docs/API-reference/api/x-components.resetbrowserequestonrefinementwire.md +13 -0
- package/docs/API-reference/api/x-components.resetbrowsestateforreloadwire.md +13 -0
- package/docs/API-reference/api/x-components.resetbrowsestateifnorequestwire.md +13 -0
- package/docs/API-reference/api/x-components.resetfromnobrowseresultswithfilters.md +13 -0
- package/docs/API-reference/api/x-components.resetisnobrowseresults.md +13 -0
- package/docs/API-reference/api/x-components.reseturlbrowsecategory.md +13 -0
- package/docs/API-reference/api/x-components.savebrowseorigin.md +13 -0
- package/docs/API-reference/api/x-components.savebrowseoriginwire.md +13 -0
- package/docs/API-reference/api/x-components.savebrowseresponse.md +13 -0
- package/docs/API-reference/api/x-components.setbrowsecategory.md +13 -0
- package/docs/API-reference/api/x-components.setbrowseextraparams.md +13 -0
- package/docs/API-reference/api/x-components.setbrowsepage.md +13 -0
- package/docs/API-reference/api/x-components.setbrowseselectedfilters.md +13 -0
- package/docs/API-reference/api/x-components.setbrowsesort.md +13 -0
- package/docs/API-reference/api/x-components.setbrowseurlparams.md +13 -0
- package/docs/API-reference/api/x-components.setbrowseurlparamswire.md +13 -0
- package/docs/API-reference/api/x-components.seturlbrowsecategory.md +13 -0
- package/docs/API-reference/api/x-components.simplefilter.md +7 -0
- package/docs/API-reference/api/x-components.snippetcallbacks.md +7 -0
- package/docs/API-reference/api/x-components.urlmutations.md +19 -0
- package/docs/API-reference/api/x-components.urlmutations.setbrowsecategory.md +13 -0
- package/docs/API-reference/api/x-components.urlparams.browsefield.md +11 -0
- package/docs/API-reference/api/x-components.urlparams.browsevalue.md +11 -0
- package/docs/API-reference/api/x-components.urlparams.md +34 -0
- package/docs/API-reference/api/x-components.usealiasapi.browsetotalresults.md +13 -0
- package/docs/API-reference/api/x-components.usealiasapi.md +21 -0
- package/docs/API-reference/api/x-components.watchedinternalbrowserequest.md +73 -0
- package/docs/API-reference/api/x-components.watchedinternalbrowserequest.newrequest.md +11 -0
- package/docs/API-reference/api/x-components.watchedinternalbrowserequest.oldrequest.md +11 -0
- package/docs/API-reference/api/x-components.xapi.browse.md +13 -0
- package/docs/API-reference/api/x-components.xapi.md +19 -0
- package/docs/API-reference/api/x-components.xeventstypes.md +2 -2
- package/docs/API-reference/api/x-components.xmodulestree.browse.md +11 -0
- package/docs/API-reference/api/x-components.xmodulestree.md +17 -0
- package/docs/API-reference/api/x-types.xcomponentsadapter.browse.md +11 -0
- package/docs/API-reference/api/x-types.xcomponentsadapter.md +17 -0
- package/docs/API-reference/components/browse/x-components.browse-results-list.md +21 -0
- package/docs/API-reference/components/browse/x-components.browse-sort-picker-list.md +24 -0
- package/js/composables/use-alias-api.js +3 -0
- package/js/composables/use-alias-api.js.map +1 -1
- package/js/index.js +16 -1
- package/js/index.js.map +1 -1
- package/js/wiring/namespaced-wires.factory.js +1 -1
- package/js/x-installer/api/base-api.js +12 -0
- package/js/x-installer/api/base-api.js.map +1 -1
- package/js/x-modules/browse/components/browse-results-list.vue.js +46 -0
- package/js/x-modules/browse/components/browse-results-list.vue.js.map +1 -0
- package/js/x-modules/browse/components/browse-results-list.vue2.js +6 -0
- package/js/x-modules/browse/components/browse-results-list.vue2.js.map +1 -0
- package/js/x-modules/browse/components/browse-sort-picker-list.vue.js +73 -0
- package/js/x-modules/browse/components/browse-sort-picker-list.vue.js.map +1 -0
- package/js/x-modules/browse/components/browse-sort-picker-list.vue2.js +6 -0
- package/js/x-modules/browse/components/browse-sort-picker-list.vue2.js.map +1 -0
- package/js/x-modules/browse/store/actions/fetch-and-save-browse-response.action.js +57 -0
- package/js/x-modules/browse/store/actions/fetch-and-save-browse-response.action.js.map +1 -0
- package/js/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.js +21 -0
- package/js/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.js.map +1 -0
- package/js/x-modules/browse/store/actions/fetch-browse-response.action.js +16 -0
- package/js/x-modules/browse/store/actions/fetch-browse-response.action.js.map +1 -0
- package/js/x-modules/browse/store/actions/increase-page-apending-results.action.js +18 -0
- package/js/x-modules/browse/store/actions/increase-page-apending-results.action.js.map +1 -0
- package/js/x-modules/browse/store/actions/reset-request-on-refinement.action.js +36 -0
- package/js/x-modules/browse/store/actions/reset-request-on-refinement.action.js.map +1 -0
- package/js/x-modules/browse/store/actions/save-browse-response.action.js +42 -0
- package/js/x-modules/browse/store/actions/save-browse-response.action.js.map +1 -0
- package/js/x-modules/browse/store/actions/save-origin.action.js +16 -0
- package/js/x-modules/browse/store/actions/save-origin.action.js.map +1 -0
- package/js/x-modules/browse/store/actions/set-url-params.action.js +20 -0
- package/js/x-modules/browse/store/actions/set-url-params.action.js.map +1 -0
- package/js/x-modules/browse/store/emitters.js +48 -0
- package/js/x-modules/browse/store/emitters.js.map +1 -0
- package/js/x-modules/browse/store/getters/request.getter.js +27 -0
- package/js/x-modules/browse/store/getters/request.getter.js.map +1 -0
- package/js/x-modules/browse/store/module.js +163 -0
- package/js/x-modules/browse/store/module.js.map +1 -0
- package/js/x-modules/browse/wiring.js +213 -0
- package/js/x-modules/browse/wiring.js.map +1 -0
- package/js/x-modules/browse/x-module.js +21 -0
- package/js/x-modules/browse/x-module.js.map +1 -0
- package/js/x-modules/url/components/url-handler.vue.js.map +1 -1
- package/js/x-modules/url/components/url-handler.vue2.js +4 -1
- package/js/x-modules/url/components/url-handler.vue2.js.map +1 -1
- package/js/x-modules/url/store/initial-state.js +2 -0
- package/js/x-modules/url/store/initial-state.js.map +1 -1
- package/js/x-modules/url/store/module.js +4 -0
- package/js/x-modules/url/store/module.js.map +1 -1
- package/js/x-modules/url/wiring.js +34 -1
- package/js/x-modules/url/wiring.js.map +1 -1
- package/package.json +4 -4
- package/report/x-components.api.json +4505 -192
- package/report/x-components.api.md +432 -6
- package/report/x-types.api.json +50 -0
- package/types/src/components/snippet-callbacks.vue.d.ts +7 -0
- package/types/src/components/snippet-callbacks.vue.d.ts.map +1 -1
- package/types/src/composables/use-alias-api.d.ts +2 -0
- package/types/src/composables/use-alias-api.d.ts.map +1 -1
- package/types/src/index.d.ts +1 -0
- package/types/src/index.d.ts.map +1 -1
- package/types/src/types/url-params.d.ts +2 -0
- package/types/src/types/url-params.d.ts.map +1 -1
- package/types/src/wiring/events.types.d.ts +2 -1
- package/types/src/wiring/events.types.d.ts.map +1 -1
- package/types/src/x-installer/api/api.types.d.ts +9 -0
- package/types/src/x-installer/api/api.types.d.ts.map +1 -1
- package/types/src/x-installer/api/base-api.d.ts +9 -0
- package/types/src/x-installer/api/base-api.d.ts.map +1 -1
- package/types/src/x-modules/browse/components/browse-results-list.vue.d.ts +30 -0
- package/types/src/x-modules/browse/components/browse-results-list.vue.d.ts.map +1 -0
- package/types/src/x-modules/browse/components/browse-sort-picker-list.vue.d.ts +50 -0
- package/types/src/x-modules/browse/components/browse-sort-picker-list.vue.d.ts.map +1 -0
- package/types/src/x-modules/browse/components/index.d.ts +3 -0
- package/types/src/x-modules/browse/components/index.d.ts.map +1 -0
- package/types/src/x-modules/browse/config.types.d.ts +14 -0
- package/types/src/x-modules/browse/config.types.d.ts.map +1 -0
- package/types/src/x-modules/browse/events.types.d.ts +55 -0
- package/types/src/x-modules/browse/events.types.d.ts.map +1 -0
- package/types/src/x-modules/browse/index.d.ts +8 -0
- package/types/src/x-modules/browse/index.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/actions/fetch-and-save-browse-response.action.d.ts +15 -0
- package/types/src/x-modules/browse/store/actions/fetch-and-save-browse-response.action.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.d.ts +17 -0
- package/types/src/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/actions/fetch-browse-response.action.d.ts +13 -0
- package/types/src/x-modules/browse/store/actions/fetch-browse-response.action.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/actions/increase-page-apending-results.action.d.ts +11 -0
- package/types/src/x-modules/browse/store/actions/increase-page-apending-results.action.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/actions/index.d.ts +9 -0
- package/types/src/x-modules/browse/store/actions/index.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/actions/reset-request-on-refinement.action.d.ts +11 -0
- package/types/src/x-modules/browse/store/actions/reset-request-on-refinement.action.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/actions/save-browse-response.action.d.ts +11 -0
- package/types/src/x-modules/browse/store/actions/save-browse-response.action.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/actions/save-origin.action.d.ts +11 -0
- package/types/src/x-modules/browse/store/actions/save-origin.action.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/actions/set-url-params.action.d.ts +11 -0
- package/types/src/x-modules/browse/store/actions/set-url-params.action.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/emitters.d.ts +35 -0
- package/types/src/x-modules/browse/store/emitters.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/getters/index.d.ts +2 -0
- package/types/src/x-modules/browse/store/getters/index.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/getters/request.getter.d.ts +13 -0
- package/types/src/x-modules/browse/store/getters/request.getter.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/index.d.ts +6 -0
- package/types/src/x-modules/browse/store/index.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/module.d.ts +41 -0
- package/types/src/x-modules/browse/store/module.d.ts.map +1 -0
- package/types/src/x-modules/browse/store/types.d.ts +273 -0
- package/types/src/x-modules/browse/store/types.d.ts.map +1 -0
- package/types/src/x-modules/browse/types.d.ts +35 -0
- package/types/src/x-modules/browse/types.d.ts.map +1 -0
- package/types/src/x-modules/browse/wiring.d.ts +172 -0
- package/types/src/x-modules/browse/wiring.d.ts.map +1 -0
- package/types/src/x-modules/browse/x-module.d.ts +16 -0
- package/types/src/x-modules/browse/x-module.d.ts.map +1 -0
- package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts +7 -0
- package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts.map +1 -1
- package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts +7 -0
- package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts.map +1 -1
- package/types/src/x-modules/url/components/url-handler.vue.d.ts.map +1 -1
- package/types/src/x-modules/url/store/initial-state.d.ts.map +1 -1
- package/types/src/x-modules/url/store/module.d.ts.map +1 -1
- package/types/src/x-modules/url/store/types.d.ts +7 -1
- package/types/src/x-modules/url/store/types.d.ts.map +1 -1
- package/types/src/x-modules/url/wiring.d.ts +30 -0
- package/types/src/x-modules/url/wiring.d.ts.map +1 -1
- package/types/src/x-modules/x-modules.types.d.ts +2 -0
- package/types/src/x-modules/x-modules.types.d.ts.map +1 -1
- package/url/index.js +1 -1
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [resetIsNoBrowseResults](./x-components.resetisnobrowseresults.md)
|
|
4
|
+
|
|
5
|
+
## resetIsNoBrowseResults variable
|
|
6
|
+
|
|
7
|
+
Resets the browse state `isNoResults`<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
resetIsNoBrowseResults: import("../../wiring").AnyWire
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [resetUrlBrowseCategory](./x-components.reseturlbrowsecategory.md)
|
|
4
|
+
|
|
5
|
+
## resetUrlBrowseCategory variable
|
|
6
|
+
|
|
7
|
+
Sets the browseCategory of the url module.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
resetUrlBrowseCategory: import("../..").AnyWire
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [saveBrowseOrigin](./x-components.savebrowseorigin.md)
|
|
4
|
+
|
|
5
|
+
## saveBrowseOrigin variable
|
|
6
|
+
|
|
7
|
+
Default implementation for the [BrowseActions.saveOrigin](./x-components.browseactions.saveorigin.md)<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
saveOrigin: BrowseXStoreModule['actions']['saveOrigin']
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [saveBrowseOriginWire](./x-components.savebrowseoriginwire.md)
|
|
4
|
+
|
|
5
|
+
## saveBrowseOriginWire variable
|
|
6
|
+
|
|
7
|
+
Sets the browse state `origin`<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
saveBrowseOriginWire: import("../../wiring").AnyWire
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [saveBrowseResponse](./x-components.savebrowseresponse.md)
|
|
4
|
+
|
|
5
|
+
## saveBrowseResponse variable
|
|
6
|
+
|
|
7
|
+
Default implementation for the [BrowseActions.saveBrowseResponse](./x-components.browseactions.savebrowseresponse.md)<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
saveBrowseResponse: BrowseXStoreModule['actions']['saveBrowseResponse']
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setBrowseCategory](./x-components.setbrowsecategory.md)
|
|
4
|
+
|
|
5
|
+
## setBrowseCategory variable
|
|
6
|
+
|
|
7
|
+
Sets the browse state `selectedCategory`<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setBrowseCategory: import("../../wiring").Wire<import("@empathyco/x-types").BrowsableRequest>
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setBrowseExtraParams](./x-components.setbrowseextraparams.md)
|
|
4
|
+
|
|
5
|
+
## setBrowseExtraParams variable
|
|
6
|
+
|
|
7
|
+
Sets the browse state `params`<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setBrowseExtraParams: import("../../wiring").Wire<import("@empathyco/x-utils").Dictionary<unknown>>
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setBrowsePage](./x-components.setbrowsepage.md)
|
|
4
|
+
|
|
5
|
+
## setBrowsePage variable
|
|
6
|
+
|
|
7
|
+
Sets the browse state `page`<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setBrowsePage: import("../../wiring").Wire<number>
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setBrowseSelectedFilters](./x-components.setbrowseselectedfilters.md)
|
|
4
|
+
|
|
5
|
+
## setBrowseSelectedFilters variable
|
|
6
|
+
|
|
7
|
+
Sets the browse state `selectedFilters`<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setBrowseSelectedFilters: import("../../wiring").Wire<import("@empathyco/x-types").Filter[]>
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setBrowseSort](./x-components.setbrowsesort.md)
|
|
4
|
+
|
|
5
|
+
## setBrowseSort variable
|
|
6
|
+
|
|
7
|
+
Sets the browse state `sort`<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setBrowseSort: import("../../wiring").Wire<string>
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setBrowseUrlParams](./x-components.setbrowseurlparams.md)
|
|
4
|
+
|
|
5
|
+
## setBrowseUrlParams variable
|
|
6
|
+
|
|
7
|
+
Default implementation for the [BrowseActions.setUrlParams](./x-components.browseactions.seturlparams.md)<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setUrlParams: BrowseXStoreModule['actions']['setUrlParams']
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setBrowseUrlParamsWire](./x-components.setbrowseurlparamswire.md)
|
|
4
|
+
|
|
5
|
+
## setBrowseUrlParamsWire variable
|
|
6
|
+
|
|
7
|
+
Sets the browse state `query`<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setBrowseUrlParamsWire: import("../../wiring").Wire<import("../..").UrlParams>
|
|
13
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setUrlBrowseCategory](./x-components.seturlbrowsecategory.md)
|
|
4
|
+
|
|
5
|
+
## setUrlBrowseCategory variable
|
|
6
|
+
|
|
7
|
+
Sets the browseCategory of the url module.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setUrlBrowseCategory: import("../..").Wire<import("@empathyco/x-types").BrowsableRequest>
|
|
13
|
+
```
|
|
@@ -166,6 +166,13 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
166
166
|
UserClickedABanner?: import("@empathyco/x-types").Banner | undefined;
|
|
167
167
|
UserClickedAbortARedirection?: void | undefined;
|
|
168
168
|
UserSelectedAPage?: number | undefined;
|
|
169
|
+
BrowseRequestChanged?: import("../../../browse").InternalBrowseRequest | null | undefined;
|
|
170
|
+
BrowseRequestUpdated?: import("../../../browse").InternalBrowseRequest | null | undefined;
|
|
171
|
+
BrowseResponseChanged?: import("../../../browse").InternalBrowseResponse | undefined;
|
|
172
|
+
BrowseTaggingChanged?: import("@empathyco/x-types").TaggingRequest | undefined;
|
|
173
|
+
UserClickedABrowseSort?: string | undefined;
|
|
174
|
+
SelectedBrowseSortProvided?: string | undefined;
|
|
175
|
+
UserBrowsedToCategory?: import("@empathyco/x-types").BrowsableRequest | undefined;
|
|
169
176
|
SemanticQueryRequestUpdated?: import("@empathyco/x-types").SemanticQueriesRequest | null | undefined;
|
|
170
177
|
SemanticQueriesResponseChanged?: import("@empathyco/x-types").SemanticQuery[] | undefined;
|
|
171
178
|
UserSelectedASemanticQuery?: import("@empathyco/x-types").SemanticQuery | undefined;
|
|
@@ -156,6 +156,13 @@ _default: import("vue").DefineComponent<{}, {
|
|
|
156
156
|
UserClickedABanner: (payload: import("@empathyco/x-types").Banner, metadata: WireMetadata) => unknown;
|
|
157
157
|
UserClickedAbortARedirection: (payload: undefined, metadata: WireMetadata) => unknown;
|
|
158
158
|
UserSelectedAPage: (payload: number, metadata: WireMetadata) => unknown;
|
|
159
|
+
BrowseRequestChanged: (payload: import("..").InternalBrowseRequest | null, metadata: WireMetadata) => unknown;
|
|
160
|
+
BrowseRequestUpdated: (payload: import("..").InternalBrowseRequest | null, metadata: WireMetadata) => unknown;
|
|
161
|
+
BrowseResponseChanged: (payload: import("..").InternalBrowseResponse, metadata: WireMetadata) => unknown;
|
|
162
|
+
BrowseTaggingChanged: (payload: import("@empathyco/x-types").TaggingRequest, metadata: WireMetadata) => unknown;
|
|
163
|
+
UserClickedABrowseSort: (payload: string, metadata: WireMetadata) => unknown;
|
|
164
|
+
SelectedBrowseSortProvided: (payload: string, metadata: WireMetadata) => unknown;
|
|
165
|
+
UserBrowsedToCategory: (payload: import("@empathyco/x-types").BrowsableRequest, metadata: WireMetadata) => unknown;
|
|
159
166
|
SemanticQueryRequestUpdated: (payload: import("@empathyco/x-types").SemanticQueriesRequest | null, metadata: WireMetadata) => unknown;
|
|
160
167
|
SemanticQueriesResponseChanged: (payload: import("@empathyco/x-types").SemanticQuery[], metadata: WireMetadata) => unknown;
|
|
161
168
|
UserSelectedASemanticQuery: (payload: import("@empathyco/x-types").SemanticQuery, metadata: WireMetadata) => unknown;
|
|
@@ -38,6 +38,25 @@ Description
|
|
|
38
38
|
</th></tr></thead>
|
|
39
39
|
<tbody><tr><td>
|
|
40
40
|
|
|
41
|
+
[setBrowseCategory](./x-components.urlmutations.setbrowsecategory.md)
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
</td><td>
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
</td><td>
|
|
48
|
+
|
|
49
|
+
(browseCategory: BrowsableRequest) => void
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</td><td>
|
|
53
|
+
|
|
54
|
+
Sets the new browseCategory.
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
</td></tr>
|
|
58
|
+
<tr><td>
|
|
59
|
+
|
|
41
60
|
[setFilters](./x-components.urlmutations.setfilters.md)
|
|
42
61
|
|
|
43
62
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [UrlMutations](./x-components.urlmutations.md) > [setBrowseCategory](./x-components.urlmutations.setbrowsecategory.md)
|
|
4
|
+
|
|
5
|
+
## UrlMutations.setBrowseCategory property
|
|
6
|
+
|
|
7
|
+
Sets the new browseCategory.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setBrowseCategory: (browseCategory: BrowsableRequest) => void;
|
|
13
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [UrlParams](./x-components.urlparams.md) > [browseField](./x-components.urlparams.browsefield.md)
|
|
4
|
+
|
|
5
|
+
## UrlParams.browseField property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
browseField: string;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [UrlParams](./x-components.urlparams.md) > [browseValue](./x-components.urlparams.browsevalue.md)
|
|
4
|
+
|
|
5
|
+
## UrlParams.browseValue property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
browseValue: string;
|
|
11
|
+
```
|
|
@@ -37,6 +37,40 @@ Description
|
|
|
37
37
|
</th></tr></thead>
|
|
38
38
|
<tbody><tr><td>
|
|
39
39
|
|
|
40
|
+
[browseField](./x-components.urlparams.browsefield.md)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td><td>
|
|
47
|
+
|
|
48
|
+
string
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
</td><td>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
</td></tr>
|
|
55
|
+
<tr><td>
|
|
56
|
+
|
|
57
|
+
[browseValue](./x-components.urlparams.browsevalue.md)
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
</td><td>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
</td><td>
|
|
64
|
+
|
|
65
|
+
string
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</td><td>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
</td></tr>
|
|
72
|
+
<tr><td>
|
|
73
|
+
|
|
40
74
|
[filter](./x-components.urlparams.filter.md)
|
|
41
75
|
|
|
42
76
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [UseAliasAPI](./x-components.usealiasapi.md) > [browseTotalResults](./x-components.usealiasapi.browsetotalresults.md)
|
|
4
|
+
|
|
5
|
+
## UseAliasAPI.browseTotalResults property
|
|
6
|
+
|
|
7
|
+
The [BrowseXModule](./x-components.browsexmodule.md) total results.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
readonly browseTotalResults: number;
|
|
13
|
+
```
|
|
@@ -37,6 +37,27 @@ Description
|
|
|
37
37
|
</th></tr></thead>
|
|
38
38
|
<tbody><tr><td>
|
|
39
39
|
|
|
40
|
+
[browseTotalResults](./x-components.usealiasapi.browsetotalresults.md)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
`readonly`
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
</td><td>
|
|
49
|
+
|
|
50
|
+
number
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
</td><td>
|
|
54
|
+
|
|
55
|
+
The [BrowseXModule](./x-components.browsexmodule.md) total results.
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
</td></tr>
|
|
59
|
+
<tr><td>
|
|
60
|
+
|
|
40
61
|
[device](./x-components.usealiasapi.device.md)
|
|
41
62
|
|
|
42
63
|
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [WatchedInternalBrowseRequest](./x-components.watchedinternalbrowserequest.md)
|
|
4
|
+
|
|
5
|
+
## WatchedInternalBrowseRequest interface
|
|
6
|
+
|
|
7
|
+
A representation of a watched [InternalBrowseRequest](./x-components.internalbrowserequest.md) object, wrapping its new and old values.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface WatchedInternalBrowseRequest
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
<table><thead><tr><th>
|
|
18
|
+
|
|
19
|
+
Property
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
</th><th>
|
|
23
|
+
|
|
24
|
+
Modifiers
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</th><th>
|
|
28
|
+
|
|
29
|
+
Type
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
</th><th>
|
|
33
|
+
|
|
34
|
+
Description
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
</th></tr></thead>
|
|
38
|
+
<tbody><tr><td>
|
|
39
|
+
|
|
40
|
+
[newRequest](./x-components.watchedinternalbrowserequest.newrequest.md)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td><td>
|
|
47
|
+
|
|
48
|
+
[InternalBrowseRequest](./x-components.internalbrowserequest.md)
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
</td><td>
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
</td></tr>
|
|
55
|
+
<tr><td>
|
|
56
|
+
|
|
57
|
+
[oldRequest](./x-components.watchedinternalbrowserequest.oldrequest.md)
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
</td><td>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
</td><td>
|
|
64
|
+
|
|
65
|
+
[InternalBrowseRequest](./x-components.internalbrowserequest.md)
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</td><td>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
</td></tr>
|
|
72
|
+
</tbody></table>
|
|
73
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [WatchedInternalBrowseRequest](./x-components.watchedinternalbrowserequest.md) > [newRequest](./x-components.watchedinternalbrowserequest.newrequest.md)
|
|
4
|
+
|
|
5
|
+
## WatchedInternalBrowseRequest.newRequest property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
newRequest: InternalBrowseRequest;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [WatchedInternalBrowseRequest](./x-components.watchedinternalbrowserequest.md) > [oldRequest](./x-components.watchedinternalbrowserequest.oldrequest.md)
|
|
4
|
+
|
|
5
|
+
## WatchedInternalBrowseRequest.oldRequest property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
oldRequest: InternalBrowseRequest;
|
|
11
|
+
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [XAPI](./x-components.xapi.md) > [browse](./x-components.xapi.browse.md)
|
|
4
|
+
|
|
5
|
+
## XAPI.browse property
|
|
6
|
+
|
|
7
|
+
Dispatch a browse with the browseCategory parameter.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
browse: (browseCategory?: BrowsableRequest) => void;
|
|
13
|
+
```
|
|
@@ -53,6 +53,25 @@ Description
|
|
|
53
53
|
To track that a product was added to the cart from PDP.
|
|
54
54
|
|
|
55
55
|
|
|
56
|
+
</td></tr>
|
|
57
|
+
<tr><td>
|
|
58
|
+
|
|
59
|
+
[browse](./x-components.xapi.browse.md)
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
</td><td>
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
</td><td>
|
|
66
|
+
|
|
67
|
+
(browseCategory?: BrowsableRequest) => void
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</td><td>
|
|
71
|
+
|
|
72
|
+
Dispatch a browse with the browseCategory parameter.
|
|
73
|
+
|
|
74
|
+
|
|
56
75
|
</td></tr>
|
|
57
76
|
<tr><td>
|
|
58
77
|
|
|
@@ -9,9 +9,9 @@
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QueriesPreviewXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, SemanticQueriesXEvents, TaggingXEvents, ExperienceControlsXEvents, UrlXEvents, RelatedPromptsXEvents, AiXEvents
|
|
12
|
+
export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QueriesPreviewXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, BrowseXEvents, SemanticQueriesXEvents, TaggingXEvents, ExperienceControlsXEvents, UrlXEvents, RelatedPromptsXEvents, AiXEvents
|
|
13
13
|
```
|
|
14
|
-
**Extends:** [DeviceXEvents](./x-components.devicexevents.md)<!-- -->, [EmpathizeXEvents](./x-components.empathizexevents.md)<!-- -->, [ExtraParamsXEvents](./x-components.extraparamsxevents.md)<!-- -->, [FacetsXEvents](./x-components.facetsxevents.md)<!-- -->, [HistoryQueriesXEvents](./x-components.historyqueriesxevents.md)<!-- -->, [IdentifierResultsXEvents](./x-components.identifierresultsxevents.md)<!-- -->, [NextQueriesXEvents](./x-components.nextqueriesxevents.md)<!-- -->, [PopularSearchesXEvents](./x-components.popularsearchesxevents.md)<!-- -->, [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md)<!-- -->, [QuerySuggestionsXEvents](./x-components.querysuggestionsxevents.md)<!-- -->, [RecommendationsXEvents](./x-components.recommendationsxevents.md)<!-- -->, [RelatedTagsXEvents](./x-components.relatedtagsxevents.md)<!-- -->, [ScrollXEvents](./x-components.scrollxevents.md)<!-- -->, [SearchBoxXEvents](./x-components.searchboxxevents.md)<!-- -->, [SearchXEvents](./x-components.searchxevents.md)<!-- -->, [SemanticQueriesXEvents](./x-components.semanticqueriesxevents.md)<!-- -->, [TaggingXEvents](./x-components.taggingxevents.md)<!-- -->, [ExperienceControlsXEvents](./x-components.experiencecontrolsxevents.md)<!-- -->, [UrlXEvents](./x-components.urlxevents.md)<!-- -->, [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md)<!-- -->, [AiXEvents](./x-components.aixevents.md)
|
|
14
|
+
**Extends:** [DeviceXEvents](./x-components.devicexevents.md)<!-- -->, [EmpathizeXEvents](./x-components.empathizexevents.md)<!-- -->, [ExtraParamsXEvents](./x-components.extraparamsxevents.md)<!-- -->, [FacetsXEvents](./x-components.facetsxevents.md)<!-- -->, [HistoryQueriesXEvents](./x-components.historyqueriesxevents.md)<!-- -->, [IdentifierResultsXEvents](./x-components.identifierresultsxevents.md)<!-- -->, [NextQueriesXEvents](./x-components.nextqueriesxevents.md)<!-- -->, [PopularSearchesXEvents](./x-components.popularsearchesxevents.md)<!-- -->, [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md)<!-- -->, [QuerySuggestionsXEvents](./x-components.querysuggestionsxevents.md)<!-- -->, [RecommendationsXEvents](./x-components.recommendationsxevents.md)<!-- -->, [RelatedTagsXEvents](./x-components.relatedtagsxevents.md)<!-- -->, [ScrollXEvents](./x-components.scrollxevents.md)<!-- -->, [SearchBoxXEvents](./x-components.searchboxxevents.md)<!-- -->, [SearchXEvents](./x-components.searchxevents.md)<!-- -->, [BrowseXEvents](./x-components.browsexevents.md)<!-- -->, [SemanticQueriesXEvents](./x-components.semanticqueriesxevents.md)<!-- -->, [TaggingXEvents](./x-components.taggingxevents.md)<!-- -->, [ExperienceControlsXEvents](./x-components.experiencecontrolsxevents.md)<!-- -->, [UrlXEvents](./x-components.urlxevents.md)<!-- -->, [RelatedPromptsXEvents](./x-components.relatedpromptsxevents.md)<!-- -->, [AiXEvents](./x-components.aixevents.md)
|
|
15
15
|
|
|
16
16
|
## Remarks
|
|
17
17
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [XModulesTree](./x-components.xmodulestree.md) > [browse](./x-components.xmodulestree.browse.md)
|
|
4
|
+
|
|
5
|
+
## XModulesTree.browse property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
browse: BrowseXModule;
|
|
11
|
+
```
|
|
@@ -51,6 +51,23 @@ Description
|
|
|
51
51
|
</td><td>
|
|
52
52
|
|
|
53
53
|
|
|
54
|
+
</td></tr>
|
|
55
|
+
<tr><td>
|
|
56
|
+
|
|
57
|
+
[browse](./x-components.xmodulestree.browse.md)
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
</td><td>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
</td><td>
|
|
64
|
+
|
|
65
|
+
[BrowseXModule](./x-components.browsexmodule.md)
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</td><td>
|
|
69
|
+
|
|
70
|
+
|
|
54
71
|
</td></tr>
|
|
55
72
|
<tr><td>
|
|
56
73
|
|
|
@@ -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) > [browse](./x-types.xcomponentsadapter.browse.md)
|
|
4
|
+
|
|
5
|
+
## XComponentsAdapter.browse property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
browse: EndpointAdapter<BrowseRequest, BrowseResponse>;
|
|
11
|
+
```
|
|
@@ -68,6 +68,23 @@ EndpointAdapter<[AiSuggestionsSearchRequest](./x-types.aisuggestionssearchreq
|
|
|
68
68
|
</td><td>
|
|
69
69
|
|
|
70
70
|
|
|
71
|
+
</td></tr>
|
|
72
|
+
<tr><td>
|
|
73
|
+
|
|
74
|
+
[browse](./x-types.xcomponentsadapter.browse.md)
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
</td><td>
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
</td><td>
|
|
81
|
+
|
|
82
|
+
EndpointAdapter<[BrowseRequest](./x-types.browserequest.md)<!-- -->, [BrowseResponse](./x-types.browseresponse.md)<!-- -->>
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
</td><td>
|
|
86
|
+
|
|
87
|
+
|
|
71
88
|
</td></tr>
|
|
72
89
|
<tr><td>
|
|
73
90
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
|
|
3
|
+
title: BrowseResultsList
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# BrowseResultsList
|
|
8
|
+
|
|
9
|
+
It renders a ItemsList list with the results from SearchState.results by
|
|
10
|
+
default.
|
|
11
|
+
|
|
12
|
+
The component provides a default slot which wraps the whole component with the `results` bound.
|
|
13
|
+
|
|
14
|
+
It also provides the slot result to customize the item, which is within the default slot, with
|
|
15
|
+
the result bound.
|
|
16
|
+
|
|
17
|
+
## Props
|
|
18
|
+
|
|
19
|
+
| Name | Description | Type | Default |
|
|
20
|
+
| ---------------------- | ------------------------------------------------------------- | -------------------------- | ----------------- |
|
|
21
|
+
| <code>animation</code> | Animation component that will be used to animate the results. | <code>AnimationProp</code> | <code>'ul'</code> |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
|
|
3
|
+
title: BrowseSortPickerList
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# BrowseSortPickerList
|
|
8
|
+
|
|
9
|
+
The `SortPickerList` component allows user to select the browse results order. This component
|
|
10
|
+
also allows to change the selected sort programmatically.
|
|
11
|
+
|
|
12
|
+
## Props
|
|
13
|
+
|
|
14
|
+
| Name | Description | Type | Default |
|
|
15
|
+
| ------------------------ | ----------- | ------------------- | ----------------- |
|
|
16
|
+
| <code>animation</code> | | <code>union</code> | <code>'ul'</code> |
|
|
17
|
+
| <code>items</code> | | <code>Array</code> | <code></code> |
|
|
18
|
+
| <code>buttonClass</code> | | <code>string</code> | <code></code> |
|
|
19
|
+
|
|
20
|
+
## Slots
|
|
21
|
+
|
|
22
|
+
| Name | Description | Bindings<br />(name - type - description) |
|
|
23
|
+
| -------------------- | ----------- | ----------------------------------------- |
|
|
24
|
+
| <code>default</code> | | <br /> |
|