@empathyco/x-components 7.3.0 → 7.4.0

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.
Files changed (119) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/docs/API-reference/api/x-components.basexapi.browse.md +54 -0
  3. package/docs/API-reference/api/x-components.basexapi.md +14 -0
  4. package/docs/API-reference/api/x-components.hierarchicalfilter.md +7 -0
  5. package/docs/API-reference/api/x-components.md +33 -0
  6. package/docs/API-reference/api/x-components.resetnextqueriesquery.md +13 -0
  7. package/docs/API-reference/api/x-components.reseturlbrowsecategory.md +13 -0
  8. package/docs/API-reference/api/x-components.seturlbrowsecategory.md +13 -0
  9. package/docs/API-reference/api/x-components.simplefilter.md +7 -0
  10. package/docs/API-reference/api/x-components.snippetcallbacks.md +7 -0
  11. package/docs/API-reference/api/x-components.urlmutations.md +19 -0
  12. package/docs/API-reference/api/x-components.urlmutations.setbrowsecategory.md +13 -0
  13. package/docs/API-reference/api/x-components.urlparams.browsefield.md +11 -0
  14. package/docs/API-reference/api/x-components.urlparams.browsevalue.md +11 -0
  15. package/docs/API-reference/api/x-components.urlparams.md +34 -0
  16. package/docs/API-reference/api/x-components.usealiasapi.browsetotalresults.md +13 -0
  17. package/docs/API-reference/api/x-components.usealiasapi.md +21 -0
  18. package/docs/API-reference/api/x-components.xapi.browse.md +13 -0
  19. package/docs/API-reference/api/x-components.xapi.md +19 -0
  20. package/docs/API-reference/api/x-components.xeventstypes.md +2 -2
  21. package/docs/API-reference/api/x-components.xmodulestree.browse.md +11 -0
  22. package/docs/API-reference/api/x-components.xmodulestree.md +17 -0
  23. package/docs/API-reference/api/x-types.xcomponentsadapter.browse.md +11 -0
  24. package/docs/API-reference/api/x-types.xcomponentsadapter.md +17 -0
  25. package/docs/API-reference/components/browse/x-components.browse-results-list.md +21 -0
  26. package/docs/API-reference/components/browse/x-components.browse-sort-picker-list.md +24 -0
  27. package/js/composables/use-alias-api.js +3 -0
  28. package/js/composables/use-alias-api.js.map +1 -1
  29. package/js/index.js +2 -2
  30. package/js/x-installer/api/base-api.js +12 -0
  31. package/js/x-installer/api/base-api.js.map +1 -1
  32. package/js/x-modules/next-queries/wiring.js +11 -1
  33. package/js/x-modules/next-queries/wiring.js.map +1 -1
  34. package/js/x-modules/url/components/url-handler.vue.js.map +1 -1
  35. package/js/x-modules/url/components/url-handler.vue2.js +4 -1
  36. package/js/x-modules/url/components/url-handler.vue2.js.map +1 -1
  37. package/js/x-modules/url/store/initial-state.js +2 -0
  38. package/js/x-modules/url/store/initial-state.js.map +1 -1
  39. package/js/x-modules/url/store/module.js +4 -0
  40. package/js/x-modules/url/store/module.js.map +1 -1
  41. package/js/x-modules/url/wiring.js +34 -1
  42. package/js/x-modules/url/wiring.js.map +1 -1
  43. package/next-queries/index.js +1 -1
  44. package/package.json +4 -4
  45. package/report/x-components.api.json +543 -5
  46. package/report/x-components.api.md +72 -3
  47. package/report/x-types.api.json +50 -0
  48. package/types/src/components/snippet-callbacks.vue.d.ts +7 -0
  49. package/types/src/components/snippet-callbacks.vue.d.ts.map +1 -1
  50. package/types/src/composables/use-alias-api.d.ts +2 -0
  51. package/types/src/composables/use-alias-api.d.ts.map +1 -1
  52. package/types/src/types/url-params.d.ts +2 -0
  53. package/types/src/types/url-params.d.ts.map +1 -1
  54. package/types/src/wiring/events.types.d.ts +2 -1
  55. package/types/src/wiring/events.types.d.ts.map +1 -1
  56. package/types/src/x-installer/api/api.types.d.ts +9 -0
  57. package/types/src/x-installer/api/api.types.d.ts.map +1 -1
  58. package/types/src/x-installer/api/base-api.d.ts +9 -0
  59. package/types/src/x-installer/api/base-api.d.ts.map +1 -1
  60. package/types/src/x-modules/browse/components/index.d.ts +3 -0
  61. package/types/src/x-modules/browse/components/index.d.ts.map +1 -0
  62. package/types/src/x-modules/browse/config.types.d.ts +14 -0
  63. package/types/src/x-modules/browse/config.types.d.ts.map +1 -0
  64. package/types/src/x-modules/browse/events.types.d.ts +55 -0
  65. package/types/src/x-modules/browse/events.types.d.ts.map +1 -0
  66. package/types/src/x-modules/browse/index.d.ts +8 -0
  67. package/types/src/x-modules/browse/index.d.ts.map +1 -0
  68. package/types/src/x-modules/browse/store/actions/fetch-and-save-browse-response.action.d.ts +15 -0
  69. package/types/src/x-modules/browse/store/actions/fetch-and-save-browse-response.action.d.ts.map +1 -0
  70. package/types/src/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.d.ts +17 -0
  71. package/types/src/x-modules/browse/store/actions/fetch-and-save-results-enrichment.action.d.ts.map +1 -0
  72. package/types/src/x-modules/browse/store/actions/fetch-browse-response.action.d.ts +13 -0
  73. package/types/src/x-modules/browse/store/actions/fetch-browse-response.action.d.ts.map +1 -0
  74. package/types/src/x-modules/browse/store/actions/increase-page-apending-results.action.d.ts +11 -0
  75. package/types/src/x-modules/browse/store/actions/increase-page-apending-results.action.d.ts.map +1 -0
  76. package/types/src/x-modules/browse/store/actions/index.d.ts +9 -0
  77. package/types/src/x-modules/browse/store/actions/index.d.ts.map +1 -0
  78. package/types/src/x-modules/browse/store/actions/reset-request-on-refinement.action.d.ts +11 -0
  79. package/types/src/x-modules/browse/store/actions/reset-request-on-refinement.action.d.ts.map +1 -0
  80. package/types/src/x-modules/browse/store/actions/save-browse-response.action.d.ts +11 -0
  81. package/types/src/x-modules/browse/store/actions/save-browse-response.action.d.ts.map +1 -0
  82. package/types/src/x-modules/browse/store/actions/save-origin.action.d.ts +11 -0
  83. package/types/src/x-modules/browse/store/actions/save-origin.action.d.ts.map +1 -0
  84. package/types/src/x-modules/browse/store/actions/set-url-params.action.d.ts +11 -0
  85. package/types/src/x-modules/browse/store/actions/set-url-params.action.d.ts.map +1 -0
  86. package/types/src/x-modules/browse/store/emitters.d.ts +35 -0
  87. package/types/src/x-modules/browse/store/emitters.d.ts.map +1 -0
  88. package/types/src/x-modules/browse/store/getters/index.d.ts +2 -0
  89. package/types/src/x-modules/browse/store/getters/index.d.ts.map +1 -0
  90. package/types/src/x-modules/browse/store/getters/request.getter.d.ts +13 -0
  91. package/types/src/x-modules/browse/store/getters/request.getter.d.ts.map +1 -0
  92. package/types/src/x-modules/browse/store/index.d.ts +6 -0
  93. package/types/src/x-modules/browse/store/index.d.ts.map +1 -0
  94. package/types/src/x-modules/browse/store/module.d.ts +41 -0
  95. package/types/src/x-modules/browse/store/module.d.ts.map +1 -0
  96. package/types/src/x-modules/browse/store/types.d.ts +273 -0
  97. package/types/src/x-modules/browse/store/types.d.ts.map +1 -0
  98. package/types/src/x-modules/browse/types.d.ts +35 -0
  99. package/types/src/x-modules/browse/types.d.ts.map +1 -0
  100. package/types/src/x-modules/browse/wiring.d.ts +172 -0
  101. package/types/src/x-modules/browse/wiring.d.ts.map +1 -0
  102. package/types/src/x-modules/browse/x-module.d.ts +16 -0
  103. package/types/src/x-modules/browse/x-module.d.ts.map +1 -0
  104. package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts +7 -0
  105. package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts.map +1 -1
  106. package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts +7 -0
  107. package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts.map +1 -1
  108. package/types/src/x-modules/next-queries/wiring.d.ts +10 -0
  109. package/types/src/x-modules/next-queries/wiring.d.ts.map +1 -1
  110. package/types/src/x-modules/url/components/url-handler.vue.d.ts.map +1 -1
  111. package/types/src/x-modules/url/store/initial-state.d.ts.map +1 -1
  112. package/types/src/x-modules/url/store/module.d.ts.map +1 -1
  113. package/types/src/x-modules/url/store/types.d.ts +7 -1
  114. package/types/src/x-modules/url/store/types.d.ts.map +1 -1
  115. package/types/src/x-modules/url/wiring.d.ts +30 -0
  116. package/types/src/x-modules/url/wiring.d.ts.map +1 -1
  117. package/types/src/x-modules/x-modules.types.d.ts +2 -0
  118. package/types/src/x-modules/x-modules.types.d.ts.map +1 -1
  119. package/url/index.js +1 -1
