@empathyco/x-components 3.0.0-alpha.156 → 3.0.0-alpha.159

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 (74) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/core/index.js.map +1 -1
  3. package/design-system/full-theme.css +41 -41
  4. package/docs/API-reference/api/x-components.md +9 -0
  5. package/docs/API-reference/api/x-components.queriespreviewactioncontext.md +15 -0
  6. package/docs/API-reference/api/x-components.queriespreviewactions.md +13 -0
  7. package/docs/API-reference/api/x-components.queriespreviewgetters.md +13 -0
  8. package/docs/API-reference/api/x-components.queriespreviewmutations.md +13 -0
  9. package/docs/API-reference/api/x-components.queriespreviewstate.md +13 -0
  10. package/docs/API-reference/api/x-components.queriespreviewxevents.md +13 -0
  11. package/docs/API-reference/api/x-components.queriespreviewxmodule.md +13 -0
  12. package/docs/API-reference/api/x-components.queriespreviewxstoremodule.md +15 -0
  13. package/docs/API-reference/api/x-components.xeventstypes.md +3 -3
  14. package/docs/API-reference/api/x-components.xmodulestree.md +1 -0
  15. package/docs/API-reference/api/x-components.xmodulestree.queriespreview.md +11 -0
  16. package/docs/build-search-ui/web-how-to-use-x-components-guide.md +1 -1
  17. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/README.md +22 -9
  18. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/empathize.md +7 -7
  19. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/facets-and-filters.md +24 -10
  20. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/history-queries.md +16 -13
  21. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/id-results.md +11 -6
  22. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/next-queries.md +24 -10
  23. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/popular-searches.md +19 -8
  24. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/product-results-ui.md +23 -10
  25. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/query-suggestions.md +20 -8
  26. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/recommendations.md +20 -8
  27. package/docs/experience-search-and-discovery/related-tags.md +48 -0
  28. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/search-box.md +28 -17
  29. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/serp-ui.md +31 -19
  30. package/docs/{experience-search-&-discovery → experience-search-and-discovery}/web-local-storage.md +0 -0
  31. package/js/index.js +4 -0
  32. package/js/index.js.map +1 -1
  33. package/js/store/x.module.js +1 -0
  34. package/js/store/x.module.js.map +1 -1
  35. package/js/x-modules/extra-params/x-module.js.map +1 -1
  36. package/js/x-modules/queries-preview/store/emitters.js +12 -0
  37. package/js/x-modules/queries-preview/store/emitters.js.map +1 -0
  38. package/js/x-modules/queries-preview/store/module.js +14 -0
  39. package/js/x-modules/queries-preview/store/module.js.map +1 -0
  40. package/js/x-modules/queries-preview/wiring.js +11 -0
  41. package/js/x-modules/queries-preview/wiring.js.map +1 -0
  42. package/js/x-modules/queries-preview/x-module.js +19 -0
  43. package/js/x-modules/queries-preview/x-module.js.map +1 -0
  44. package/package.json +5 -5
  45. package/queries-preview/index.d.ts +1 -0
  46. package/queries-preview/index.js +4 -0
  47. package/report/x-components.api.json +310 -2
  48. package/report/x-components.api.md +44 -1
  49. package/types/index.d.ts +1 -0
  50. package/types/index.d.ts.map +1 -1
  51. package/types/store/x.module.d.ts.map +1 -1
  52. package/types/wiring/events.types.d.ts +3 -1
  53. package/types/wiring/events.types.d.ts.map +1 -1
  54. package/types/x-modules/extra-params/x-module.d.ts +1 -1
  55. package/types/x-modules/extra-params/x-module.d.ts.map +1 -1
  56. package/types/x-modules/queries-preview/events.types.d.ts +9 -0
  57. package/types/x-modules/queries-preview/events.types.d.ts.map +1 -0
  58. package/types/x-modules/queries-preview/index.d.ts +5 -0
  59. package/types/x-modules/queries-preview/index.d.ts.map +1 -0
  60. package/types/x-modules/queries-preview/store/emitters.d.ts +7 -0
  61. package/types/x-modules/queries-preview/store/emitters.d.ts.map +1 -0
  62. package/types/x-modules/queries-preview/store/index.d.ts +4 -0
  63. package/types/x-modules/queries-preview/store/index.d.ts.map +1 -0
  64. package/types/x-modules/queries-preview/store/module.d.ts +8 -0
  65. package/types/x-modules/queries-preview/store/module.d.ts.map +1 -0
  66. package/types/x-modules/queries-preview/store/types.d.ts +42 -0
  67. package/types/x-modules/queries-preview/store/types.d.ts.map +1 -0
  68. package/types/x-modules/queries-preview/wiring.d.ts +7 -0
  69. package/types/x-modules/queries-preview/wiring.d.ts.map +1 -0
  70. package/types/x-modules/queries-preview/x-module.d.ts +16 -0
  71. package/types/x-modules/queries-preview/x-module.d.ts.map +1 -0
  72. package/types/x-modules/x-modules.types.d.ts +6 -2
  73. package/types/x-modules/x-modules.types.d.ts.map +1 -1
  74. package/docs/experience-search-&-discovery/related-tags.md +0 -41
