From c25da41d20a881f16f99c0ec4d4f95aa10d5eb0e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A1rbara=20Celi?= <112641072+barbara-celi@users.noreply.github.com> Date: Tue, 3 Dec 2024 17:12:25 -0300 Subject: [PATCH 1/2] Update Banner.md --- docs/Banner.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/Banner.md b/docs/Banner.md index aaa36e0..4dc6008 100644 --- a/docs/Banner.md +++ b/docs/Banner.md @@ -4,7 +4,7 @@ Banners is the Intelligent Search feature that displays banners on the search re ## Before you begin -Make sure you have added the `search` app to your theme dependencies in the `manifest.json` as shown below: +Make sure you have added the `search` app to your theme dependencies within the `manifest.json`, as shown below: ```json "dependencies": { @@ -16,15 +16,15 @@ Check the [Search](https://developers.vtex.com/docs/apps/vtex.search) app docume ## Configuration -The banner entity is composed by the following fields: +The banner entity is composed of the following fields: | Field | Description | | - | - | -| `Active` | Indicates if the banner is active or not. | -| `Banner name` | Field used as an ID. | -| `Type banner` | Indicates the banner type, which can be `HTML` or `IMAGE`. | +| `Active` | Indicates if the banner is active or not. |se +| `Banner name` | Unique identifier for the banner. | +| `Type banner` | Specifies the type of banner, which can be either `HTML` or `IMAGE`. | | `HTML` / `Image URL` | HTML code or image to be inserted. | -| `Area` | Indicates in which area the banner should appear. It is important when there are multiple banners in the same page. | +| `Area` | Indicates the section of the page where the banner will be displayed. It's important when multiple banners are present on the same page. | | `Terms` | List of terms for this banner. | | `Period` | The period that this banner will be active. | | `Attributes` | List of selected attributes for this banner. | @@ -59,11 +59,12 @@ Add the `search-banner` block to the `search-result-layout.desktop` or `search-r | Prop name | Type | Description | Default value | | - | - | - | - | -| `area` | `String` | Idicates the area. It needs to match the area configured in the banner. | - | +| `area` | `String` | Indicates the area. It needs to match the area configured in the banner. | - | | `blockClass` | `String` | Defines a custom class for the banner div. | - | | `horizontalAlignment` | `String` | Defines the horizontal alignment for the banner. | `"center"` | The possible values for `horizontalAlignment` are: + | Values | | --------- | | `"left"` | @@ -72,7 +73,7 @@ The possible values for `horizontalAlignment` are: ## Customization -In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization). +To apply CSS customizations in this and other blocks, follow the instructions in the recipe on [Using CSS Handles for store customization](https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization). | CSS Handles | | -------------- | From d110c9fb5ee6be05f0fb80c18f9c95a811c909f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=C3=A1rbara=20Celi?= <112641072+barbara-celi@users.noreply.github.com> Date: Wed, 22 Jan 2025 10:25:49 -0300 Subject: [PATCH 2/2] Applying LOC review --- docs/Banner.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/Banner.md b/docs/Banner.md index 4dc6008..7a8bcd5 100644 --- a/docs/Banner.md +++ b/docs/Banner.md @@ -1,6 +1,6 @@ # Banner -Banners is the Intelligent Search feature that displays banners on the search results page of the customer, depending on the context of the search. +Banner is the Intelligent Search feature that displays banners on the customer search results page, depending on the search context. ## Before you begin @@ -20,7 +20,7 @@ The banner entity is composed of the following fields: | Field | Description | | - | - | -| `Active` | Indicates if the banner is active or not. |se +| `Active` | Indicates if the banner is active or not. | | `Banner name` | Unique identifier for the banner. | | `Type banner` | Specifies the type of banner, which can be either `HTML` or `IMAGE`. | | `HTML` / `Image URL` | HTML code or image to be inserted. | @@ -31,7 +31,7 @@ The banner entity is composed of the following fields: ## Usage -Add the `search-banner` block to the `search-result-layout.desktop` or `search-result-layout.mobile`. For example: +Add the `search-banner` block to `search-result-layout.desktop` or `search-result-layout.mobile`. For example: ```json { @@ -59,8 +59,8 @@ Add the `search-banner` block to the `search-result-layout.desktop` or `search-r | Prop name | Type | Description | Default value | | - | - | - | - | -| `area` | `String` | Indicates the area. It needs to match the area configured in the banner. | - | -| `blockClass` | `String` | Defines a custom class for the banner div. | - | +| `area` | `String` | Indicates the area. It must match the area configured in the banner. | - | +| `blockClass` | `String` | Defines a custom class to the banner div. | - | | `horizontalAlignment` | `String` | Defines the horizontal alignment for the banner. | `"center"` | The possible values for `horizontalAlignment` are: @@ -73,7 +73,7 @@ The possible values for `horizontalAlignment` are: ## Customization -To apply CSS customizations in this and other blocks, follow the instructions in the recipe on [Using CSS Handles for store customization](https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization). +To apply CSS customizations to this and other blocks, follow the instructions in the guide [Using CSS Handles for store customization](https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization). | CSS Handles | | -------------- |