diff --git a/CHANGELOG.md b/CHANGELOG.md index a22714fba..fe259f405 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - Default selection logic in `SKU Selector` component to prioritize available SKUs. +### Fixed + +- Updating the `shouldUpdateOrderForm` prop description. + ## [3.175.1] - 2024-09-11 ### Fixed diff --git a/docs/ShippingSimulator.md b/docs/ShippingSimulator.md index fe2d572b6..91e41b5cf 100644 --- a/docs/ShippingSimulator.md +++ b/docs/ShippingSimulator.md @@ -2,13 +2,13 @@ # Shipping Simulator -The `shipping-simulator` block estimates the shipping fee based on a zip code input. +The `shipping-simulator` block estimates the shipping cost based on a postal code input. ![shipping](https://user-images.githubusercontent.com/52087100/70262606-6ddb7c00-1773-11ea-91af-ededfd27aa95.png) ## Configuration -1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example: +1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file, as shown in the following example: ```json "dependencies": { @@ -31,7 +31,7 @@ The `shipping-simulator` block estimates the shipping fee based on a zip code in }, ``` -3. Then, declare the `shipping-simulator` block using the props stated in the [Props](#props) table. For example: +3. Declare the `shipping-simulator` block using the props stated in the [Props](#props) table. For example: ```json "shipping-simulator": { @@ -45,14 +45,14 @@ The `shipping-simulator` block estimates the shipping fee based on a zip code in | Prop name | Type | Description | Default value | | ----------------------- | --------- | --------------------------------------------------------------------------------------------- | ------------- | -| `pricingMode` | `enum` | If the product has gifts or attachments, for example, you can choose whether the shipping information will be grouped (`grouped`) by shipping type or showing the shipping prices for each of the items individually (`individualItems`). | `individualItems` | +| `pricingMode` | `enum` | Defines how shipping information is displayed when a product includes gifts or attachments. You can choose to group shipping information by type (`grouped`) or display shipping costs for each item individually (`individualItems`). | `individualItems` | | `seller` | `String` | ID of the product seller. | - | -| `shouldUpdateOrderForm` | `Boolean` | Whether interacting with the simulator should update the shopper's address in their `orderForm`. | `true` | +| `shouldUpdateOrderForm` | `Boolean` | Determines whether interacting with the shipping simulator should update the shopper's address in their `orderForm` (`true`). This only works if the [orderform optimization](https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization) is enabled; otherwise, it has no effect, even if set to `true`. | `true` | | `skuId` | `String` | ID of the current product SKU. | - | ## Customization -To apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide. +To apply CSS customizations to this and other blocks, see the guide[Using CSS handles for store customization](https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization). | CSS Handles | | ----------------------------------- |