@empathyco/x-components 8.11.0 → 8.12.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 +14 -0
- package/docs/API-reference/api/x-components.hierarchicalfilter.md +8 -0
- package/docs/API-reference/api/x-components.md +37 -0
- package/docs/API-reference/api/x-components.querypreviewlist.md +2 -0
- package/docs/API-reference/api/x-components.setquerypreviewvendorbanners.md +16 -0
- package/docs/API-reference/api/x-components.setquerypreviewvendorresults.md +16 -0
- package/docs/API-reference/api/x-components.simplefilter.md +8 -0
- package/docs/API-reference/api/x-components.snippetcallbacks.md +8 -0
- package/docs/API-reference/api/x-components.snippetconfig.lang.md +1 -1
- package/docs/API-reference/api/x-components.snippetconfig.md +2 -2
- package/docs/API-reference/api/x-components.snippetconfig.uilang.md +1 -1
- package/docs/API-reference/api/x-components.vendorbannerslist.md +11 -0
- package/docs/API-reference/api/x-components.vendormutations.md +57 -0
- package/docs/API-reference/api/x-components.vendormutations.removequerypreviewvendordata.md +13 -0
- package/docs/API-reference/api/x-components.vendormutations.setquerypreviewvendorbanners.md +16 -0
- package/docs/API-reference/api/x-components.vendormutations.setquerypreviewvendorresults.md +16 -0
- package/docs/API-reference/api/x-components.vendorquerypreview.banners.md +13 -0
- package/docs/API-reference/api/x-components.vendorquerypreview.md +77 -0
- package/docs/API-reference/api/x-components.vendorquerypreview.results.md +13 -0
- package/docs/API-reference/api/x-components.vendorresultslist.md +11 -0
- package/docs/API-reference/api/x-components.vendorstate.md +19 -0
- package/docs/API-reference/api/x-components.vendorstate.querypreviews.md +13 -0
- package/docs/API-reference/api/x-components.vendorxevents.md +38 -0
- package/docs/API-reference/api/x-components.vendorxevents.querypreviewvendorbannerschanged.md +16 -0
- package/docs/API-reference/api/x-components.vendorxevents.querypreviewvendorresultschanged.md +16 -0
- package/docs/API-reference/api/x-components.vendorxevents.vendorquerychanged.md +5 -0
- package/docs/API-reference/components/queries-preview/x-components.query-preview-list.md +46 -0
- package/docs/API-reference/components/vendor/x-components.vendor-banners-list.md +7 -3
- package/docs/API-reference/components/vendor/x-components.vendor-results-list.md +7 -3
- package/js/index.js +1 -1
- package/js/x-modules/queries-preview/components/query-preview-list.vue.js +30 -34
- 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 +2 -0
- 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 +1 -0
- package/js/x-modules/queries-preview/components/query-preview.vue2.js.map +1 -1
- package/js/x-modules/vendor/components/vendor-banners-list.vue.js +34 -5
- package/js/x-modules/vendor/components/vendor-banners-list.vue.js.map +1 -1
- package/js/x-modules/vendor/components/vendor-results-list.vue.js +34 -5
- package/js/x-modules/vendor/components/vendor-results-list.vue.js.map +1 -1
- package/js/x-modules/vendor/store/emitters.js +11 -1
- package/js/x-modules/vendor/store/emitters.js.map +1 -1
- package/js/x-modules/vendor/store/module.js +22 -0
- package/js/x-modules/vendor/store/module.js.map +1 -1
- package/js/x-modules/vendor/wiring.js +32 -1
- package/js/x-modules/vendor/wiring.js.map +1 -1
- package/package.json +2 -2
- package/report/x-components.api.json +649 -21
- package/report/x-components.api.md +103 -1
- package/types/src/components/snippet-callbacks.vue.d.ts +8 -0
- package/types/src/components/snippet-callbacks.vue.d.ts.map +1 -1
- package/types/src/x-installer/api/api.types.d.ts +2 -2
- package/types/src/x-installer/api/api.types.d.ts.map +1 -1
- package/types/src/x-modules/facets/components/filters/hierarchical-filter.vue.d.ts +8 -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 +8 -0
- package/types/src/x-modules/facets/components/filters/simple-filter.vue.d.ts.map +1 -1
- package/types/src/x-modules/queries-preview/components/query-preview-list.vue.d.ts +2 -0
- package/types/src/x-modules/queries-preview/components/query-preview-list.vue.d.ts.map +1 -1
- package/types/src/x-modules/queries-preview/components/query-preview.vue.d.ts.map +1 -1
- package/types/src/x-modules/vendor/components/vendor-banners-list.vue.d.ts +20 -0
- package/types/src/x-modules/vendor/components/vendor-banners-list.vue.d.ts.map +1 -1
- package/types/src/x-modules/vendor/components/vendor-results-list.vue.d.ts +20 -0
- package/types/src/x-modules/vendor/components/vendor-results-list.vue.d.ts.map +1 -1
- package/types/src/x-modules/vendor/events.types.d.ts +24 -0
- package/types/src/x-modules/vendor/events.types.d.ts.map +1 -1
- package/types/src/x-modules/vendor/store/emitters.d.ts +11 -1
- package/types/src/x-modules/vendor/store/emitters.d.ts.map +1 -1
- package/types/src/x-modules/vendor/store/module.d.ts +1 -0
- package/types/src/x-modules/vendor/store/module.d.ts.map +1 -1
- package/types/src/x-modules/vendor/store/types.d.ts +42 -0
- package/types/src/x-modules/vendor/store/types.d.ts.map +1 -1
- package/types/src/x-modules/vendor/wiring.d.ts +36 -0
- package/types/src/x-modules/vendor/wiring.d.ts.map +1 -1
- package/vendor/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
|
+
## [8.12.1](https://github.com/empathyco/x/compare/@empathyco/x-components@8.12.0...@empathyco/x-components@8.12.1) (2026-08-21)
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
* **x-installer:** update uiLang values to BCP 47 format in tests and API types (#2155)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## [8.12.0](https://github.com/empathyco/x/compare/@empathyco/x-components@8.11.0...@empathyco/x-components@8.12.0) (2026-08-04)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **vendor:** integrate vendor results and banners into query previews (#2149)
|
|
18
|
+
|
|
19
|
+
|
|
6
20
|
## [8.11.0](https://github.com/empathyco/x/compare/@empathyco/x-components@8.10.0...@empathyco/x-components@8.11.0) (2026-08-04)
|
|
7
21
|
|
|
8
22
|
### Features
|
|
@@ -216,6 +216,14 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
216
216
|
UserClickedAVendorResult?: import("../../../vendor").VendorResult | undefined;
|
|
217
217
|
UserClickedVendorResultAddToCart?: import("../../../vendor").VendorResult | undefined;
|
|
218
218
|
VendorBannersChanged?: Omit<import("../../../vendor").VendorBanner, "modelName">[] | undefined;
|
|
219
|
+
QueryPreviewVendorResultsChanged?: {
|
|
220
|
+
queryPreviewHash: string;
|
|
221
|
+
results: Omit<import("../../../vendor").VendorResult, "modelName">[];
|
|
222
|
+
} | undefined;
|
|
223
|
+
QueryPreviewVendorBannersChanged?: {
|
|
224
|
+
queryPreviewHash: string;
|
|
225
|
+
banners: Omit<import("../../../vendor").VendorBanner, "modelName">[];
|
|
226
|
+
} | undefined;
|
|
219
227
|
VendorBannerMounted?: import("../../../vendor").VendorBanner | undefined;
|
|
220
228
|
UserViewedAVendorBanner?: import("../../../vendor").VendorBanner | undefined;
|
|
221
229
|
UserClickedAVendorBanner?: import("../../../vendor").VendorBanner | undefined;
|
|
@@ -3424,6 +3424,17 @@ The tagging info for a vendor banner.
|
|
|
3424
3424
|
</td><td>
|
|
3425
3425
|
|
|
3426
3426
|
|
|
3427
|
+
</td></tr>
|
|
3428
|
+
<tr><td>
|
|
3429
|
+
|
|
3430
|
+
[VendorQueryPreview](./x-components.vendorquerypreview.md)
|
|
3431
|
+
|
|
3432
|
+
|
|
3433
|
+
</td><td>
|
|
3434
|
+
|
|
3435
|
+
The vendor results and banners of a query preview, indexed by its query preview hash.
|
|
3436
|
+
|
|
3437
|
+
|
|
3427
3438
|
</td></tr>
|
|
3428
3439
|
<tr><td>
|
|
3429
3440
|
|
|
@@ -7152,6 +7163,28 @@ Sets the query of the facets module from a queryPreview.
|
|
|
7152
7163
|
Sets the query taking the [SearchXEvents.SearchResponseChanged](./x-components.searchxevents.searchresponsechanged.md) payload.
|
|
7153
7164
|
|
|
7154
7165
|
|
|
7166
|
+
</td></tr>
|
|
7167
|
+
<tr><td>
|
|
7168
|
+
|
|
7169
|
+
[setQueryPreviewVendorBanners](./x-components.setquerypreviewvendorbanners.md)
|
|
7170
|
+
|
|
7171
|
+
|
|
7172
|
+
</td><td>
|
|
7173
|
+
|
|
7174
|
+
Sets the vendor banners of a query preview in the [VendorXModule](./x-components.vendorxmodule.md)<!-- -->.
|
|
7175
|
+
|
|
7176
|
+
|
|
7177
|
+
</td></tr>
|
|
7178
|
+
<tr><td>
|
|
7179
|
+
|
|
7180
|
+
[setQueryPreviewVendorResults](./x-components.setquerypreviewvendorresults.md)
|
|
7181
|
+
|
|
7182
|
+
|
|
7183
|
+
</td><td>
|
|
7184
|
+
|
|
7185
|
+
Sets the vendor results of a query preview in the [VendorXModule](./x-components.vendorxmodule.md)<!-- -->.
|
|
7186
|
+
|
|
7187
|
+
|
|
7155
7188
|
</td></tr>
|
|
7156
7189
|
<tr><td>
|
|
7157
7190
|
|
|
@@ -8178,6 +8211,8 @@ It renders a [ItemsList](./x-components.itemslist.md) list of vendor banners fro
|
|
|
8178
8211
|
|
|
8179
8212
|
The component provides a default slot which wraps the whole component with the `vendorBanners` plus the `injectedListItems` which also contains the injected list items from the ancestor.
|
|
8180
8213
|
|
|
8214
|
+
If the `queryPreviewHash` prop is provided, the vendor banners are retrieved from [VendorState.queryPreviews](./x-components.vendorstate.querypreviews.md)<!-- -->, scoped to the query preview.
|
|
8215
|
+
|
|
8181
8216
|
It also provides the parent slots to customize the items.
|
|
8182
8217
|
|
|
8183
8218
|
|
|
@@ -8193,6 +8228,8 @@ It renders a [ItemsList](./x-components.itemslist.md) of vendor results from [Ve
|
|
|
8193
8228
|
|
|
8194
8229
|
The component provides a default slot which wraps the whole component with the `vendorResults` plus the `injectedListItems` which also contains the injected list items from the ancestor.
|
|
8195
8230
|
|
|
8231
|
+
If the `queryPreviewHash` prop is provided, the vendor results are retrieved from [VendorState.queryPreviews](./x-components.vendorstate.querypreviews.md)<!-- -->, scoped to the query preview.
|
|
8232
|
+
|
|
8196
8233
|
It also provides the parent slots to customize the items.
|
|
8197
8234
|
|
|
8198
8235
|
|
|
@@ -34,9 +34,11 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
34
34
|
default: string;
|
|
35
35
|
};
|
|
36
36
|
}>, {
|
|
37
|
+
params: import("vue").ComputedRef<import("@empathyco/x-utils").Dictionary<unknown>>;
|
|
37
38
|
renderedQueryPreviews: import("vue").ComputedRef<QueryPreviewInfo[]>;
|
|
38
39
|
flagAsFailed: (failedQuery: string) => void;
|
|
39
40
|
flagAsLoaded: (loadedQuery: string) => void;
|
|
41
|
+
getHashFromQueryPreviewInfo: (queryPreviewInfo: QueryPreviewInfo, extraParams: import("@empathyco/x-utils").Dictionary<unknown>) => string;
|
|
40
42
|
}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
41
43
|
queriesPreviewInfo: {
|
|
42
44
|
type: PropType<QueryPreviewInfo[]>;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setQueryPreviewVendorBanners](./x-components.setquerypreviewvendorbanners.md)
|
|
4
|
+
|
|
5
|
+
## setQueryPreviewVendorBanners variable
|
|
6
|
+
|
|
7
|
+
Sets the vendor banners of a query preview in the [VendorXModule](./x-components.vendorxmodule.md)<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setQueryPreviewVendorBanners: import("../../wiring").Wire<{
|
|
13
|
+
queryPreviewHash: string;
|
|
14
|
+
banners: Omit<import("./types").VendorBanner, "modelName">[];
|
|
15
|
+
}>
|
|
16
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [setQueryPreviewVendorResults](./x-components.setquerypreviewvendorresults.md)
|
|
4
|
+
|
|
5
|
+
## setQueryPreviewVendorResults variable
|
|
6
|
+
|
|
7
|
+
Sets the vendor results of a query preview in the [VendorXModule](./x-components.vendorxmodule.md)<!-- -->.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setQueryPreviewVendorResults: import("../../wiring").Wire<{
|
|
13
|
+
queryPreviewHash: string;
|
|
14
|
+
results: Omit<import("./types").VendorResult, "modelName">[];
|
|
15
|
+
}>
|
|
16
|
+
```
|
|
@@ -213,6 +213,14 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
213
213
|
UserClickedAVendorResult?: import("../../../vendor").VendorResult | undefined;
|
|
214
214
|
UserClickedVendorResultAddToCart?: import("../../../vendor").VendorResult | undefined;
|
|
215
215
|
VendorBannersChanged?: Omit<import("../../../vendor").VendorBanner, "modelName">[] | undefined;
|
|
216
|
+
QueryPreviewVendorResultsChanged?: {
|
|
217
|
+
queryPreviewHash: string;
|
|
218
|
+
results: Omit<import("../../../vendor").VendorResult, "modelName">[];
|
|
219
|
+
} | undefined;
|
|
220
|
+
QueryPreviewVendorBannersChanged?: {
|
|
221
|
+
queryPreviewHash: string;
|
|
222
|
+
banners: Omit<import("../../../vendor").VendorBanner, "modelName">[];
|
|
223
|
+
} | undefined;
|
|
216
224
|
VendorBannerMounted?: import("../../../vendor").VendorBanner | undefined;
|
|
217
225
|
UserViewedAVendorBanner?: import("../../../vendor").VendorBanner | undefined;
|
|
218
226
|
UserClickedAVendorBanner?: import("../../../vendor").VendorBanner | undefined;
|
|
@@ -203,6 +203,14 @@ _default: import("vue").DefineComponent<{}, {
|
|
|
203
203
|
UserClickedAVendorResult: (payload: import("..").VendorResult, metadata: WireMetadata) => unknown;
|
|
204
204
|
UserClickedVendorResultAddToCart: (payload: import("..").VendorResult, metadata: WireMetadata) => unknown;
|
|
205
205
|
VendorBannersChanged: (payload: Omit<import("..").VendorBanner, "modelName">[], metadata: WireMetadata) => unknown;
|
|
206
|
+
QueryPreviewVendorResultsChanged: (payload: {
|
|
207
|
+
queryPreviewHash: string;
|
|
208
|
+
results: Omit<import("..").VendorResult, "modelName">[];
|
|
209
|
+
}, metadata: WireMetadata) => unknown;
|
|
210
|
+
QueryPreviewVendorBannersChanged: (payload: {
|
|
211
|
+
queryPreviewHash: string;
|
|
212
|
+
banners: Omit<import("..").VendorBanner, "modelName">[];
|
|
213
|
+
}, metadata: WireMetadata) => unknown;
|
|
206
214
|
VendorBannerMounted: (payload: import("..").VendorBanner, metadata: WireMetadata) => unknown;
|
|
207
215
|
UserViewedAVendorBanner: (payload: import("..").VendorBanner, metadata: WireMetadata) => unknown;
|
|
208
216
|
UserClickedAVendorBanner: (payload: import("..").VendorBanner, metadata: WireMetadata) => unknown;
|
|
@@ -202,7 +202,7 @@ string
|
|
|
202
202
|
|
|
203
203
|
</td><td>
|
|
204
204
|
|
|
205
|
-
Language for the API request
|
|
205
|
+
Language for the API request. ISO 639-1 format. Ex: 'es', 'en', 'fr', etc.
|
|
206
206
|
|
|
207
207
|
|
|
208
208
|
</td></tr>
|
|
@@ -278,7 +278,7 @@ string
|
|
|
278
278
|
|
|
279
279
|
</td><td>
|
|
280
280
|
|
|
281
|
-
_(Optional)_ Language to use for the messages.
|
|
281
|
+
_(Optional)_ Language to use for the messages. BCP 47 format. Ex: 'es-ES', 'es-MX', 'en-US', 'fr-FR', etc.
|
|
282
282
|
|
|
283
283
|
|
|
284
284
|
</td></tr>
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
## SnippetConfig.uiLang property
|
|
6
6
|
|
|
7
|
-
Language to use for the messages.
|
|
7
|
+
Language to use for the messages. BCP 47 format. Ex: 'es-ES', 'es-MX', 'en-US', 'fr-FR', etc.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
@@ -8,6 +8,8 @@ It renders a [ItemsList](./x-components.itemslist.md) list of vendor banners fro
|
|
|
8
8
|
|
|
9
9
|
The component provides a default slot which wraps the whole component with the `vendorBanners` plus the `injectedListItems` which also contains the injected list items from the ancestor.
|
|
10
10
|
|
|
11
|
+
If the `queryPreviewHash` prop is provided, the vendor banners are retrieved from [VendorState.queryPreviews](./x-components.vendorstate.querypreviews.md)<!-- -->, scoped to the query preview.
|
|
12
|
+
|
|
11
13
|
It also provides the parent slots to customize the items.
|
|
12
14
|
|
|
13
15
|
**Signature:**
|
|
@@ -18,6 +20,10 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
18
20
|
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
19
21
|
default: string;
|
|
20
22
|
};
|
|
23
|
+
queryPreviewHash: {
|
|
24
|
+
type: StringConstructor;
|
|
25
|
+
default: undefined;
|
|
26
|
+
};
|
|
21
27
|
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
22
28
|
[key: string]: any;
|
|
23
29
|
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
@@ -25,7 +31,12 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
25
31
|
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
26
32
|
default: string;
|
|
27
33
|
};
|
|
34
|
+
queryPreviewHash: {
|
|
35
|
+
type: StringConstructor;
|
|
36
|
+
default: undefined;
|
|
37
|
+
};
|
|
28
38
|
}>> & Readonly<{}>, {
|
|
29
39
|
animation: string | Function | Record<string, any>;
|
|
40
|
+
queryPreviewHash: string;
|
|
30
41
|
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>
|
|
31
42
|
```
|
|
@@ -36,6 +36,25 @@ Description
|
|
|
36
36
|
</th></tr></thead>
|
|
37
37
|
<tbody><tr><td>
|
|
38
38
|
|
|
39
|
+
[removeQueryPreviewVendorData](./x-components.vendormutations.removequerypreviewvendordata.md)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
</td><td>
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
</td><td>
|
|
46
|
+
|
|
47
|
+
(queryPreviewHash: string) => void
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
</td><td>
|
|
51
|
+
|
|
52
|
+
Removes the vendor results and banners of a query preview.
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</td></tr>
|
|
56
|
+
<tr><td>
|
|
57
|
+
|
|
39
58
|
[resetState](./x-components.vendormutations.resetstate.md)
|
|
40
59
|
|
|
41
60
|
|
|
@@ -67,6 +86,44 @@ Description
|
|
|
67
86
|
</td><td>
|
|
68
87
|
|
|
69
88
|
|
|
89
|
+
</td></tr>
|
|
90
|
+
<tr><td>
|
|
91
|
+
|
|
92
|
+
[setQueryPreviewVendorBanners](./x-components.vendormutations.setquerypreviewvendorbanners.md)
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
</td><td>
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
</td><td>
|
|
99
|
+
|
|
100
|
+
(payload: { queryPreviewHash: string; banners: Omit<[VendorBanner](./x-components.vendorbanner.md)<!-- -->, 'modelName'>\[\]; }) => void
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
</td><td>
|
|
104
|
+
|
|
105
|
+
Sets the vendor banners of a query preview.
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</td></tr>
|
|
109
|
+
<tr><td>
|
|
110
|
+
|
|
111
|
+
[setQueryPreviewVendorResults](./x-components.vendormutations.setquerypreviewvendorresults.md)
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
</td><td>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
</td><td>
|
|
118
|
+
|
|
119
|
+
(payload: { queryPreviewHash: string; results: Omit<[VendorResult](./x-components.vendorresult.md)<!-- -->, 'modelName'>\[\]; }) => void
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
</td><td>
|
|
123
|
+
|
|
124
|
+
Sets the vendor results of a query preview.
|
|
125
|
+
|
|
126
|
+
|
|
70
127
|
</td></tr>
|
|
71
128
|
<tr><td>
|
|
72
129
|
|
|
@@ -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) > [VendorMutations](./x-components.vendormutations.md) > [removeQueryPreviewVendorData](./x-components.vendormutations.removequerypreviewvendordata.md)
|
|
4
|
+
|
|
5
|
+
## VendorMutations.removeQueryPreviewVendorData property
|
|
6
|
+
|
|
7
|
+
Removes the vendor results and banners of a query preview.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
removeQueryPreviewVendorData: (queryPreviewHash: string) => void;
|
|
13
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorMutations](./x-components.vendormutations.md) > [setQueryPreviewVendorBanners](./x-components.vendormutations.setquerypreviewvendorbanners.md)
|
|
4
|
+
|
|
5
|
+
## VendorMutations.setQueryPreviewVendorBanners property
|
|
6
|
+
|
|
7
|
+
Sets the vendor banners of a query preview.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setQueryPreviewVendorBanners: (payload: {
|
|
13
|
+
queryPreviewHash: string;
|
|
14
|
+
banners: Omit<VendorBanner, 'modelName'>[];
|
|
15
|
+
}) => void;
|
|
16
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorMutations](./x-components.vendormutations.md) > [setQueryPreviewVendorResults](./x-components.vendormutations.setquerypreviewvendorresults.md)
|
|
4
|
+
|
|
5
|
+
## VendorMutations.setQueryPreviewVendorResults property
|
|
6
|
+
|
|
7
|
+
Sets the vendor results of a query preview.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
setQueryPreviewVendorResults: (payload: {
|
|
13
|
+
queryPreviewHash: string;
|
|
14
|
+
results: Omit<VendorResult, 'modelName'>[];
|
|
15
|
+
}) => void;
|
|
16
|
+
```
|
|
@@ -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) > [VendorQueryPreview](./x-components.vendorquerypreview.md) > [banners](./x-components.vendorquerypreview.banners.md)
|
|
4
|
+
|
|
5
|
+
## VendorQueryPreview.banners property
|
|
6
|
+
|
|
7
|
+
The vendor banners of the query preview.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
banners: VendorBanner[];
|
|
13
|
+
```
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorQueryPreview](./x-components.vendorquerypreview.md)
|
|
4
|
+
|
|
5
|
+
## VendorQueryPreview interface
|
|
6
|
+
|
|
7
|
+
The vendor results and banners of a query preview, indexed by its query preview hash.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface VendorQueryPreview
|
|
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
|
+
[banners](./x-components.vendorquerypreview.banners.md)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td><td>
|
|
47
|
+
|
|
48
|
+
[VendorBanner](./x-components.vendorbanner.md)<!-- -->\[\]
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
</td><td>
|
|
52
|
+
|
|
53
|
+
The vendor banners of the query preview.
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
</td></tr>
|
|
57
|
+
<tr><td>
|
|
58
|
+
|
|
59
|
+
[results](./x-components.vendorquerypreview.results.md)
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
</td><td>
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
</td><td>
|
|
66
|
+
|
|
67
|
+
[VendorResult](./x-components.vendorresult.md)<!-- -->\[\]
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</td><td>
|
|
71
|
+
|
|
72
|
+
The vendor results of the query preview.
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
</td></tr>
|
|
76
|
+
</tbody></table>
|
|
77
|
+
|
|
@@ -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) > [VendorQueryPreview](./x-components.vendorquerypreview.md) > [results](./x-components.vendorquerypreview.results.md)
|
|
4
|
+
|
|
5
|
+
## VendorQueryPreview.results property
|
|
6
|
+
|
|
7
|
+
The vendor results of the query preview.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
results: VendorResult[];
|
|
13
|
+
```
|
|
@@ -8,6 +8,8 @@ It renders a [ItemsList](./x-components.itemslist.md) of vendor results from [Ve
|
|
|
8
8
|
|
|
9
9
|
The component provides a default slot which wraps the whole component with the `vendorResults` plus the `injectedListItems` which also contains the injected list items from the ancestor.
|
|
10
10
|
|
|
11
|
+
If the `queryPreviewHash` prop is provided, the vendor results are retrieved from [VendorState.queryPreviews](./x-components.vendorstate.querypreviews.md)<!-- -->, scoped to the query preview.
|
|
12
|
+
|
|
11
13
|
It also provides the parent slots to customize the items.
|
|
12
14
|
|
|
13
15
|
**Signature:**
|
|
@@ -18,6 +20,10 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
18
20
|
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
19
21
|
default: string;
|
|
20
22
|
};
|
|
23
|
+
queryPreviewHash: {
|
|
24
|
+
type: StringConstructor;
|
|
25
|
+
default: undefined;
|
|
26
|
+
};
|
|
21
27
|
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
|
|
22
28
|
[key: string]: any;
|
|
23
29
|
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
|
|
@@ -25,7 +31,12 @@ _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
|
|
|
25
31
|
type: (StringConstructor | ObjectConstructor | FunctionConstructor)[];
|
|
26
32
|
default: string;
|
|
27
33
|
};
|
|
34
|
+
queryPreviewHash: {
|
|
35
|
+
type: StringConstructor;
|
|
36
|
+
default: undefined;
|
|
37
|
+
};
|
|
28
38
|
}>> & Readonly<{}>, {
|
|
29
39
|
animation: string | Function | Record<string, any>;
|
|
40
|
+
queryPreviewHash: string;
|
|
30
41
|
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>
|
|
31
42
|
```
|
|
@@ -50,6 +50,25 @@ Description
|
|
|
50
50
|
</td><td>
|
|
51
51
|
|
|
52
52
|
|
|
53
|
+
</td></tr>
|
|
54
|
+
<tr><td>
|
|
55
|
+
|
|
56
|
+
[queryPreviews](./x-components.vendorstate.querypreviews.md)
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
</td><td>
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
</td><td>
|
|
63
|
+
|
|
64
|
+
Dictionary<[VendorQueryPreview](./x-components.vendorquerypreview.md)<!-- -->>
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
</td><td>
|
|
68
|
+
|
|
69
|
+
The vendor results and banners of the query previews, indexed by their query preview hash.
|
|
70
|
+
|
|
71
|
+
|
|
53
72
|
</td></tr>
|
|
54
73
|
<tr><td>
|
|
55
74
|
|
|
@@ -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) > [VendorState](./x-components.vendorstate.md) > [queryPreviews](./x-components.vendorstate.querypreviews.md)
|
|
4
|
+
|
|
5
|
+
## VendorState.queryPreviews property
|
|
6
|
+
|
|
7
|
+
The vendor results and banners of the query previews, indexed by their query preview hash.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
queryPreviews: Dictionary<VendorQueryPreview>;
|
|
13
|
+
```
|
|
@@ -37,6 +37,44 @@ Description
|
|
|
37
37
|
</th></tr></thead>
|
|
38
38
|
<tbody><tr><td>
|
|
39
39
|
|
|
40
|
+
[QueryPreviewVendorBannersChanged](./x-components.vendorxevents.querypreviewvendorbannerschanged.md)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td><td>
|
|
47
|
+
|
|
48
|
+
{ queryPreviewHash: string; banners: Omit<[VendorBanner](./x-components.vendorbanner.md)<!-- -->, 'modelName'>\[\]; }
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
</td><td>
|
|
52
|
+
|
|
53
|
+
The x consumer has provided vendor banners to be inserted in the result grid of a query preview. Payload: The query preview hash and the vendor banners to be inserted, without the `modelName` field, since it is assigned under the hood.
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
</td></tr>
|
|
57
|
+
<tr><td>
|
|
58
|
+
|
|
59
|
+
[QueryPreviewVendorResultsChanged](./x-components.vendorxevents.querypreviewvendorresultschanged.md)
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
</td><td>
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
</td><td>
|
|
66
|
+
|
|
67
|
+
{ queryPreviewHash: string; results: Omit<[VendorResult](./x-components.vendorresult.md)<!-- -->, 'modelName'>\[\]; }
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</td><td>
|
|
71
|
+
|
|
72
|
+
The x consumer has provided vendor results to be inserted in the result grid of a query preview. Payload: The query preview hash and the vendor results to be inserted, without the `modelName` field, since it is assigned under the hood.
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
</td></tr>
|
|
76
|
+
<tr><td>
|
|
77
|
+
|
|
40
78
|
[UserClickedAVendorBanner](./x-components.vendorxevents.userclickedavendorbanner.md)
|
|
41
79
|
|
|
42
80
|
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorXEvents](./x-components.vendorxevents.md) > [QueryPreviewVendorBannersChanged](./x-components.vendorxevents.querypreviewvendorbannerschanged.md)
|
|
4
|
+
|
|
5
|
+
## VendorXEvents.QueryPreviewVendorBannersChanged property
|
|
6
|
+
|
|
7
|
+
The x consumer has provided vendor banners to be inserted in the result grid of a query preview. Payload: The query preview hash and the vendor banners to be inserted, without the `modelName` field, since it is assigned under the hood.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
QueryPreviewVendorBannersChanged: {
|
|
13
|
+
queryPreviewHash: string;
|
|
14
|
+
banners: Omit<VendorBanner, 'modelName'>[];
|
|
15
|
+
};
|
|
16
|
+
```
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [VendorXEvents](./x-components.vendorxevents.md) > [QueryPreviewVendorResultsChanged](./x-components.vendorxevents.querypreviewvendorresultschanged.md)
|
|
4
|
+
|
|
5
|
+
## VendorXEvents.QueryPreviewVendorResultsChanged property
|
|
6
|
+
|
|
7
|
+
The x consumer has provided vendor results to be inserted in the result grid of a query preview. Payload: The query preview hash and the vendor results to be inserted, without the `modelName` field, since it is assigned under the hood.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
QueryPreviewVendorResultsChanged: {
|
|
13
|
+
queryPreviewHash: string;
|
|
14
|
+
results: Omit<VendorResult, 'modelName'>[];
|
|
15
|
+
};
|
|
16
|
+
```
|
|
@@ -11,3 +11,8 @@ The vendor module query has changed. Payload: The new vendor query string.
|
|
|
11
11
|
```typescript
|
|
12
12
|
VendorQueryChanged: string;
|
|
13
13
|
```
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
This event is also emitted when the module is registered, with the current query (which can be empty), to allow consumers to fetch the vendor results and banners even when there is no query yet.
|
|
18
|
+
|