Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

EDU-11146 - Update Shipping Simulator shouldUpdateOrderForm prop #1125

Merged
merged 3 commits into from
Nov 8, 2024
Merged

EDU-11146 - Update Shipping Simulator shouldUpdateOrderForm prop #1125

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4c1695
Update Shipping Simulator shouldUpdateOrderForm prop
barbara-celi Oct 28, 2024
c226011
Update CHANGELOG.md
barbara-celi Oct 28, 2024
69bede8
Merge branch 'master' into EDU-11146-Update-Shipping-Simulator
barbara-celi Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

### Fixed

- Updating the `shouldUpdateOrderForm` prop description.

## [3.175.1] - 2024-09-11

### Fixed
Expand Down
12 changes: 6 additions & 6 deletions docs/ShippingSimulator.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -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": {
Expand All @@ -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 |
| ----------------------------------- |
Expand Down
Loading