package/CHANGELOG.md CHANGED
@@ -3,6 +3,20 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [7.4.0](https://github.com/empathyco/x/compare/@empathyco/x-components@7.3.1...@empathyco/x-components@7.4.0) (2026-07-07)
7
+
8
+ ### Features
9
+
10
+ * create browse module (#2128)
11
+
12
+
13
+ ## [7.3.1](https://github.com/empathyco/x/compare/@empathyco/x-components@7.3.0...@empathyco/x-components@7.3.1) (2026-07-06)
14
+
15
+ ### Bug Fixes
16
+
17
+ * **next-queries:** reset wiring on user-cleared query event (#2132)
18
+
19
+
6
20
  ## [7.3.0](https://github.com/empathyco/x/compare/@empathyco/x-components@7.2.5...@empathyco/x-components@7.3.0) (2026-07-06)
7
21
 
8
22
  ### Features
@@ -0,0 +1,54 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [BaseXAPI](./x-components.basexapi.md) &gt; [browse](./x-components.basexapi.browse.md)
4
+
5
+ ## BaseXAPI.browse() method
6
+
7
+ Browses the browseField and browseValue parameters as a selected category.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ browse(browseCategory?: BrowsableRequest): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ browseCategory
36
+
37
+
38
+ </td><td>
39
+
40
+ BrowsableRequest
41
+
42
+
43
+ </td><td>
44
+
45
+ _(Optional)_ browseField and browseValue to be browsed.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
50
+
51
+ **Returns:**
52
+
53
+ void
54
+
@@ -88,6 +88,20 @@ Description
88
88
  Tracks that a product was added to cart from PDP.
89
89
 
90
90
 
91
+ </td></tr>
92
+ <tr><td>
93
+
94
+ [browse(browseCategory)](./x-components.basexapi.browse.md)
95
+
96
+
97
+ </td><td>
98
+
99
+
100
+ </td><td>
101
+
102
+ Browses the browseField and browseValue parameters as a selected category.
103
+
104
+
91
105
  </td></tr>
92
106
  <tr><td>
93
107
 
@@ -169,6 +169,13 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
169
169
  UserClickedABanner?: import("@empathyco/x-types").Banner | undefined;
170
170
  UserClickedAbortARedirection?: void | undefined;
171
171
  UserSelectedAPage?: number | undefined;
172
+ BrowseRequestChanged?: import("../../../browse").InternalBrowseRequest | null | undefined;
173
+ BrowseRequestUpdated?: import("../../../browse").InternalBrowseRequest | null | undefined;
174
+ BrowseResponseChanged?: import("../../../browse").InternalBrowseResponse | undefined;
175
+ BrowseTaggingChanged?: import("@empathyco/x-types").TaggingRequest | undefined;
176
+ UserClickedABrowseSort?: string | undefined;
177
+ SelectedBrowseSortProvided?: string | undefined;
178
+ UserBrowsedToCategory?: import("@empathyco/x-types").BrowsableRequest | undefined;
172
179
  SemanticQueryRequestUpdated?: import("@empathyco/x-types").SemanticQueriesRequest | null | undefined;
173
180
  SemanticQueriesResponseChanged?: import("@empathyco/x-types").SemanticQuery[] | undefined;
174
181
  UserSelectedASemanticQuery?: import("@empathyco/x-types").SemanticQuery | undefined;
@@ -5868,6 +5868,17 @@ Resets the search state `fromNoResultsWithFilters`<!-- -->.
5868
5868
  Resets the search state `isNoResults`<!-- -->.
5869
5869
 
5870
5870
 
5871
+ </td></tr>
5872
+ <tr><td>
5873
+
5874
+ [resetNextQueriesQuery](./x-components.resetnextqueriesquery.md)
5875
+
5876
+
5877
+ </td><td>
5878
+
5879
+ Reset the next queries state `query`<!-- -->.
5880
+
5881
+
5871
5882
  </td></tr>
5872
5883
  <tr><td>
5873
5884
 
@@ -5945,6 +5956,17 @@ Resets the search state to reload the current search.
5945
5956
  Resets the search state when the request is changed to null. See the [SearchXStoreModule](./x-components.searchxstoremodule.md) for details.
5946
5957
 
5947
5958
 
5959
+ </td></tr>
5960
+ <tr><td>
5961
+
5962
+ [resetUrlBrowseCategory](./x-components.reseturlbrowsecategory.md)
5963
+
5964
+
5965
+ </td><td>
5966
+
5967
+ Sets the browseCategory of the url module.
5968
+
5969
+
5948
5970
  </td></tr>
5949
5971
  <tr><td>
5950
5972
 
@@ -6993,6 +7015,17 @@ Sets the total results taking the [SearchXEvents.SearchResponseChanged](./x-comp
6993
7015
  Sets the total results.
6994
7016
 
6995
7017
 
7018
+ </td></tr>
7019
+ <tr><td>
7020
+
7021
+ [setUrlBrowseCategory](./x-components.seturlbrowsecategory.md)
7022
+
7023
+
7024
+ </td><td>
7025
+
7026
+ Sets the browseCategory of the url module.
7027
+
7028
+
6996
7029
  </td></tr>
6997
7030
  <tr><td>
6998
7031
 
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [resetNextQueriesQuery](./x-components.resetnextqueriesquery.md)
4
+
5
+ ## resetNextQueriesQuery variable
6
+
7
+ Reset the next queries state `query`<!-- -->.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ resetNextQueriesQuery: 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) &gt; [@empathyco/x-components](./x-components.md) &gt; [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) &gt; [@empathyco/x-components](./x-components.md) &gt; [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("../x-modules/browse").InternalBrowseRequest | null, metadata: WireMetadata) => unknown;
160
+ BrowseRequestUpdated: (payload: import("../x-modules/browse").InternalBrowseRequest | null, metadata: WireMetadata) => unknown;
161
+ BrowseResponseChanged: (payload: import("../x-modules/browse").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) =&gt; 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) &gt; [@empathyco/x-components](./x-components.md) &gt; [UrlMutations](./x-components.urlmutations.md) &gt; [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) &gt; [@empathyco/x-components](./x-components.md) &gt; [UrlParams](./x-components.urlparams.md) &gt; [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) &gt; [@empathyco/x-components](./x-components.md) &gt; [UrlParams](./x-components.urlparams.md) &gt; [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) &gt; [@empathyco/x-components](./x-components.md) &gt; [UseAliasAPI](./x-components.usealiasapi.md) &gt; [browseTotalResults](./x-components.usealiasapi.browsetotalresults.md)
4
+
5
+ ## UseAliasAPI.browseTotalResults property
6
+
7
+ The 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 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,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [XAPI](./x-components.xapi.md) &gt; [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) =&gt; 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, [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) &gt; [@empathyco/x-components](./x-components.md) &gt; [XModulesTree](./x-components.xmodulestree.md) &gt; [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
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) &gt; [@empathyco/x-types](./x-types.md) &gt; [XComponentsAdapter](./x-types.xcomponentsadapter.md) &gt; [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&lt;[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&lt;[BrowseRequest](./x-types.browserequest.md)<!-- -->, [BrowseResponse](./x-types.browseresponse.md)<!-- -->&gt;
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 /> |
@@ -138,6 +138,9 @@ function useAliasApi() {
138
138
  get totalResults() {
139
139
  return store.state.x.search?.totalResults ?? 0;
140
140
  },
141
+ get browseTotalResults() {
142
+ return store.state.x.browse?.totalResults ?? 0;
143
+ },
141
144
  get selectedSort() {
142
145
  return store.state.x.search?.sort ?? '';
143
146
  },