package/CHANGELOG.md CHANGED
@@ -3,6 +3,53 @@
3
3
  All notable changes to this project will be documented in this file. See
4
4
  [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [3.0.0-alpha.159](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.158...@empathyco/x-components@3.0.0-alpha.159) (2022-08-24)
7
+
8
+ ### Documentation
9
+
10
+ - update functional docs callout formatting (#671)
11
+ ([5f1de74](https://github.com/empathyco/x/commit/5f1de74c2e86adb638d692781483cac1ccf70a71))
12
+
13
+ # Change Log
14
+
15
+ All notable changes to this project will be documented in this file. See
16
+ [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
17
+
18
+ ## [3.0.0-alpha.158](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.156...@empathyco/x-components@3.0.0-alpha.158) (2022-08-24)
19
+
20
+ ### Features
21
+
22
+ - **adapter:** disable cancel http client (#658)
23
+ ([3b5b86d](https://github.com/empathyco/x/commit/3b5b86d4725edefa084181a704df716a389eecbc)),
24
+ closes [EX-6875](https://searchbroker.atlassian.net/browse/EX-6875)
25
+ - **queries-preview:** create `queriesPreview` module (#670)
26
+ ([317d961](https://github.com/empathyco/x/commit/317d961e94b0b7454cb4d858d401c4264c74cf0e)),
27
+ closes [EX-6638](https://searchbroker.atlassian.net/browse/EX-6638)
28
+
29
+ ### Bug Fixes
30
+
31
+ - conflict version (#673)
32
+ ([fb74dd0](https://github.com/empathyco/x/commit/fb74dd0b992522a9441da1daabe5a8789426324f)),
33
+ closes [EX-6896](https://searchbroker.atlassian.net/browse/EX-6896)
34
+
35
+ # Change Log
36
+
37
+ All notable changes to this project will be documented in this file. See
38
+ [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
39
+
40
+ ## [3.0.0-alpha.157](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.156...@empathyco/x-components@3.0.0-alpha.157) (2022-08-24)
41
+
42
+ ### Features
43
+
44
+ - **queries-preview:** create `queriesPreview` module (#670)
45
+ ([317d961](https://github.com/empathyco/x/commit/317d961e94b0b7454cb4d858d401c4264c74cf0e)),
46
+ closes [EX-6638](https://searchbroker.atlassian.net/browse/EX-6638)
47
+
48
+ # Change Log
49
+
50
+ All notable changes to this project will be documented in this file. See
51
+ [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
52
+
6
53
  ## [3.0.0-alpha.156](https://github.com/empathyco/x/compare/@empathyco/x-components@3.0.0-alpha.155...@empathyco/x-components@3.0.0-alpha.156) (2022-08-19)
7
54
 
8
55
  **Note:** Version bump only for package @empathyco/x-components
package/core/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
1
+ {"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
@@ -1310,6 +1310,47 @@
1310
1310
  [dir="rtl"] .x-input-group > .x-input-group__action:last-child {
1311
1311
  margin-left: calc(var(--x-size-border-width-right-input-group-default) * -1);
1312
1312
  }
1313
+ .x-input-group--line .x-input-group,
1314
+ .x-input-group--line.x-input-group {
1315
+ --x-size-border-width-top-input-group-default: var(--x-size-border-width-top-input-group-line);
1316
+ --x-size-border-width-right-input-group-default: var(
1317
+ --x-size-border-width-right-input-group-line
1318
+ );
1319
+ --x-size-border-width-bottom-input-group-default: var(
1320
+ --x-size-border-width-bottom-input-group-line
1321
+ );
1322
+ --x-size-border-width-left-input-group-default: var(--x-size-border-width-left-input-group-line);
1323
+ }
1324
+ .x-input-group--line .x-input-group > *:not(.x-input-group__action),
1325
+ .x-input-group--line.x-input-group > *:not(.x-input-group__action) {
1326
+ --x-size-padding-right-input-group-default: var(--x-size-padding-right-input-group-line);
1327
+ --x-size-padding-left-input-group-default: var(--x-size-padding-left-input-group-line);
1328
+ }
1329
+ [dir="ltr"] .x-input-group--line .x-input-group > .x-input-group__action,[dir="ltr"]
1330
+ .x-input-group--line.x-input-group > .x-input-group__action {
1331
+ margin-right: calc(var(--x-size-border-width-right-input-group-line) * -1) !important;
1332
+ }
1333
+ [dir="rtl"] .x-input-group--line .x-input-group > .x-input-group__action,[dir="rtl"]
1334
+ .x-input-group--line.x-input-group > .x-input-group__action {
1335
+ margin-left: calc(var(--x-size-border-width-right-input-group-line) * -1) !important;
1336
+ }
1337
+ [dir="ltr"] .x-input-group--line .x-input-group > .x-input-group__action,[dir="ltr"]
1338
+ .x-input-group--line.x-input-group > .x-input-group__action {
1339
+ margin-left: calc(
1340
+ var(--x-size-border-width-inline-input-group-line) * -1
1341
+ ) !important;
1342
+ }
1343
+ [dir="rtl"] .x-input-group--line .x-input-group > .x-input-group__action,[dir="rtl"]
1344
+ .x-input-group--line.x-input-group > .x-input-group__action {
1345
+ margin-right: calc(
1346
+ var(--x-size-border-width-inline-input-group-line) * -1
1347
+ ) !important;
1348
+ }
1349
+ .x-input-group--line .x-input-group > .x-input-group__action,
1350
+ .x-input-group--line.x-input-group > .x-input-group__action {
1351
+ margin-top: calc(var(--x-size-border-width-top-input-group-line) * -1) !important;
1352
+ margin-bottom: calc(var(--x-size-border-width-bottom-input-group-line) * -1) !important;
1353
+ }
1313
1354
  :root {
1314
1355
  --x-color-background-input-group-default: var(--x-color-background-input-default);
1315
1356
  --x-color-border-input-group-default: var(--x-color-border-input-default);
@@ -1353,47 +1394,6 @@
1353
1394
  );
1354
1395
  --x-number-font-weight-input-group-default-button: var(--x-number-font-weight-base-light);
1355
1396
  }
1356
- .x-input-group--line .x-input-group,
1357
- .x-input-group--line.x-input-group {
1358
- --x-size-border-width-top-input-group-default: var(--x-size-border-width-top-input-group-line);
1359
- --x-size-border-width-right-input-group-default: var(
1360
- --x-size-border-width-right-input-group-line
1361
- );
1362
- --x-size-border-width-bottom-input-group-default: var(
1363
- --x-size-border-width-bottom-input-group-line
1364
- );
1365
- --x-size-border-width-left-input-group-default: var(--x-size-border-width-left-input-group-line);
1366
- }
1367
- .x-input-group--line .x-input-group > *:not(.x-input-group__action),
1368
- .x-input-group--line.x-input-group > *:not(.x-input-group__action) {
1369
- --x-size-padding-right-input-group-default: var(--x-size-padding-right-input-group-line);
1370
- --x-size-padding-left-input-group-default: var(--x-size-padding-left-input-group-line);
1371
- }
1372
- [dir="ltr"] .x-input-group--line .x-input-group > .x-input-group__action,[dir="ltr"]
1373
- .x-input-group--line.x-input-group > .x-input-group__action {
1374
- margin-right: calc(var(--x-size-border-width-right-input-group-line) * -1) !important;
1375
- }
1376
- [dir="rtl"] .x-input-group--line .x-input-group > .x-input-group__action,[dir="rtl"]
1377
- .x-input-group--line.x-input-group > .x-input-group__action {
1378
- margin-left: calc(var(--x-size-border-width-right-input-group-line) * -1) !important;
1379
- }
1380
- [dir="ltr"] .x-input-group--line .x-input-group > .x-input-group__action,[dir="ltr"]
1381
- .x-input-group--line.x-input-group > .x-input-group__action {
1382
- margin-left: calc(
1383
- var(--x-size-border-width-inline-input-group-line) * -1
1384
- ) !important;
1385
- }
1386
- [dir="rtl"] .x-input-group--line .x-input-group > .x-input-group__action,[dir="rtl"]
1387
- .x-input-group--line.x-input-group > .x-input-group__action {
1388
- margin-right: calc(
1389
- var(--x-size-border-width-inline-input-group-line) * -1
1390
- ) !important;
1391
- }
1392
- .x-input-group--line .x-input-group > .x-input-group__action,
1393
- .x-input-group--line.x-input-group > .x-input-group__action {
1394
- margin-top: calc(var(--x-size-border-width-top-input-group-line) * -1) !important;
1395
- margin-bottom: calc(var(--x-size-border-width-bottom-input-group-line) * -1) !important;
1396
- }
1397
1397
  :root {
1398
1398
  --x-size-padding-left-input-group-line: 0;
1399
1399
  --x-size-padding-right-input-group-line: 0;
@@ -272,6 +272,11 @@ X-Components is a library usable everywhere not only for search experiences.
272
272
  | [PopularSearchesState](./x-components.popularsearchesstate.md) | Popular searches module state. |
273
273
  | [PopularSearchesXEvents](./x-components.popularsearchesxevents.md) | Dictionary of the events of PopularSearches XModule, where each key is the event name, and the value is the event payload type or <code>void</code> if it has no payload. |
274
274
  | [PrivateXModuleOptions](./x-components.privatexmoduleoptions.md) | Options for overriding the default store module and store emitters for a [XModule](./x-components.xmodule.md)<!-- -->. |
275
+ | [QueriesPreviewActions](./x-components.queriespreviewactions.md) | QueriesPreview store actions. |
276
+ | [QueriesPreviewGetters](./x-components.queriespreviewgetters.md) | QueriesPreview store getters. |
277
+ | [QueriesPreviewMutations](./x-components.queriespreviewmutations.md) | QueriesPreview store mutations. |
278
+ | [QueriesPreviewState](./x-components.queriespreviewstate.md) | QueriesPreview store state. |
279
+ | [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md) | Dictionary of the events of QueriesPreview XModule, where each key is the event name, and the value is the event payload type or <code>void</code> if it has no payload. |
275
280
  | [QueryPreview](./x-components.querypreview.md) | Information to render a query preview with. |
276
281
  | [QuerySuggestionsActions](./x-components.querysuggestionsactions.md) | QuerySuggestions store actions. |
277
282
  | [QuerySuggestionsConfig](./x-components.querysuggestionsconfig.md) | Configuration options for the [QuerySuggestionsXModule](./x-components.querysuggestionsxmodule.md)<!-- -->. |
@@ -470,6 +475,7 @@ X-Components is a library usable everywhere not only for search experiences.
470
475
  | [popularSearches](./x-components.popularsearches.md) | Default implementation for the [PopularSearchesGetters.popularSearches](./x-components.popularsearchesgetters.popularsearches.md) getter. |
471
476
  | [popularSearchesRequest](./x-components.popularsearchesrequest.md) | Default implementation for the [PopularSearchesGetters.request](./x-components.popularsearchesgetters.request.md) getter. |
472
477
  | [popularSearchesXModule](./x-components.popularsearchesxmodule.md) | Popular searches [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the <code>popular-searches</code> entry point. |
478
+ | [queriesPreviewXModule](./x-components.queriespreviewxmodule.md) | QueriesPreview [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the <code>queries-preview</code> entry point. |
473
479
  | [querySuggestions](./x-components.querysuggestions.md) | Default implementation for the [QuerySuggestionsGetter.querySuggestions()](./x-components.querysuggestionsgetter.querysuggestions.md) getter. |
474
480
  | [querySuggestionsRequest](./x-components.querysuggestionsrequest.md) | Default implementation for the [QuerySuggestionsGetters.request](./x-components.querysuggestionsgetters.request.md) getter. |
475
481
  | [querySuggestionsXModule](./x-components.querysuggestionsxmodule.md) | QuerySuggestions [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the <code>query-suggestions</code> entry point. |
@@ -652,6 +658,9 @@ X-Components is a library usable everywhere not only for search experiences.
652
658
  | [PopularSearchesXStoreModule](./x-components.popularsearchesxstoremodule.md) | Popular searches store module. |
653
659
  | [PrivateXModulesOptions](./x-components.privatexmodulesoptions.md) | Options for overriding the default store module and store emitters for each [XModule](./x-components.xmodule.md)<!-- -->. |
654
660
  | [PropsWithType](./x-components.propswithtype.md) | Extracts the name of the properties of an object that match a type. |
661
+ | [QueriesPreviewActionContext](./x-components.queriespreviewactioncontext.md) | Alias type for actions context of the [QueriesPreviewXStoreModule](./x-components.queriespreviewxstoremodule.md)<!-- -->. |
662
+ | [QueriesPreviewXModule](./x-components.queriespreviewxmodule.md) | QueriesPreview [XModule](./x-components.xmodule.md) alias. |
663
+ | [QueriesPreviewXStoreModule](./x-components.queriespreviewxstoremodule.md) | QueriesPreview type safe store module. |
655
664
  | [QueryFeature](./x-components.queryfeature.md) | The name of the tool that generated the query. |
656
665
  | [QueryOrigin](./x-components.queryorigin.md) | Information to track the usefulness of the query in relation to the [QueryFeature](./x-components.queryfeature.md) that generated it, and the [FeatureLocation](./x-components.featurelocation.md) where it has been shown to the user. |
657
666
  | [QueryOriginInit](./x-components.queryorigininit.md) | Parameters to create a [QueryOrigin](./x-components.queryorigin.md) or [ResultOrigin](./x-components.resultorigin.md)<!-- -->. |
@@ -0,0 +1,15 @@
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; [QueriesPreviewActionContext](./x-components.queriespreviewactioncontext.md)
4
+
5
+ ## QueriesPreviewActionContext type
6
+
7
+ Alias type for actions context of the [QueriesPreviewXStoreModule](./x-components.queriespreviewxstoremodule.md)<!-- -->.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export declare type QueriesPreviewActionContext = XActionContext<QueriesPreviewState, QueriesPreviewGetters, QueriesPreviewMutations, QueriesPreviewActions>;
13
+ ```
14
+ <b>References:</b> [XActionContext](./x-components.xactioncontext.md)<!-- -->, [QueriesPreviewState](./x-components.queriespreviewstate.md)<!-- -->, [QueriesPreviewGetters](./x-components.queriespreviewgetters.md)<!-- -->, [QueriesPreviewMutations](./x-components.queriespreviewmutations.md)<!-- -->, [QueriesPreviewActions](./x-components.queriespreviewactions.md)
15
+
@@ -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; [QueriesPreviewActions](./x-components.queriespreviewactions.md)
4
+
5
+ ## QueriesPreviewActions interface
6
+
7
+ QueriesPreview store actions.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export interface QueriesPreviewActions
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; [QueriesPreviewGetters](./x-components.queriespreviewgetters.md)
4
+
5
+ ## QueriesPreviewGetters interface
6
+
7
+ QueriesPreview store getters.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export interface QueriesPreviewGetters
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; [QueriesPreviewMutations](./x-components.queriespreviewmutations.md)
4
+
5
+ ## QueriesPreviewMutations interface
6
+
7
+ QueriesPreview store mutations.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export interface QueriesPreviewMutations
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; [QueriesPreviewState](./x-components.queriespreviewstate.md)
4
+
5
+ ## QueriesPreviewState interface
6
+
7
+ QueriesPreview store state.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export interface QueriesPreviewState
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; [QueriesPreviewXEvents](./x-components.queriespreviewxevents.md)
4
+
5
+ ## QueriesPreviewXEvents interface
6
+
7
+ Dictionary of the events of QueriesPreview XModule, where each key is the event name, and the value is the event payload type or `void` if it has no payload.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export interface QueriesPreviewXEvents
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; [queriesPreviewXModule](./x-components.queriespreviewxmodule.md)
4
+
5
+ ## queriesPreviewXModule variable
6
+
7
+ QueriesPreview [XModule](./x-components.xmodule.md) implementation. This module is auto-registered as soon as you import any component from the `queries-preview` entry point.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ queriesPreviewXModule: QueriesPreviewXModule
13
+ ```
@@ -0,0 +1,15 @@
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; [QueriesPreviewXStoreModule](./x-components.queriespreviewxstoremodule.md)
4
+
5
+ ## QueriesPreviewXStoreModule type
6
+
7
+ QueriesPreview type safe store module.
8
+
9
+ <b>Signature:</b>
10
+
11
+ ```typescript
12
+ export declare type QueriesPreviewXStoreModule = XStoreModule<QueriesPreviewState, QueriesPreviewGetters, QueriesPreviewMutations, QueriesPreviewActions>;
13
+ ```
14
+ <b>References:</b> [XStoreModule](./x-components.xstoremodule.md)<!-- -->, [QueriesPreviewState](./x-components.queriespreviewstate.md)<!-- -->, [QueriesPreviewGetters](./x-components.queriespreviewgetters.md)<!-- -->, [QueriesPreviewMutations](./x-components.queriespreviewmutations.md)<!-- -->, [QueriesPreviewActions](./x-components.queriespreviewactions.md)
15
+
@@ -9,13 +9,13 @@ Dictionary of all the [XEvents](./x-components.xevent.md)<!-- -->, where each ke
9
9
  <b>Signature:</b>
10
10
 
11
11
  ```typescript
12
- export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, TaggingXEvents, UrlXEvents
12
+ export interface XEventsTypes extends DeviceXEvents, EmpathizeXEvents, ExtraParamsXEvents, FacetsXEvents, HistoryQueriesXEvents, IdentifierResultsXEvents, NextQueriesXEvents, PopularSearchesXEvents, QueriesPreviewXEvents, QuerySuggestionsXEvents, RecommendationsXEvents, RelatedTagsXEvents, ScrollXEvents, SearchBoxXEvents, SearchXEvents, TaggingXEvents, UrlXEvents
13
13
  ```
14
- <b>Extends:</b> [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)<!-- -->, [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)<!-- -->, [TaggingXEvents](./x-components.taggingxevents.md)<!-- -->, [UrlXEvents](./x-components.urlxevents.md)
14
+ <b>Extends:</b> [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)<!-- -->, [TaggingXEvents](./x-components.taggingxevents.md)<!-- -->, [UrlXEvents](./x-components.urlxevents.md)
15
15
 
16
16
  ## Remarks
17
17
 
18
- Aside from common [XEvents](./x-components.xevent.md)<!-- -->, this interface also extends the different XModule's XEventsTypes: [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) [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) [TaggingXEvents](./x-components.taggingxevents.md) [UrlXEvents](./x-components.urlxevents.md)
18
+ Aside from common [XEvents](./x-components.xevent.md)<!-- -->, this interface also extends the different XModule's XEventsTypes: [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) [TaggingXEvents](./x-components.taggingxevents.md) [UrlXEvents](./x-components.urlxevents.md)
19
19
 
20
20
  ## Properties
21
21
 
@@ -24,6 +24,7 @@ export interface XModulesTree
24
24
  | [identifierResults](./x-components.xmodulestree.identifierresults.md) | [IdentifierResultsXModule](./x-components.identifierresultsxmodule.md) | |
25
25
  | [nextQueries](./x-components.xmodulestree.nextqueries.md) | [NextQueriesXModule](./x-components.nextqueriesxmodule.md) | |
26
26
  | [popularSearches](./x-components.xmodulestree.popularsearches.md) | [PopularSearchesXModule](./x-components.popularsearchesxmodule.md) | |
27
+ | [queriesPreview](./x-components.xmodulestree.queriespreview.md) | [QueriesPreviewXModule](./x-components.queriespreviewxmodule.md) | |
27
28
  | [querySuggestions](./x-components.xmodulestree.querysuggestions.md) | [QuerySuggestionsXModule](./x-components.querysuggestionsxmodule.md) | |
28
29
  | [recommendations](./x-components.xmodulestree.recommendations.md) | [RecommendationsXModule](./x-components.recommendationsxmodule.md) | |
29
30
  | [relatedTags](./x-components.xmodulestree.relatedtags.md) | [RelatedTagsXModule](./x-components.relatedtagsxmodule.md) | |
@@ -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; [queriesPreview](./x-components.xmodulestree.queriespreview.md)
4
+
5
+ ## XModulesTree.queriesPreview property
6
+
7
+ <b>Signature:</b>
8
+
9
+ ```typescript
10
+ queriesPreview: QueriesPreviewXModule;
11
+ ```
@@ -111,7 +111,7 @@ The `search-box` module contains these components:
111
111
  ::: interact
112
112
 
113
113
  Learn more about the
114
- [Search Box UI](/explore-empathy-platform/experience-search-&-discovery/search-box.md)
114
+ [Search Box UI](/explore-empathy-platform/experience-search-and-discovery/search-box.md)
115
115
 
116
116
  :::
117
117
 
@@ -30,7 +30,8 @@ Apps cover everything and even go beyond, thanks to their standalone, configurab
30
30
  that allow you to quickly construct the search UI for your store:
31
31
  **Interface&nbsp;X&nbsp;Components** and **Interface&nbsp;X&nbsp;Components for Apps**.
32
32
 
33
- **Mix and match your experience** Each X&nbsp;Component represents a graphical part of the UI, with
33
+ **Mix and match your experience**
34
+ Each X&nbsp;Component represents a graphical part of the UI, with
34
35
  its own unique view and behavior. They’ve been smartly designed to **work together yet
35
36
  independently**, so a single component adds real value to your UI by itself. The more components you
36
37
  add and combine, the more functionality you get.
@@ -53,7 +54,9 @@ choose the modules and components that best suit your needs.
53
54
  - Mix & match. Customize to satisfy any design or behavior requirement
54
55
  - Mobile-ready. Designed both for web and native apps
55
56
  - Adapt to different search services
56
- - Easy-to-use. Intuitive search and discovery :::
57
+ - Easy-to-use. Intuitive search and discovery
58
+
59
+ :::
57
60
 
58
61
  ## Try X Components to…
59
62
 
@@ -67,13 +70,19 @@ choose the modules and components that best suit your needs.
67
70
  - Enhance the shopping experience by adding **additional features to the SERP** such as add-to-cart
68
71
  buttons or product rating information.
69
72
 
70
- :::warning Some X&nbsp;Components are supported by Empathy Platform search and discovery features.
71
- If you’re using a different search engine, make sure it supports all the functionalities you need.
73
+ ::: warning
74
+
75
+ Some X&nbsp;Components are supported by Empathy Platform search and discovery features. If you’re
76
+ using a different search engine, make sure it supports all the functionalities you need.
77
+
72
78
  :::
73
79
 
74
- ::: interact Explore the Empathy Platform
75
- [interactive map](/explore-empathy-platform/diagram/interface/) for a sneak peak of the
76
- X&nbsp;Components available! :::
80
+ ::: interact
81
+
82
+ Explore the Empathy Platform [interactive map](/explore-empathy-platform/diagram/interface/) for a
83
+ sneak peak of the X&nbsp;Components available!
84
+
85
+ :::
77
86
 
78
87
  ---
79
88
 
@@ -96,8 +105,12 @@ want to make the difference!
96
105
  'x_facets']"
97
106
  />
98
107
 
99
- ::: note Check out the **Interface X for web [open-source project](https://github.com/empathyco/x)**
100
- on GitHub! :::
108
+ ::: note
109
+
110
+ Check out the **Interface X for web [open-source project](https://github.com/empathyco/x)** on
111
+ GitHub!
112
+
113
+ :::
101
114
 
102
115
  ---
103
116
 
@@ -11,7 +11,9 @@ experience that is usually displayed below the search box. Consider it the natur
11
11
 
12
12
  ![Empathize](/assets/media/xcomponents_func_empathize.gif)
13
13
 
14
- **Placement matters** One of the characteristics of X&nbsp;Components is that you can place them
14
+ **Placement matters**
15
+
16
+ One of the characteristics of X&nbsp;Components is that you can place them
15
17
  wherever you want. However, you know that the placement of the search box in your shop matters. So,
16
18
  why have search suggestions and recommendations spread all over the page, far away from the search
17
19
  box? The Empathize container brings everything together so that your shoppers perceive a smooth,
@@ -92,11 +94,9 @@ search capabilities, such as Query Suggestions and Popular Searches. Don’t get
92
94
  - Determine when Empathize appears and disappears.
93
95
  - Animate how the component opens and closes.
94
96
 
95
- ::: interact Want to know more? Learn how to [configure](/empathy-for-developers/ui-reference/) your
96
- web experience. :::
97
+ ::: interact
98
+
99
+ Want to know more? Learn how to [configure](/develop-empathy-platform/ui-reference/) your web
100
+ experience.
97
101
 
98
- <!---
99
- ::: note
100
- To see Empathize in action, play with our showcase.
101
102
  :::
102
- --->
@@ -24,8 +24,12 @@ discovery**. You can guide shoppers through your product catalogue faster, allow
24
24
  and browse different product classifications directly from the faceted menu in your shop, without
25
25
  having to search.-->
26
26
 
27
- ::: interact Can't quite capture the concept? Learn more about
28
- [Facets and Filters](../overview/facets-and-filters-overview.md). :::
27
+ ::: interact
28
+
29
+ Can't quite capture the concept? Learn more about
30
+ [Facets and Filters](../overview/facets-and-filters-overview.md).
31
+
32
+ :::
29
33
 
30
34
  ## Build a faceted experience with X Components
31
35
 
@@ -41,7 +45,7 @@ results **clearer and more accessible**, meeting different types of faceting lay
41
45
 
42
46
  <img :src="$withBase('/assets/media/x-components_func_facets.png')" alt="Facets" />
43
47
 
44
- :::details Rendering facets and filters
48
+ ::: details Rendering facets and filters
45
49
 
46
50
  X&nbsp;Components for facets and filters not only enhances your shoppers’ experience by supporting
47
51
  and rendering faceted search and navigation, but also provides different ways to display a faceted
@@ -61,9 +65,11 @@ experience:
61
65
  attributes. For example, the _Price_ facet in a grocery store can display “< €0.99”, “€1 – €4.99”,
62
66
  “€5 – €9.99”, or “€10 – €19.99”. Implement **editable number range facets** and let your shoppers
63
67
  define the numerical ranges they want to filter by. Shoppers can type the desired price range to
64
- filter by in the _From_ - _To_ or _Min_ - _Max_ input fields available. :::
68
+ filter by in the _From_ - _To_ or _Min_ - _Max_ input fields available.
65
69
 
66
- :::details Extending facets and filters UI
70
+ :::
71
+
72
+ ::: details Extending facets and filters UI
67
73
 
68
74
  Apart from the main X&nbsp;Components for facets and filters that render product categories and
69
75
  their corresponding attributes in different ways, there are components available offering advanced
@@ -101,6 +107,7 @@ into icons or images such as stars for average rating-based filtering, for examp
101
107
 
102
108
  You can also change the default single-select behavior and activate **multi-select** controls so
103
109
  that shoppers can select more than one filter value at a time from the same facet to expand results.
110
+
104
111
  :::
105
112
 
106
113
  ## Tailor the web experience
@@ -129,10 +136,17 @@ that shoppers can select more than one filter value at a time from the same face
129
136
  - Customize facet data at your ease. You can opt to render facets defined in your product catalogue
130
137
  automatically, display custom facets, or even render a mix of them.
131
138
 
132
- ::: warning Make sure your current Search microservice is compatible with this kind of
133
- configuration. :::
139
+ ::: warning
140
+
141
+ Make sure your current Search microservice is compatible with this kind of configuration.
142
+
143
+ :::
144
+
145
+ ::: interact
146
+
147
+ Want to know more? Learn how to [configure](/develop-empathy-platform/ui-reference/) your web
148
+ experience.
149
+
150
+ :::
134
151
 
135
- ::: interact Want to know more? Learn how to [configure](/develop-empathy-platform/ui-reference/)
136
- your web experience. :::
137
152
 
138
- [//]: # 'To see Facets and Filters in action, play with our showcase'
@@ -9,8 +9,11 @@ searches and revisit products they’ve viewed before in a few clicks.
9
9
 
10
10
  ![History Queries](/assets/media/xcomponents_func_historyqueries.gif)
11
11
 
12
- ::: interact Can't quite capture the concept? Learn more about
13
- [History Queries](../features/history-queries-overview.md).
12
+ ::: interact
13
+
14
+ Can't quite capture the concept? Learn more about
15
+ [History Queries](../features/history-queries-overview.md).
16
+
14
17
  :::
15
18
 
16
19
  ## Tailor the web experience
@@ -31,9 +34,11 @@ searches and revisit products they’ve viewed before in a few clicks.
31
34
  search, and it’s narrowed down using “long dress”, the history queries list only displays “long
32
35
  dress” since it represents the shopper’s real intention.
33
36
 
34
- ::: interact
37
+ ::: interact
38
+
35
39
  Want to know more? Learn how to [configure](/develop-empathy-platform/ui-reference/) your web
36
- experience.
40
+ experience.
41
+
37
42
  :::
38
43
 
39
44
  ## Extend the performance
@@ -43,14 +48,12 @@ component. All suggestions for shoppers about what to look next can be filtered
43
48
  shopper’s search history so that only those suggestions that haven’t been used before in that
44
49
  session will display.
45
50
 
46
- [//]: # 'Link only when available to Search module page in UI reference'
47
-
48
- Combine History Queries with the Search X module to ease shoppers' frustrations. That way, you can
51
+ Combine History Queries with the [Search module](/develop-empathy-platform/ui-reference/components/search/) to ease shoppers' frustrations. That way, you can
49
52
  configure it to display only successful history searches.
50
53
 
51
- [//]:
52
- #
53
- 'TIP: To know more about which data is stored in the browser’s data storage, read [page title to be defined].'
54
- [//]:
55
- #
56
- 'To see History Queries in action, [play with our interactive examples](/develop-empathy-platform/ui-reference/history-queries/history-queries.md#see-it-in-action'
54
+
55
+ ::: interact
56
+
57
+ To know more about which data is stored in the browser’s data storage, check out [nterface X data privacy and browser local storage](/web-local-storage.md).'
58
+
59
+ :::
@@ -14,12 +14,16 @@ the list, they go directly to the product detail page (PDP).
14
14
  :::warning
15
15
 
16
16
  ID Results are generated using a Search service that searches the product catalogue by ID. For a
17
- correct performance, make sure that your current search service supports this type of feature. :::
17
+ correct performance, make sure that your current search service supports this type of feature.
18
+
19
+ :::
18
20
 
19
21
  ::: interact
20
22
 
21
23
  Don't quite understand ID results? Learn more about
22
- [ID Results](../features/id-results-overview.md). :::
24
+ [ID Results](../features/id-results-overview.md).
25
+
26
+ :::
23
27
 
24
28
  ## Tailor the web experience
25
29
 
@@ -29,12 +33,13 @@ Don't quite understand ID results? Learn more about
29
33
  - Show as many ID Results as you want.
30
34
  - Animate the display of ID Results at your ease.
31
35
  - Customize content. Show whatever you need: text, images, icons.
32
- - Extend the performance with [results-related components](results-display.md).
36
+ - Extend the performance with [results-related components](product-results-ui.md).
33
37
  - Meet your own code reference conventions and standards with multiple product reference patterns.
34
38
 
35
- ::: interact Want to know more? Learn how to [configure](/develop-empathy-platform/ui-reference/)
36
- your web experience.
39
+ ::: interact
40
+
41
+ Want to know more? Learn how to [configure](/develop-empathy-platform/ui-reference/) your web
42
+ experience.
37
43
 
38
44
  :::
39
45
 
40
- <!-- (To see Identifier Results in action, play with our interactive examples) -->