Product provider work #1397
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --- | ||
| '@shopify/hydrogen': minor | ||
| --- | ||
|
|
||
| ## `<ProductProvider/>` and `<ProductOptionsProvider/>` | ||
|
|
||
| - `<ProductProvider/>` has been removed | ||
| - `<ProductPrice/>` was the only component left that used it; now it requires a `data` prop that takes in the product object | ||
| - `<ProductOptionsProvider/>` now maintains and provides the state that `useProductOptions` used to keep track of by itself. This change enables you to use multiple `useProductOptions` hook calls and have them share the same state (such as selected variant, options, etc.) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,300 @@ | ||
| --- | ||
| gid: 80d51c7e-fafe-11eb-9a03-0242ac130003 | ||
| title: ProductOptionsProvider | ||
| description: The ProductOptionsProvider component sets up a context with state that tracks the selected variant and options. | ||
| --- | ||
|
|
||
| The `ProductOptionsProvider` component sets up a context with state that tracks the selected variant and options. Descendents of this component can use the [`useProductOptions`](https://shopify.dev/api/hydrogen/hooks/product-variant/useproductoptions) hook. | ||
|
|
||
| ## Example code | ||
|
|
||
| ```tsx | ||
| import {ProductOptionsProvider, gql} from '@shopify/hydrogen'; | ||
|
|
||
| const QUERY = gql` | ||
| query product($handle: String!) { | ||
| product: product(handle: $handle) { | ||
| compareAtPriceRange { | ||
| maxVariantPrice { | ||
| currencyCode | ||
| amount | ||
| } | ||
| minVariantPrice { | ||
| currencyCode | ||
| amount | ||
| } | ||
| } | ||
| descriptionHtml | ||
| handle | ||
| id | ||
| media(first: $numProductMedia) { | ||
| nodes { | ||
| ... on MediaImage { | ||
| mediaContentType | ||
| image { | ||
| id | ||
| url | ||
| altText | ||
| width | ||
| height | ||
| } | ||
| } | ||
| ... on Video { | ||
| mediaContentType | ||
| id | ||
| previewImage { | ||
| url | ||
| } | ||
| sources { | ||
| mimeType | ||
| url | ||
| } | ||
| } | ||
| ... on ExternalVideo { | ||
| mediaContentType | ||
| id | ||
| embedUrl | ||
| host | ||
| } | ||
| ... on Model3d { | ||
| mediaContentType | ||
| id | ||
| alt | ||
| mediaContentType | ||
| previewImage { | ||
| url | ||
| } | ||
| sources { | ||
| url | ||
| } | ||
| } | ||
| } | ||
| } | ||
| metafields(first: $numProductMetafields) { | ||
|
There was a problem hiding this comment. Metafields as an array will need to be removed. Our API no longer supports this. There was a problem hiding this comment. Yup that work is coming up. This was just a copy/paste from previous file. |
||
| nodes { | ||
| id | ||
| type | ||
| namespace | ||
| key | ||
| value | ||
| createdAt | ||
| updatedAt | ||
| description | ||
| reference @include(if: $includeReferenceMetafieldDetails) { | ||
| __typename | ||
| ... on MediaImage { | ||
| id | ||
| mediaContentType | ||
| image { | ||
| id | ||
| url | ||
| altText | ||
| width | ||
| height | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| priceRange { | ||
| maxVariantPrice { | ||
| currencyCode | ||
| amount | ||
| } | ||
| minVariantPrice { | ||
| currencyCode | ||
| amount | ||
| } | ||
| } | ||
| title | ||
| variants(first: $numProductVariants) { | ||
| nodes { | ||
| id | ||
| title | ||
| availableForSale | ||
| image { | ||
| id | ||
| url | ||
| altText | ||
| width | ||
| height | ||
| } | ||
| unitPriceMeasurement { | ||
| measuredType | ||
| quantityUnit | ||
| quantityValue | ||
| referenceUnit | ||
| referenceValue | ||
| } | ||
| unitPrice { | ||
| currencyCode | ||
| amount | ||
| } | ||
| priceV2 { | ||
| currencyCode | ||
| amount | ||
| } | ||
| compareAtPriceV2 { | ||
| currencyCode | ||
| amount | ||
| } | ||
| selectedOptions { | ||
| name | ||
| value | ||
| } | ||
| metafields(first: $numProductVariantMetafields) { | ||
| nodes { | ||
| id | ||
| type | ||
| namespace | ||
| key | ||
| value | ||
| createdAt | ||
| updatedAt | ||
| description | ||
| reference @include(if: $includeReferenceMetafieldDetails) { | ||
| __typename | ||
| ... on MediaImage { | ||
| id | ||
| mediaContentType | ||
| image { | ||
| id | ||
| url | ||
| altText | ||
| width | ||
| height | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| sellingPlanAllocations( | ||
| first: $numProductVariantSellingPlanAllocations | ||
| ) { | ||
| nodes { | ||
| priceAdjustments { | ||
| compareAtPrice { | ||
| currencyCode | ||
| amount | ||
| } | ||
| perDeliveryPrice { | ||
| currencyCode | ||
| amount | ||
| } | ||
| price { | ||
| currencyCode | ||
| amount | ||
| } | ||
| unitPrice { | ||
| currencyCode | ||
| amount | ||
| } | ||
| } | ||
| sellingPlan { | ||
| id | ||
| description | ||
| name | ||
| options { | ||
| name | ||
| value | ||
| } | ||
| priceAdjustments { | ||
| orderCount | ||
| adjustmentValue { | ||
| ... on SellingPlanFixedAmountPriceAdjustment { | ||
| adjustmentAmount { | ||
| currencyCode | ||
| amount | ||
| } | ||
| } | ||
| ... on SellingPlanFixedPriceAdjustment { | ||
| price { | ||
| currencyCode | ||
| amount | ||
| } | ||
| } | ||
| ... on SellingPlanPercentagePriceAdjustment { | ||
| adjustmentPercentage | ||
| } | ||
| } | ||
| } | ||
| recurringDeliveries | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| sellingPlanGroups(first: $numProductSellingPlanGroups) { | ||
| nodes { | ||
| sellingPlans(first: $numProductSellingPlans) { | ||
| nodes { | ||
| id | ||
| description | ||
| name | ||
| options { | ||
| name | ||
| value | ||
| } | ||
| priceAdjustments { | ||
| orderCount | ||
| adjustmentValue { | ||
| ... on SellingPlanFixedAmountPriceAdjustment { | ||
| adjustmentAmount { | ||
| currencyCode | ||
| amount | ||
| } | ||
| } | ||
| ... on SellingPlanFixedPriceAdjustment { | ||
| price { | ||
| currencyCode | ||
| amount | ||
| } | ||
| } | ||
| ... on SellingPlanPercentagePriceAdjustment { | ||
| adjustmentPercentage | ||
| } | ||
| } | ||
| } | ||
| recurringDeliveries | ||
| } | ||
| } | ||
| appName | ||
| name | ||
| options { | ||
| name | ||
| values | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| `; | ||
|
|
||
| export function Product() { | ||
| const {data} = useShopQuery({query: QUERY}); | ||
|
|
||
| return ( | ||
| <ProductOptionsProvider data={data.product} initialVariantId="some-id">{/* Your JSX */}</ProductOptionsProvider> | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| ## Props | ||
|
|
||
| | Name | Type | Description | | ||
| | ----------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | children | <code>ReactNode</code> | A `ReactNode` element. | | ||
| | data | <code>PartialDeep<ProductType></code> | An object with fields that correspond to the Storefront API's [Product object](/api/storefront/reference/products/product). | | ||
| | initialVariantId? | <code>Parameters<typeof useProductOption>['0']['initialvariantid']</code> | The initially selected variant. <br></br>The following logic applies to `initialVariantId`:<ul><li>If `initialVariantId` is provided, then it's used, even if it's out of stock.</li><li>If `initialVariantId` is provided, but is `null`, then no variant is used.</li><li>If nothing is passed to `initialVariantId`, and you're in a `ProductOptionsProvider` component, then `selectedVariant.id` is used.</li><li>If nothing is passed to `initialVariantId` and you're not in a `ProductOptionsProvider` component, then the first available or in-stock variant is used.</li><li>If nothing is passed to `initialVariantId`, you're not in a `ProductOptionsProvider` component, and no variants are in stock, then the first variant is used.</li></ul> | | ||
|
|
||
| ## Component type | ||
|
|
||
| The `ProductOptionsProvider` component is a client component, which means that it renders on the client. For more information about component types, refer to [React Server Components](https://shopify.dev/custom-storefronts/hydrogen/framework/react-server-components). | ||
|
|
||
| ## Related components | ||
|
|
||
| - [`ProductPrice`](https://shopify.dev/api/hydrogen/components/product-variant/productprice) | ||
|
|
||
| ## Related hooks | ||
|
|
||
| - [`useProductOptions`](https://shopify.dev/api/hydrogen/hooks/product-variant/useproductoptions) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This query can be improved via …
Sadly the id can't actually be pulled up to the top.