From b27f562bd81b6ecbdefe23bce05b3a48bc04aa92 Mon Sep 17 00:00:00 2001 From: herrardo Date: Thu, 26 Oct 2023 15:36:35 +0200 Subject: [PATCH] docs: add prettier changes --- .../web-archetype-integration-guide.md | 12 +++++------ .../experience-search-and-discovery/README.md | 3 +-- .../empathize.md | 18 +++++++++------- .../facets-and-filters.md | 4 ++-- .../history-queries.md | 4 ++-- .../id-results.md | 4 ++-- .../my-history.md | 4 ++-- .../next-queries.md | 11 +++++----- .../popular-searches.md | 4 ++-- .../product-results-ui.md | 4 ++-- .../query-suggestions.md | 4 ++-- .../related-tags.md | 4 ++-- .../search-box.md | 10 +++++---- .../serp-ui.md | 14 ++++++------- .../web-local-storage.md | 21 ++++++++++--------- 15 files changed, 63 insertions(+), 58 deletions(-) diff --git a/packages/x-components/static-docs/build-search-ui/web-archetype-integration-guide.md b/packages/x-components/static-docs/build-search-ui/web-archetype-integration-guide.md index 44adfbb7bf..15491cbf98 100644 --- a/packages/x-components/static-docs/build-search-ui/web-archetype-integration-guide.md +++ b/packages/x-components/static-docs/build-search-ui/web-archetype-integration-guide.md @@ -308,12 +308,12 @@ object allows your commerce store to communicate with Interface X. It suppo functions to integrate Interface X in your website. You can access these functions inside the `window.InterfaceX` object. -| Function | Parameters | Description | -| ------------------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `init` | [snippet configuration params](#snippet-configuration) - _Required_. Initialization options | [Initializes Interface X on demand](#initializing-interface-x-project-on-demand). | -| `search` | `query` - _Optional_. Query to open Interface X | Executes Interface X and triggers a search with the given query. | -| `close` | none | Closes Interface X search layer. | -| `setSnippetConfig` | [snippet configuration params](#snippet-configuration) - _Required_. Initialization options | Changes initialization options so that all components react to the changes, i.e. changing both search engine and language without reloading the page. | +| Function | Parameters | Description | +| ------------------ | ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `init` | [snippet configuration params](#snippet-configuration) - _Required_. Initialization options | [Initializes Interface X on demand](#initializing-interface-x-project-on-demand). | +| `search` | `query` - _Optional_. Query to open Interface X | Executes Interface X and triggers a search with the given query. | +| `close` | none | Closes Interface X search layer. | +| `setSnippetConfig` | [snippet configuration params](#snippet-configuration) - _Required_. Initialization options | Changes initialization options so that all components react to the changes, i.e. changing both search engine and language without reloading the page. | | `addProductToCart` | `productId` - _Optional._ Id of the product added to cart | Sends tracking of the `AddToCart` event to the [Empathy Tagging microservice](/develop-empathy-platform/capture-interaction-signals/tagging-api-guide.md) for the product displayed on screen. This function is called from the product detail page (PDP) when the shopper clicks on the add-to-cart button. If the `productId` is not provided, the URL detects whether the shopper found the product via a search session or not. | ### Dynamic query results preview diff --git a/packages/x-components/static-docs/experience-search-and-discovery/README.md b/packages/x-components/static-docs/experience-search-and-discovery/README.md index cc59862cf0..ef42a8b81d 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/README.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/README.md @@ -3,7 +3,7 @@ title: Design your search and discovery UI meta_title: Search & discovery UI functional documentation sidebar_title: Design search & discovery UI redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/ + - /explore-empathy-platform/experience-search-and-discovery/ --- Search inevitably is key when people look for specific products in an online store. It's the door to @@ -16,7 +16,6 @@ shoppers need a new dimension to **connect effortlessly** to the most relevant p ![Design search and discovery](~@assets/x/interface/experience-search-intro.svg) - ## Interface X and Interface X for Apps, the solution Interface X and Interface X for Apps are a collection of libraries that lets you create a diff --git a/packages/x-components/static-docs/experience-search-and-discovery/empathize.md b/packages/x-components/static-docs/experience-search-and-discovery/empathize.md index ffdf17a035..b072b7e0e8 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/empathize.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/empathize.md @@ -1,18 +1,19 @@ --- title: Design the Empathize UI experience -sidebar_title: Empathize UI +sidebar_title: Empathize UI tags: - predictive layer - search box redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/empathize.html - - /explore-empathy-platform/experience-search-and-discovery/empathize + - /explore-empathy-platform/experience-search-and-discovery/empathize.html + - /explore-empathy-platform/experience-search-and-discovery/empathize --- Empathize is a UI container, but not just any container. It’s the -**[predictive layer](/understand-empathy-platform/search-basics/predictive-layer.md)** for your search -experience that is usually displayed below the search box. Consider it the natural companion of the -**[search box](/onboard-empathy-platform/experience-search-and-discovery/search-box.md)**, featuring search suggestions and recommendations. +**[predictive layer](/understand-empathy-platform/search-basics/predictive-layer.md)** for your +search experience that is usually displayed below the search box. Consider it the natural companion +of the **[search box](/onboard-empathy-platform/experience-search-and-discovery/search-box.md)**, +featuring search suggestions and recommendations. ![Empathize](~@assets/x/interface/x-empathize.gif) @@ -32,8 +33,9 @@ Thanks to the nature of Interface X Components, you can you use within Empathize. For example, provide shoppers with search ideas and use Empathize to display popular search terms and trending products. Anticipate your shoppers’ intent with recent searches and query suggestions. Or give shoppers access to their -[complete search history](/onboard-empathy-platform/experience-search-and-discovery/my-history.md) and let them control tracking search data. There are lots -of handy possibilities that you might want to place close to the search box. +[complete search history](/onboard-empathy-platform/experience-search-and-discovery/my-history.md) +and let them control tracking search data. There are lots of handy possibilities that you might want +to place close to the search box. **Combine Empathize with:** diff --git a/packages/x-components/static-docs/experience-search-and-discovery/facets-and-filters.md b/packages/x-components/static-docs/experience-search-and-discovery/facets-and-filters.md index dbafe95cd4..5b10edfab5 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/facets-and-filters.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/facets-and-filters.md @@ -4,8 +4,8 @@ sidebar_title: Facets & Filters UI tag: - faceted redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/facets-and-filters.html - - /explore-empathy-platform/experience-search-and-discovery/facets-and-filters + - /explore-empathy-platform/experience-search-and-discovery/facets-and-filters.html + - /explore-empathy-platform/experience-search-and-discovery/facets-and-filters --- Facets and Filters allow your shoppers to organize your product catalogue in different categories diff --git a/packages/x-components/static-docs/experience-search-and-discovery/history-queries.md b/packages/x-components/static-docs/experience-search-and-discovery/history-queries.md index dfbe3e7455..48e2f68763 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/history-queries.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/history-queries.md @@ -2,8 +2,8 @@ title: Design the History Queries UI experience sidebar_title: History Queries UI redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/history-queries.html - - /explore-empathy-platform/experience-search-and-discovery/history-queries + - /explore-empathy-platform/experience-search-and-discovery/history-queries.html + - /explore-empathy-platform/experience-search-and-discovery/history-queries --- The History Queries UI component displays the search history, allowing shoppers to check previous diff --git a/packages/x-components/static-docs/experience-search-and-discovery/id-results.md b/packages/x-components/static-docs/experience-search-and-discovery/id-results.md index 9fcf412dbb..41ff2414d5 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/id-results.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/id-results.md @@ -4,8 +4,8 @@ sidebar_title: ID Results UI tags: - identifier results redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/id-results.html - - /explore-empathy-platform/experience-search-and-discovery/id-results + - /explore-empathy-platform/experience-search-and-discovery/id-results.html + - /explore-empathy-platform/experience-search-and-discovery/id-results --- The Identifier Results UI component presents a type of search results intended for product reference diff --git a/packages/x-components/static-docs/experience-search-and-discovery/my-history.md b/packages/x-components/static-docs/experience-search-and-discovery/my-history.md index 6ac7f894e5..17bd29393f 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/my-history.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/my-history.md @@ -2,8 +2,8 @@ title: Design the My History UI experience sidebar_title: My History UI redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/my-history.html - - /explore-empathy-platform/experience-search-and-discovery/my-history + - /explore-empathy-platform/experience-search-and-discovery/my-history.html + - /explore-empathy-platform/experience-search-and-discovery/my-history --- The My History UI component displays the complete list of history queries, allowing shoppers to diff --git a/packages/x-components/static-docs/experience-search-and-discovery/next-queries.md b/packages/x-components/static-docs/experience-search-and-discovery/next-queries.md index 77826ab205..fc6a911e5e 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/next-queries.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/next-queries.md @@ -5,8 +5,8 @@ tags: - popular next queries - what's next redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/next-queries.html - - /explore-empathy-platform/experience-search-and-discovery/next-queries + - /explore-empathy-platform/experience-search-and-discovery/next-queries.html + - /explore-empathy-platform/experience-search-and-discovery/next-queries --- The Next Queries UI component provides shoppers with ideas on what to search for next based on their @@ -29,7 +29,8 @@ supports this feature. ::: interact -Can't quite capture the concept? Learn about [Next Queries](/understand-empathy-platform/search-features/next-queries-overview.md). +Can't quite capture the concept? Learn about +[Next Queries](/understand-empathy-platform/search-features/next-queries-overview.md). ::: @@ -65,7 +66,7 @@ next queries that shoppers haven't already used in the session. ::: warning To display only new next queries, the -[History Queries](/understand-empathy-platform/search-features/history-queries-overview.md) feature must be -implemented. +[History Queries](/understand-empathy-platform/search-features/history-queries-overview.md) feature +must be implemented. ::: diff --git a/packages/x-components/static-docs/experience-search-and-discovery/popular-searches.md b/packages/x-components/static-docs/experience-search-and-discovery/popular-searches.md index 9814ef71a8..d11e274615 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/popular-searches.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/popular-searches.md @@ -8,8 +8,8 @@ tags: - top queries - trending redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/popular-searches.html - - /explore-empathy-platform/experience-search-and-discovery/popular-searches + - /explore-empathy-platform/experience-search-and-discovery/popular-searches.html + - /explore-empathy-platform/experience-search-and-discovery/popular-searches --- The Popular Searches UI component displays what are the top search queries during a specific time. diff --git a/packages/x-components/static-docs/experience-search-and-discovery/product-results-ui.md b/packages/x-components/static-docs/experience-search-and-discovery/product-results-ui.md index 6fffe5957d..d11f201397 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/product-results-ui.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/product-results-ui.md @@ -4,8 +4,8 @@ sidebar_title: Product results UI tags: - results layout redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/product-results.html - - /explore-empathy-platform/experience-search-and-discovery/product-results + - /explore-empathy-platform/experience-search-and-discovery/product-results.html + - /explore-empathy-platform/experience-search-and-discovery/product-results --- After launching a search, some shoppers may just want to take a quick look around, reviewing only diff --git a/packages/x-components/static-docs/experience-search-and-discovery/query-suggestions.md b/packages/x-components/static-docs/experience-search-and-discovery/query-suggestions.md index 46054642e3..4c119cb0f9 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/query-suggestions.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/query-suggestions.md @@ -5,8 +5,8 @@ tags: - search suggestions - search as you type redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/query-suggestions.html - - /explore-empathy-platform/experience-search-and-discovery/query-suggestions + - /explore-empathy-platform/experience-search-and-discovery/query-suggestions.html + - /explore-empathy-platform/experience-search-and-discovery/query-suggestions --- The Query Suggestions UI component helps your shoppers with hints of what to look for to get diff --git a/packages/x-components/static-docs/experience-search-and-discovery/related-tags.md b/packages/x-components/static-docs/experience-search-and-discovery/related-tags.md index 7856ded705..508d5c4e4e 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/related-tags.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/related-tags.md @@ -5,8 +5,8 @@ tags: - tags - related keywords redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/related-tags.html - - /explore-empathy-platform/experience-search-and-discovery/related-tags + - /explore-empathy-platform/experience-search-and-discovery/related-tags.html + - /explore-empathy-platform/experience-search-and-discovery/related-tags --- The Related Tags UI component helps your shoppers to refine a specific search query and find what diff --git a/packages/x-components/static-docs/experience-search-and-discovery/search-box.md b/packages/x-components/static-docs/experience-search-and-discovery/search-box.md index bf6f8b93de..720f8d11c5 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/search-box.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/search-box.md @@ -19,7 +19,8 @@ button. ::: interact -Can't quite capture the concept? Learn more about [Search Box](/understand-empathy-platform/search-basics/search-box-overview.md). +Can't quite capture the concept? Learn more about +[Search Box](/understand-empathy-platform/search-basics/search-box-overview.md). ::: @@ -30,9 +31,10 @@ field to the selected suggestion and the search is launched. ::: warning -To modify the query syntax using [Query Suggestions](/understand-empathy-platform/search-features/query-suggestions-overview.md) or -[Next Queries](/understand-empathy-platform/search-features/next-queries-overview.md), make sure that your current search service -supports this type of feature. +To modify the query syntax using +[Query Suggestions](/understand-empathy-platform/search-features/query-suggestions-overview.md) or +[Next Queries](/understand-empathy-platform/search-features/next-queries-overview.md), make sure +that your current search service supports this type of feature. ::: diff --git a/packages/x-components/static-docs/experience-search-and-discovery/serp-ui.md b/packages/x-components/static-docs/experience-search-and-discovery/serp-ui.md index a33c038884..db8dc46773 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/serp-ui.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/serp-ui.md @@ -6,8 +6,8 @@ tags: - grid - results grid redirect_from: - - /explore-empathy-platform/experience-search-and-discovery/serp-ui.html - - /explore-empathy-platform/experience-search-and-discovery/serp-ui + - /explore-empathy-platform/experience-search-and-discovery/serp-ui.html + - /explore-empathy-platform/experience-search-and-discovery/serp-ui --- To handle and display search results, the layout of results and other related discovery features is @@ -39,14 +39,14 @@ However, the grid is not the only element to consider when designing the SERP: - Provide a **[sorting system](/explore-empathy-platform/overview/sorting-overview.md)** (D) so that your shoppers can arrange results according to different criteria such as relevance, price, alphabetical order… -- Include **[pagination](/understand-empathy-platform/search-basics/pagination-overview.md)** options to - browse results throughout the different result pages available or apply infinite scroll to ease - navigation. +- Include **[pagination](/understand-empathy-platform/search-basics/pagination-overview.md)** + options to browse results throughout the different result pages available or apply infinite scroll + to ease navigation. - Apply **infinite scroll** to ease navigation and add a **scroll-to-top button** (E) to quickly move to the top of the results page. - Indicate your shoppers whether the - **[Spell Check](/understand-empathy-platform/search-features/spellcheck-overview.md)** feature is applied or - not. + **[Spell Check](/understand-empathy-platform/search-features/spellcheck-overview.md)** feature is + applied or not. ::: note diff --git a/packages/x-components/static-docs/experience-search-and-discovery/web-local-storage.md b/packages/x-components/static-docs/experience-search-and-discovery/web-local-storage.md index 8107e512f5..177f9d34c1 100644 --- a/packages/x-components/static-docs/experience-search-and-discovery/web-local-storage.md +++ b/packages/x-components/static-docs/experience-search-and-discovery/web-local-storage.md @@ -9,21 +9,22 @@ tags: - history queries - cookieless redirect_from: -- /explore-empathy-platform/experience-search-and-discovery/web-local-storage.html -- /explore-empathy-platform/experience-search-and-discovery/web-local-storage -- /explore-empathy-platform/experience-search-and-discovery/web-local-storage.html + - /explore-empathy-platform/experience-search-and-discovery/web-local-storage.html + - /explore-empathy-platform/experience-search-and-discovery/web-local-storage + - /explore-empathy-platform/experience-search-and-discovery/web-local-storage.html --- Interface X for web **does not use cookies** for storing data. The -[Interface X Components](readme.md#interface-x-and-interface-x-for-apps-the-solution) use the web browser's local storage to save the technical data -required to provide the services associated with the search & discovery experience. The data remains -in the shopper's device until the expiration time is reached or the shopper chooses to delete it. +[Interface X Components](readme.md#interface-x-and-interface-x-for-apps-the-solution) use the web +browser's local storage to save the technical data required to provide the services associated with +the search & discovery experience. The data remains in the shopper's device until the expiration +time is reached or the shopper chooses to delete it. More specifically, Interface X Components store the following elements in the browser's local storage: -| Key | Duration | Purpose | -| ---------------------- | ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Key | Duration | Purpose | +| ---------------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `x-session-id` | 30 minutes | Short-term session ID to be sent to the Tagging API. It identifies short sessions in a device. It does not identify individual shoppers in any way. It's required for [Analytics](/explore-empathy-platform/understand-data-privacy/), [Next Queries](/explore-empathy-platform/features/history-queries-overview.html), and [Related Tags](/explore-empathy-platform/features/related-tags-overview.html) features | -| `x-session-time-stamp` | 30 minutes | Timestamp for the current session ID | -| `x-history-queries` | Stored until the shopper clears/disables the feature | List of the searches performed that the shopper has chosen to store, which are shown in different steps of the search journey. | +| `x-session-time-stamp` | 30 minutes | Timestamp for the current session ID | +| `x-history-queries` | Stored until the shopper clears/disables the feature | List of the searches performed that the shopper has chosen to store, which are shown in different steps of the search journey. |