From 74a7cfbd67e412ec05f325802a6d4a350043ec1b Mon Sep 17 00:00:00 2001 From: Michelle Vinci Date: Tue, 9 Nov 2021 18:20:09 -0800 Subject: [PATCH] feat: regen docs --- packages/cli/README.md | 2 +- .../src/components/AddToCartButton/README.md | 2 +- .../src/components/BuyNowButton/README.md | 2 +- .../components/CartCheckoutButton/README.md | 6 +--- .../components/CartEstimatedCost/README.md | 2 +- .../components/CartLineAttributes/README.md | 2 +- .../src/components/CartLineImage/README.md | 2 +- .../src/components/CartLinePrice/README.md | 2 +- .../components/CartLineProductTitle/README.md | 2 +- .../src/components/CartLineProvider/README.md | 2 +- .../src/components/CartLineQuantity/README.md | 2 +- .../CartLineQuantityAdjustButton/README.md | 2 +- .../CartLineSelectedOptions/README.md | 2 +- .../src/components/CartLines/README.md | 2 +- .../src/components/CartProvider/README.md | 2 +- .../components/CartShopPayButton/README.md | 2 +- .../src/components/ExternalVideo/README.md | 2 +- .../hydrogen/src/components/Image/README.md | 2 +- .../components/LocalizationProvider/README.md | 6 +--- .../src/components/MediaFile/README.md | 2 +- .../src/components/Metafield/README.md | 2 +- .../hydrogen/src/components/Model3D/README.md | 2 +- .../hydrogen/src/components/Money/README.md | 2 +- .../components/ProductDescription/README.md | 2 +- .../src/components/ProductMetafield/README.md | 2 +- .../src/components/ProductPrice/README.md | 2 +- .../src/components/ProductProvider/README.md | 2 +- .../src/components/ProductTitle/README.md | 2 +- .../hydrogen/src/components/RawHtml/README.md | 2 +- .../SelectedVariantAddToCartButton/README.md | 2 +- .../SelectedVariantBuyNowButton/README.md | 2 +- .../components/SelectedVariantImage/README.md | 2 +- .../SelectedVariantMetafield/README.md | 2 +- .../components/SelectedVariantPrice/README.md | 2 +- .../SelectedVariantShopPayButton/README.md | 2 +- .../SelectedVariantUnitPrice/README.md | 2 +- .../src/components/ShopPayButton/README.md | 2 +- .../src/components/UnitPrice/README.md | 2 +- .../hydrogen/src/components/Video/README.md | 2 +- .../src/foundation/ShopifyProvider/README.md | 6 +--- .../src/foundation/useServerState/README.md | 2 +- .../hydrogen/src/foundation/useShop/README.md | 2 +- .../src/hooks/useAvailableCountries/README.md | 2 +- packages/hydrogen/src/hooks/useCart/README.md | 2 +- .../useCartAttributesUpdateCallback/README.md | 2 +- .../README.md | 2 +- .../src/hooks/useCartCheckoutUrl/README.md | 2 +- .../src/hooks/useCartCreateCallback/README.md | 2 +- .../README.md | 2 +- .../hydrogen/src/hooks/useCartLine/README.md | 2 +- .../hooks/useCartLinesAddCallback/README.md | 2 +- .../useCartLinesRemoveCallback/README.md | 2 +- .../hooks/useCartLinesTotalQuantity/README.md | 2 +- .../useCartLinesUpdateCallback/README.md | 2 +- .../hooks/useCartNoteUpdateCallback/README.md | 2 +- .../hydrogen/src/hooks/useCountry/README.md | 2 +- .../hydrogen/src/hooks/useMoney/README.md | 2 +- .../src/hooks/useParsedMetafields/README.md | 2 +- .../hydrogen/src/hooks/useProduct/README.md | 2 +- .../src/hooks/useProductOptions/README.md | 4 +-- .../hydrogen/src/hooks/useQuery/README.md | 2 +- .../src/hooks/useServerState/README.md | 30 ---------------- packages/hydrogen/src/hooks/useShop/README.md | 35 ------------------- .../hydrogen/src/hooks/useShopQuery/README.md | 4 +-- .../src/utilities/flattenConnection/README.md | 2 +- .../hydrogen/src/utilities/isClient/README.md | 2 +- .../hydrogen/src/utilities/isServer/README.md | 2 +- .../utilities/parseMetafieldValue/README.md | 4 +-- 68 files changed, 69 insertions(+), 146 deletions(-) delete mode 100644 packages/hydrogen/src/hooks/useServerState/README.md delete mode 100644 packages/hydrogen/src/hooks/useShop/README.md diff --git a/packages/cli/README.md b/packages/cli/README.md index 4f4e8cd..809dd59 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -1,4 +1,4 @@ - + ## `@shopify/hydrogen-cli` diff --git a/packages/hydrogen/src/components/AddToCartButton/README.md b/packages/hydrogen/src/components/AddToCartButton/README.md index ebebc0c..9327d5c 100644 --- a/packages/hydrogen/src/components/AddToCartButton/README.md +++ b/packages/hydrogen/src/components/AddToCartButton/README.md @@ -1,4 +1,4 @@ - + The `AddToCartButton` component renders a button that adds an item to the cart when pressed. It must be a descendent of the `CartProvider` component. diff --git a/packages/hydrogen/src/components/BuyNowButton/README.md b/packages/hydrogen/src/components/BuyNowButton/README.md index 1d94bd1..ddd6cae 100644 --- a/packages/hydrogen/src/components/BuyNowButton/README.md +++ b/packages/hydrogen/src/components/BuyNowButton/README.md @@ -1,4 +1,4 @@ - + The `BuyNowButton` component renders a button that adds an item to the cart and redirects the customer to checkout. diff --git a/packages/hydrogen/src/components/CartCheckoutButton/README.md b/packages/hydrogen/src/components/CartCheckoutButton/README.md index b87f75b..9c540da 100644 --- a/packages/hydrogen/src/components/CartCheckoutButton/README.md +++ b/packages/hydrogen/src/components/CartCheckoutButton/README.md @@ -1,8 +1,4 @@ ---- -gid: c7df6e06-3c6c-4c35-b6fe-82bfac8b6b95 -title: CartCheckoutButton -description: Use the CartCheckoutButton to render a button that redirects to checkoutUrl for the cart. ---- + The `CartCheckoutButton` component renders a button that redirects to the checkout URL for the cart. diff --git a/packages/hydrogen/src/components/CartEstimatedCost/README.md b/packages/hydrogen/src/components/CartEstimatedCost/README.md index 644c337..2dc24d4 100644 --- a/packages/hydrogen/src/components/CartEstimatedCost/README.md +++ b/packages/hydrogen/src/components/CartEstimatedCost/README.md @@ -1,4 +1,4 @@ - + The [CartEstimatedCost](/api/storefront/reference/cart/cartestimatedcost) component renders a `Money` component with the cost associated with the `amountType` prop. If no `amountType` prop is specified, then it defaults to `totalAmount`. diff --git a/packages/hydrogen/src/components/CartLineAttributes/README.md b/packages/hydrogen/src/components/CartLineAttributes/README.md index db5b77c..6108d6c 100644 --- a/packages/hydrogen/src/components/CartLineAttributes/README.md +++ b/packages/hydrogen/src/components/CartLineAttributes/README.md @@ -1,4 +1,4 @@ - + The `CartLineAttributes` component takes a function as a child and calls that function for each of the cart line's attributes. It must be a descendent of a `CartLineProvider` component. diff --git a/packages/hydrogen/src/components/CartLineImage/README.md b/packages/hydrogen/src/components/CartLineImage/README.md index d51a171..31a227a 100644 --- a/packages/hydrogen/src/components/CartLineImage/README.md +++ b/packages/hydrogen/src/components/CartLineImage/README.md @@ -1,4 +1,4 @@ - + The `CartLineImage` component renders an `Image` component for the cart line merchandise's image. It must be a descendent of a `CartLineProvider` component. diff --git a/packages/hydrogen/src/components/CartLinePrice/README.md b/packages/hydrogen/src/components/CartLinePrice/README.md index 3d4a18f..2b8a3ea 100644 --- a/packages/hydrogen/src/components/CartLinePrice/README.md +++ b/packages/hydrogen/src/components/CartLinePrice/README.md @@ -1,4 +1,4 @@ - + The `CartLinePrice` component renders a `Money` component for the cart line merchandise's price or compare at price. It must be a descendent of a `CartLineProvider` component. diff --git a/packages/hydrogen/src/components/CartLineProductTitle/README.md b/packages/hydrogen/src/components/CartLineProductTitle/README.md index 1bc4e40..04d0048 100644 --- a/packages/hydrogen/src/components/CartLineProductTitle/README.md +++ b/packages/hydrogen/src/components/CartLineProductTitle/README.md @@ -1,4 +1,4 @@ - + The `CartLineProductTitle` component renders a `span` element (or the type of HTML element specified by the `as` prop) with the cart line merchandise's title. It must be a descendent of a `CartLineProvider` component. diff --git a/packages/hydrogen/src/components/CartLineProvider/README.md b/packages/hydrogen/src/components/CartLineProvider/README.md index 1f26276..218518f 100644 --- a/packages/hydrogen/src/components/CartLineProvider/README.md +++ b/packages/hydrogen/src/components/CartLineProvider/README.md @@ -1,4 +1,4 @@ - + The `useCartLine` hook provides access to the cart line object. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/components/CartLineQuantity/README.md b/packages/hydrogen/src/components/CartLineQuantity/README.md index a40e1a9..eb9bbf8 100644 --- a/packages/hydrogen/src/components/CartLineQuantity/README.md +++ b/packages/hydrogen/src/components/CartLineQuantity/README.md @@ -1,4 +1,4 @@ - + The `CartLineQuantity` component renders a `span` element (or the type of HTML element specified by the `as` prop) with the cart line's quantity. It must be a descendent of a `CartLineProvider` component. diff --git a/packages/hydrogen/src/components/CartLineQuantityAdjustButton/README.md b/packages/hydrogen/src/components/CartLineQuantityAdjustButton/README.md index a436120..d57c042 100644 --- a/packages/hydrogen/src/components/CartLineQuantityAdjustButton/README.md +++ b/packages/hydrogen/src/components/CartLineQuantityAdjustButton/README.md @@ -1,4 +1,4 @@ - + The `CartLineQuantityAdjustButton` component renders a button that adjusts the cart line's quantity when pressed. It must be a descendent of a `CartLineProvider` component. diff --git a/packages/hydrogen/src/components/CartLineSelectedOptions/README.md b/packages/hydrogen/src/components/CartLineSelectedOptions/README.md index 9dd2f15..438c472 100644 --- a/packages/hydrogen/src/components/CartLineSelectedOptions/README.md +++ b/packages/hydrogen/src/components/CartLineSelectedOptions/README.md @@ -1,4 +1,4 @@ - + The `CartLineSelectedOptions` component takes a function as a child and calls that function for each of the cart line merchandise's selected options. It must be a descendent of a `CartLineProvider` component. diff --git a/packages/hydrogen/src/components/CartLines/README.md b/packages/hydrogen/src/components/CartLines/README.md index 3ef8e2b..38b3232 100644 --- a/packages/hydrogen/src/components/CartLines/README.md +++ b/packages/hydrogen/src/components/CartLines/README.md @@ -1,4 +1,4 @@ - + The `CartLines` component iterates over each cart line and renders its `children` within a `CartLineProvider` for each cart line. It also provides render props in the case where `children` is a function. diff --git a/packages/hydrogen/src/components/CartProvider/README.md b/packages/hydrogen/src/components/CartProvider/README.md index 4be6036..5c4eda2 100644 --- a/packages/hydrogen/src/components/CartProvider/README.md +++ b/packages/hydrogen/src/components/CartProvider/README.md @@ -1,4 +1,4 @@ - + ## Example code diff --git a/packages/hydrogen/src/components/CartShopPayButton/README.md b/packages/hydrogen/src/components/CartShopPayButton/README.md index 2219486..0a35f0c 100644 --- a/packages/hydrogen/src/components/CartShopPayButton/README.md +++ b/packages/hydrogen/src/components/CartShopPayButton/README.md @@ -1,4 +1,4 @@ - + The `CartShopPayButton` component renders a `ShopPayButton` for the items in the cart. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/components/ExternalVideo/README.md b/packages/hydrogen/src/components/ExternalVideo/README.md index 43d8387..ec8047e 100644 --- a/packages/hydrogen/src/components/ExternalVideo/README.md +++ b/packages/hydrogen/src/components/ExternalVideo/README.md @@ -1,4 +1,4 @@ - + The `ExternalVideo` component renders an embedded video for the Storefront API's [`ExternalVideo` object](/api/storefront/reference/products/externalvideo). diff --git a/packages/hydrogen/src/components/Image/README.md b/packages/hydrogen/src/components/Image/README.md index 62efa3a..28cf087 100644 --- a/packages/hydrogen/src/components/Image/README.md +++ b/packages/hydrogen/src/components/Image/README.md @@ -1,4 +1,4 @@ - + The `Image` component renders an image for the Storefront API's [`Image` object](/api/storefront/reference/common-objects/image). diff --git a/packages/hydrogen/src/components/LocalizationProvider/README.md b/packages/hydrogen/src/components/LocalizationProvider/README.md index f40885c..fca548b 100644 --- a/packages/hydrogen/src/components/LocalizationProvider/README.md +++ b/packages/hydrogen/src/components/LocalizationProvider/README.md @@ -1,8 +1,4 @@ ---- -gid: 2d9f4930-fafe-11eb-9a03-0242ac130003 -title: LocalizationProvider -description: Use a LocalizationProvider component to automatically query the Storefront API's localization field for the ISO code, name of the country, and available countries, and keep this information in a context. ---- + The `LocalizationProvider` component automatically queries the Storefront API's [`localization`](/api/storefront/reference/common-objects/queryroot) field for the `isoCode` and `name` of the `country` and `availableCountries` and keeps this information in a context. diff --git a/packages/hydrogen/src/components/MediaFile/README.md b/packages/hydrogen/src/components/MediaFile/README.md index d4178e8..b25b65a 100644 --- a/packages/hydrogen/src/components/MediaFile/README.md +++ b/packages/hydrogen/src/components/MediaFile/README.md @@ -1,4 +1,4 @@ - + The `MediaFile` component renders the media for the Storefront API's [Media object](/api/storefront/reference/products/media). It renders an `Image`, a diff --git a/packages/hydrogen/src/components/Metafield/README.md b/packages/hydrogen/src/components/Metafield/README.md index 530b621..0d80b3a 100644 --- a/packages/hydrogen/src/components/Metafield/README.md +++ b/packages/hydrogen/src/components/Metafield/README.md @@ -1,4 +1,4 @@ - + The `Metafield` component renders the value of a Storefront API's [Metafield object](/api/storefront/reference/common-objects/metafield). diff --git a/packages/hydrogen/src/components/Model3D/README.md b/packages/hydrogen/src/components/Model3D/README.md index e1dd305..6e79a9b 100644 --- a/packages/hydrogen/src/components/Model3D/README.md +++ b/packages/hydrogen/src/components/Model3D/README.md @@ -1,4 +1,4 @@ - + The `Model3D` component renders a 3D model (with the `model-viewer` tag) for the Storefront API's [`Model3d` object](/api/storefront/reference/products/model3d). diff --git a/packages/hydrogen/src/components/Money/README.md b/packages/hydrogen/src/components/Money/README.md index 38a26f2..8f57ad7 100644 --- a/packages/hydrogen/src/components/Money/README.md +++ b/packages/hydrogen/src/components/Money/README.md @@ -1,4 +1,4 @@ - + The `Money` component renders a string of the Storefront API's [`MoneyV2` object](/api/storefront/reference/common-objects/moneyv2) according to the diff --git a/packages/hydrogen/src/components/ProductDescription/README.md b/packages/hydrogen/src/components/ProductDescription/README.md index 3e70ab9..2905efc 100644 --- a/packages/hydrogen/src/components/ProductDescription/README.md +++ b/packages/hydrogen/src/components/ProductDescription/README.md @@ -1,4 +1,4 @@ - + The `ProductDescription` component renders a `RawHtml` component with the product's [`descriptionHtml`](/api/storefront/reference/products/product). diff --git a/packages/hydrogen/src/components/ProductMetafield/README.md b/packages/hydrogen/src/components/ProductMetafield/README.md index a5f0f08..57971d8 100644 --- a/packages/hydrogen/src/components/ProductMetafield/README.md +++ b/packages/hydrogen/src/components/ProductMetafield/README.md @@ -1,4 +1,4 @@ - + The `ProductMetafield` component renders a [`Metafield`](/api/hydrogen/components/primitive/metafield) component with the product metafield. diff --git a/packages/hydrogen/src/components/ProductPrice/README.md b/packages/hydrogen/src/components/ProductPrice/README.md index 922d2ce..556b2ce 100644 --- a/packages/hydrogen/src/components/ProductPrice/README.md +++ b/packages/hydrogen/src/components/ProductPrice/README.md @@ -1,4 +1,4 @@ - + The `ProductPrice` component renders a `Money` component with the product [`priceRange`](/api/storefront/reference/products/productpricerange)'s `maxVariantPrice` diff --git a/packages/hydrogen/src/components/ProductProvider/README.md b/packages/hydrogen/src/components/ProductProvider/README.md index 3455caa..bfe4263 100644 --- a/packages/hydrogen/src/components/ProductProvider/README.md +++ b/packages/hydrogen/src/components/ProductProvider/README.md @@ -1,4 +1,4 @@ - + The `useProduct` hook returns the product object of the nearest `ProductProvider`. It must be a descendent of a `ProductProvider` component. diff --git a/packages/hydrogen/src/components/ProductTitle/README.md b/packages/hydrogen/src/components/ProductTitle/README.md index fbc4c2f..42028a8 100644 --- a/packages/hydrogen/src/components/ProductTitle/README.md +++ b/packages/hydrogen/src/components/ProductTitle/README.md @@ -1,4 +1,4 @@ - + The `ProductTitle` component renders a `span` element (or the type of HTML element specified by the `as` prop) with the product's [`title`](/api/storefront/reference/products/product). diff --git a/packages/hydrogen/src/components/RawHtml/README.md b/packages/hydrogen/src/components/RawHtml/README.md index 84d69b8..79b0a48 100644 --- a/packages/hydrogen/src/components/RawHtml/README.md +++ b/packages/hydrogen/src/components/RawHtml/README.md @@ -1,4 +1,4 @@ - + The `RawHtml` component renders an HTML string as HTML DOM elements. This should be used for displaying rich text-like descriptions associated with a product. diff --git a/packages/hydrogen/src/components/SelectedVariantAddToCartButton/README.md b/packages/hydrogen/src/components/SelectedVariantAddToCartButton/README.md index cbb042a..98df8b8 100644 --- a/packages/hydrogen/src/components/SelectedVariantAddToCartButton/README.md +++ b/packages/hydrogen/src/components/SelectedVariantAddToCartButton/README.md @@ -1,4 +1,4 @@ - + The `SelectedVariantAddToCartButton` component renders a `AddToCartButton` for the product's selected variant. Clicking this button automatically adds the selected variant to the cart. diff --git a/packages/hydrogen/src/components/SelectedVariantBuyNowButton/README.md b/packages/hydrogen/src/components/SelectedVariantBuyNowButton/README.md index ffcb1a6..99bc2ad 100644 --- a/packages/hydrogen/src/components/SelectedVariantBuyNowButton/README.md +++ b/packages/hydrogen/src/components/SelectedVariantBuyNowButton/README.md @@ -1,4 +1,4 @@ - + The `SelectedVariantBuyNowButton` component renders a `BuyNowButton` for the product's selected variant. Clicking this button automatically adds the selected variant to the cart and redirect the customer to checkout. diff --git a/packages/hydrogen/src/components/SelectedVariantImage/README.md b/packages/hydrogen/src/components/SelectedVariantImage/README.md index fdf73b3..4127acd 100644 --- a/packages/hydrogen/src/components/SelectedVariantImage/README.md +++ b/packages/hydrogen/src/components/SelectedVariantImage/README.md @@ -1,4 +1,4 @@ - + The `SelectedVariantImage` component renders an `Image` component for the product's selected variant's image. It must be a descendent of a `ProductProvider` component. diff --git a/packages/hydrogen/src/components/SelectedVariantMetafield/README.md b/packages/hydrogen/src/components/SelectedVariantMetafield/README.md index bf6ef5b..895fdf1 100644 --- a/packages/hydrogen/src/components/SelectedVariantMetafield/README.md +++ b/packages/hydrogen/src/components/SelectedVariantMetafield/README.md @@ -1,4 +1,4 @@ - + The `SelectedVariantMetafield` component renders a [`Metafield`](/api/hydrogen/components/primitive/metafield) component with the selected product's metafield. diff --git a/packages/hydrogen/src/components/SelectedVariantPrice/README.md b/packages/hydrogen/src/components/SelectedVariantPrice/README.md index 47bf978..0118d89 100644 --- a/packages/hydrogen/src/components/SelectedVariantPrice/README.md +++ b/packages/hydrogen/src/components/SelectedVariantPrice/README.md @@ -1,4 +1,4 @@ - + The `SelectedVariantPrice` component renders a `Money` component for the product's selected variant's price or compare at price. It must be a descendent of a `ProductProvider` component. diff --git a/packages/hydrogen/src/components/SelectedVariantShopPayButton/README.md b/packages/hydrogen/src/components/SelectedVariantShopPayButton/README.md index 505aca8..68cfcc4 100644 --- a/packages/hydrogen/src/components/SelectedVariantShopPayButton/README.md +++ b/packages/hydrogen/src/components/SelectedVariantShopPayButton/README.md @@ -1,4 +1,4 @@ - + The `SelectedVariantShopPayButton` component renders a `ShopPayButton` for the product's selected variant. It must be a descendent of a `ProductProvider` component. diff --git a/packages/hydrogen/src/components/SelectedVariantUnitPrice/README.md b/packages/hydrogen/src/components/SelectedVariantUnitPrice/README.md index a874d4c..d3f6314 100644 --- a/packages/hydrogen/src/components/SelectedVariantUnitPrice/README.md +++ b/packages/hydrogen/src/components/SelectedVariantUnitPrice/README.md @@ -1,4 +1,4 @@ - + The `SelectedVariantUnitPrice` component renders a `UnitPrice` component for the product's selected variant's unit price. It must be a descendent of a `ProductProvider`. diff --git a/packages/hydrogen/src/components/ShopPayButton/README.md b/packages/hydrogen/src/components/ShopPayButton/README.md index 9d24afc..bd000b5 100644 --- a/packages/hydrogen/src/components/ShopPayButton/README.md +++ b/packages/hydrogen/src/components/ShopPayButton/README.md @@ -1,4 +1,4 @@ - + The `ShopPayButton` component renders a button that redirects to the Shop Pay checkout. diff --git a/packages/hydrogen/src/components/UnitPrice/README.md b/packages/hydrogen/src/components/UnitPrice/README.md index c0aaabe..6ffbafd 100644 --- a/packages/hydrogen/src/components/UnitPrice/README.md +++ b/packages/hydrogen/src/components/UnitPrice/README.md @@ -1,4 +1,4 @@ - + The `UnitPrice` component renders a string with a [UnitPrice](/themes/pricing-payments/unit-pricing) as the [Storefront API's `MoneyV2` object](/api/storefront/reference/common-objects/moneyv2) with a reference unit from diff --git a/packages/hydrogen/src/components/Video/README.md b/packages/hydrogen/src/components/Video/README.md index f2ab02a..691eff9 100644 --- a/packages/hydrogen/src/components/Video/README.md +++ b/packages/hydrogen/src/components/Video/README.md @@ -1,4 +1,4 @@ - + The `Video` component renders a `video` for the Storefront API's [`Video` object](/api/storefront/reference/products/video). diff --git a/packages/hydrogen/src/foundation/ShopifyProvider/README.md b/packages/hydrogen/src/foundation/ShopifyProvider/README.md index 4887ec4..cea1fcf 100644 --- a/packages/hydrogen/src/foundation/ShopifyProvider/README.md +++ b/packages/hydrogen/src/foundation/ShopifyProvider/README.md @@ -1,8 +1,4 @@ ---- -gid: b4dc58a2-fafe-11eb-9a03-0242ac130003 -title: ShopifyProvider -description: Use the ShopifyProvider component to wrap your entire app and provide support for hooks. ---- + The `ShopifyProvider` component wraps your entire app and provides support for hooks. You should place it in your app's entry point component. For example, ``. diff --git a/packages/hydrogen/src/foundation/useServerState/README.md b/packages/hydrogen/src/foundation/useServerState/README.md index 6b6a281..260c356 100644 --- a/packages/hydrogen/src/foundation/useServerState/README.md +++ b/packages/hydrogen/src/foundation/useServerState/README.md @@ -1,4 +1,4 @@ - + The `useServerState` hook allows you to [manage server state](/api/hydrogen/framework/server-state) when using Hydrogen as a React Server Component framework. diff --git a/packages/hydrogen/src/foundation/useShop/README.md b/packages/hydrogen/src/foundation/useShop/README.md index 64fcaa0..819922f 100644 --- a/packages/hydrogen/src/foundation/useShop/README.md +++ b/packages/hydrogen/src/foundation/useShop/README.md @@ -1,4 +1,4 @@ - + The `useShop` hook provides access to values within `shopify.config.js`.The `useShop` hook provides access to values within `shopify.config.js`. It must be a descendent of a `ShopifyProvider` component. diff --git a/packages/hydrogen/src/hooks/useAvailableCountries/README.md b/packages/hydrogen/src/hooks/useAvailableCountries/README.md index 091fd51..b73185d 100644 --- a/packages/hydrogen/src/hooks/useAvailableCountries/README.md +++ b/packages/hydrogen/src/hooks/useAvailableCountries/README.md @@ -1,4 +1,4 @@ - + The `useAvailableCountries` hook returns an array of available countries used for localization. It must be a descendent of a `LocalizationProvider` component. diff --git a/packages/hydrogen/src/hooks/useCart/README.md b/packages/hydrogen/src/hooks/useCart/README.md index f3e709a..738bbb1 100644 --- a/packages/hydrogen/src/hooks/useCart/README.md +++ b/packages/hydrogen/src/hooks/useCart/README.md @@ -1,4 +1,4 @@ - + The `useCart` hook provides access to the cart object. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCartAttributesUpdateCallback/README.md b/packages/hydrogen/src/hooks/useCartAttributesUpdateCallback/README.md index 6a32081..28190a9 100644 --- a/packages/hydrogen/src/hooks/useCartAttributesUpdateCallback/README.md +++ b/packages/hydrogen/src/hooks/useCartAttributesUpdateCallback/README.md @@ -1,4 +1,4 @@ - + The `useCartAttributesUpdateCallback` hook returns a callback that can be used to update the cart's attributes. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCartBuyerIdentityUpdateCallback/README.md b/packages/hydrogen/src/hooks/useCartBuyerIdentityUpdateCallback/README.md index 1da8022..33f77f7 100644 --- a/packages/hydrogen/src/hooks/useCartBuyerIdentityUpdateCallback/README.md +++ b/packages/hydrogen/src/hooks/useCartBuyerIdentityUpdateCallback/README.md @@ -1,4 +1,4 @@ - + The `useCartBuyerIdentityUpdateCallback` hook returns a callback that can be used to update the cart's buyer identity. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCartCheckoutUrl/README.md b/packages/hydrogen/src/hooks/useCartCheckoutUrl/README.md index c977bf9..91d02aa 100644 --- a/packages/hydrogen/src/hooks/useCartCheckoutUrl/README.md +++ b/packages/hydrogen/src/hooks/useCartCheckoutUrl/README.md @@ -1,4 +1,4 @@ - + The `useCartCheckoutUrl` hook returns a string of the checkout URL for the cart. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCartCreateCallback/README.md b/packages/hydrogen/src/hooks/useCartCreateCallback/README.md index 86973cc..64ab652 100644 --- a/packages/hydrogen/src/hooks/useCartCreateCallback/README.md +++ b/packages/hydrogen/src/hooks/useCartCreateCallback/README.md @@ -1,4 +1,4 @@ - + The `useCartCreateCallback` hook returns a callback that can be used to create a cart. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCartDiscountCodesUpdateCallback/README.md b/packages/hydrogen/src/hooks/useCartDiscountCodesUpdateCallback/README.md index 14617f2..0c87452 100644 --- a/packages/hydrogen/src/hooks/useCartDiscountCodesUpdateCallback/README.md +++ b/packages/hydrogen/src/hooks/useCartDiscountCodesUpdateCallback/README.md @@ -1,4 +1,4 @@ - + The `useCartDiscountCodesUpdateCallback` hook returns a callback that can be used to update the cart's discount codes. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCartLine/README.md b/packages/hydrogen/src/hooks/useCartLine/README.md index 06f6bac..6c1d738 100644 --- a/packages/hydrogen/src/hooks/useCartLine/README.md +++ b/packages/hydrogen/src/hooks/useCartLine/README.md @@ -1,4 +1,4 @@ - + The `useCartLine` hook provides access to the cart line object. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCartLinesAddCallback/README.md b/packages/hydrogen/src/hooks/useCartLinesAddCallback/README.md index 16eeaae..05471c2 100644 --- a/packages/hydrogen/src/hooks/useCartLinesAddCallback/README.md +++ b/packages/hydrogen/src/hooks/useCartLinesAddCallback/README.md @@ -1,4 +1,4 @@ - + The `useCartLinesAddCallback` hook returns a callback that can be used to add lines to a cart. If a cart doesn't already exist, then it will create the cart for you. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCartLinesRemoveCallback/README.md b/packages/hydrogen/src/hooks/useCartLinesRemoveCallback/README.md index ae1f712..37c4bea 100644 --- a/packages/hydrogen/src/hooks/useCartLinesRemoveCallback/README.md +++ b/packages/hydrogen/src/hooks/useCartLinesRemoveCallback/README.md @@ -1,4 +1,4 @@ - + The `useCartLinesRemoveCallback` hook returns a callback that can be used to remove lines from a cart. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCartLinesTotalQuantity/README.md b/packages/hydrogen/src/hooks/useCartLinesTotalQuantity/README.md index 01f0701..789873e 100644 --- a/packages/hydrogen/src/hooks/useCartLinesTotalQuantity/README.md +++ b/packages/hydrogen/src/hooks/useCartLinesTotalQuantity/README.md @@ -1,4 +1,4 @@ - + The `useCartLinesTotalQuantity` hook returns the total amount of items in the cart. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCartLinesUpdateCallback/README.md b/packages/hydrogen/src/hooks/useCartLinesUpdateCallback/README.md index 3778620..44dd5ba 100644 --- a/packages/hydrogen/src/hooks/useCartLinesUpdateCallback/README.md +++ b/packages/hydrogen/src/hooks/useCartLinesUpdateCallback/README.md @@ -1,4 +1,4 @@ - + The `useCartLinesUpdateCallback` hook returns a callback that can be used to update lines in a cart. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCartNoteUpdateCallback/README.md b/packages/hydrogen/src/hooks/useCartNoteUpdateCallback/README.md index 0f287bc..84af01a 100644 --- a/packages/hydrogen/src/hooks/useCartNoteUpdateCallback/README.md +++ b/packages/hydrogen/src/hooks/useCartNoteUpdateCallback/README.md @@ -1,4 +1,4 @@ - + The `useCartNoteUpdateCallback` hook returns a callback that can be used to update the cart's note. It must be a descendent of a `CartProvider` component. diff --git a/packages/hydrogen/src/hooks/useCountry/README.md b/packages/hydrogen/src/hooks/useCountry/README.md index 8b6928a..b4e4dcb 100644 --- a/packages/hydrogen/src/hooks/useCountry/README.md +++ b/packages/hydrogen/src/hooks/useCountry/README.md @@ -1,4 +1,4 @@ - + The `useCountry` hook returns a tuple of the current localization country and a function for updating it. It must be a descendent of a `LocalizationProvider` component. diff --git a/packages/hydrogen/src/hooks/useMoney/README.md b/packages/hydrogen/src/hooks/useMoney/README.md index e3bed6c..0267e1d 100644 --- a/packages/hydrogen/src/hooks/useMoney/README.md +++ b/packages/hydrogen/src/hooks/useMoney/README.md @@ -1,4 +1,4 @@ - + The `useMoney` hook takes a [`MoneyV2` object](/api/storefront/reference/common-objects/moneyv2) and returns a default-formatted string of the amount with the correct currency indicator, along with some of the parts provided by diff --git a/packages/hydrogen/src/hooks/useParsedMetafields/README.md b/packages/hydrogen/src/hooks/useParsedMetafields/README.md index e486d97..1d7252f 100644 --- a/packages/hydrogen/src/hooks/useParsedMetafields/README.md +++ b/packages/hydrogen/src/hooks/useParsedMetafields/README.md @@ -1,4 +1,4 @@ - + The `useParsedMetafields` hook transforms a [MetafieldConnection](/api/storefront/reference/common-objects/metafieldconnection) in an array of metafields whose `values` have been parsed according to the metafield `type`. diff --git a/packages/hydrogen/src/hooks/useProduct/README.md b/packages/hydrogen/src/hooks/useProduct/README.md index 65ded72..f86a1cd 100644 --- a/packages/hydrogen/src/hooks/useProduct/README.md +++ b/packages/hydrogen/src/hooks/useProduct/README.md @@ -1,4 +1,4 @@ - + The `useProduct` hook returns the product object of the nearest `ProductProvider`. It must be a descendent of a `ProductProvider` component. diff --git a/packages/hydrogen/src/hooks/useProductOptions/README.md b/packages/hydrogen/src/hooks/useProductOptions/README.md index 5454827..ce35e45 100644 --- a/packages/hydrogen/src/hooks/useProductOptions/README.md +++ b/packages/hydrogen/src/hooks/useProductOptions/README.md @@ -1,4 +1,4 @@ - + The `useProductOptions` hook returns an object that enables you to keep track of the selected variant and/or selling plan state, as well as callbacks for modifying the state. @@ -25,7 +25,7 @@ export function MyComponent() { value={selectedVariant?.id} onChange={(e) => setSelectedVariant( - variants.find((variant) => variant.id === e.target.value) + variants.find((variant) => variant.id === e.target.value), ) } > diff --git a/packages/hydrogen/src/hooks/useQuery/README.md b/packages/hydrogen/src/hooks/useQuery/README.md index 6f0ae7e..389b805 100644 --- a/packages/hydrogen/src/hooks/useQuery/README.md +++ b/packages/hydrogen/src/hooks/useQuery/README.md @@ -1,4 +1,4 @@ - + The `useQuery` hook is a wrapper around `useQuery` from `react-query`. It supports Suspense calls on the server and on the client. diff --git a/packages/hydrogen/src/hooks/useServerState/README.md b/packages/hydrogen/src/hooks/useServerState/README.md deleted file mode 100644 index 3c116f4..0000000 --- a/packages/hydrogen/src/hooks/useServerState/README.md +++ /dev/null @@ -1,30 +0,0 @@ -The `useServerState` hook allows you to [manage server state](/api/hydrogen/framework/server-state) when using Hydrogen as a React Server Component framework. - -## Return value - -The `useServerState` hook returns an object with the following keys: - -| Key | Description | -| ---------------- | -------------------------------------------------------------------------------------- | -| `serverState` | The current server state. | -| `setServerState` | A function used to modify server state. | -| `pending` | Whether a [transition is pending](https://github.com/reactwg/react-18/discussions/41). | - -## `setServerState` - -For convenience, `setServerState` accepts arguments in the following ways: - -{% codeblock file %} - -```js -// Update a top-level state property based on key -setServerState(key: string, value: any) - -// Spread a new value object onto existing state -setServerState(newValue: object) - -// Provide a callback function to update the state completely -setServerState((previousState) => object) -``` - -{% endcodeblock %} diff --git a/packages/hydrogen/src/hooks/useShop/README.md b/packages/hydrogen/src/hooks/useShop/README.md deleted file mode 100644 index 7139e5b..0000000 --- a/packages/hydrogen/src/hooks/useShop/README.md +++ /dev/null @@ -1,35 +0,0 @@ -The `useShop` hook provides access to values within `shopify.config.js`. - -> Note: -> It must be a descendent of a `ShopifyProvider` component. - -## Example code - -{% codeblock file %} - -```jsx -import {useShop} from '@shopify/hydrogen'; - -export default function MyPage() { - const {locale} = useShop(); - - return

The locale is {locale}

; -} -``` - -{% endcodeblock %} - -## Return value - -The `useShop` hook returns an object with the following keys: - -| Key | Description | -| ---- | ----------- | -| `locale` | The locale set in `shopify.config.js`. | -| `storeDomain` | The store domain set in `shopify.config.js`. | -| `storefrontToken` | The Storefront API token set in `shopify.config.js`. | -| `graphqlApiVersion` | The GraphQL API version set in `shopify.config.js`. | - -## Related components - -- [`ShopifyProvider`](/api/hydrogen/components/global/shopifyprovider) diff --git a/packages/hydrogen/src/hooks/useShopQuery/README.md b/packages/hydrogen/src/hooks/useShopQuery/README.md index 0136daf..e1a00f5 100644 --- a/packages/hydrogen/src/hooks/useShopQuery/README.md +++ b/packages/hydrogen/src/hooks/useShopQuery/README.md @@ -1,6 +1,6 @@ - + -The `useShopQuery` hook allows you to make server-only GraphQL queries to the Storefront API. The `useShop` hook provides access to values within `shopify.config.js`. It must be a descendent of a `ShopifyProvider` component. +The `useShopQuery` hook allows you to make server-only GraphQL queries to the Storefront API. The `useShop` hook provides access to values within `shopify.config.js`. It must be a descendent of a `ShopifyProvider` component. ## Example code diff --git a/packages/hydrogen/src/utilities/flattenConnection/README.md b/packages/hydrogen/src/utilities/flattenConnection/README.md index 58f27b5..25de1df 100644 --- a/packages/hydrogen/src/utilities/flattenConnection/README.md +++ b/packages/hydrogen/src/utilities/flattenConnection/README.md @@ -1,4 +1,4 @@ - + The `flattenConnection` utility transforms a connection object from the Storefront API (for example, [Product-related connections](api/storefront/reference/products/product#connections)) into a flat array of nodes. diff --git a/packages/hydrogen/src/utilities/isClient/README.md b/packages/hydrogen/src/utilities/isClient/README.md index 6b8170d..252d677 100644 --- a/packages/hydrogen/src/utilities/isClient/README.md +++ b/packages/hydrogen/src/utilities/isClient/README.md @@ -1,4 +1,4 @@ - + The `isClient` utility is a function that returns a boolean indicating if the code was run on the client. diff --git a/packages/hydrogen/src/utilities/isServer/README.md b/packages/hydrogen/src/utilities/isServer/README.md index e320c18..80ecd00 100644 --- a/packages/hydrogen/src/utilities/isServer/README.md +++ b/packages/hydrogen/src/utilities/isServer/README.md @@ -1,4 +1,4 @@ - + The `isServer` utility is a function that returns a `boolean` indicating if the code was run on the server. diff --git a/packages/hydrogen/src/utilities/parseMetafieldValue/README.md b/packages/hydrogen/src/utilities/parseMetafieldValue/README.md index 88add94..3e78a4f 100644 --- a/packages/hydrogen/src/utilities/parseMetafieldValue/README.md +++ b/packages/hydrogen/src/utilities/parseMetafieldValue/README.md @@ -1,4 +1,4 @@ - + The `parseMetafieldValue` function parses a [Metafield](/api/storefront/reference/common-objects/metafield)'s `value` from a string into a sensible type corresponding to the [Metafield](/api/storefront/reference/common-objects/metafield)'s `type`. @@ -67,7 +67,7 @@ export function Product({handle}) { const metafields = flattenConnection(data.product.metafields); const parsedMetafields = metafields.map((metafield) => - parseMetafieldValue(metafield) + parseMetafieldValue(metafield), ); return (