From f7912675f4c33dfad1e2234d8c5f627b2568977c Mon Sep 17 00:00:00 2001 From: Scott Bolinger Date: Mon, 19 Oct 2026 11:30:25 -0700 Subject: [PATCH 1/4] Make storefront parts extensible without reimplementing their rules - ProductDetailsRoot takes productId, urlState and loading/notFound/error replacements; it no longer requests /products/ without a product ID. - CatalogRoot and Catalog take pageSize; CatalogRoot takes urlState, and CatalogProducts takes empty. - Action and heading parts take replacement text, or a function of their state, while keeping their behavior. - CommerceProvider takes locale; useMoney and ProductImage are exported. - onEvent reports cart changes and failures; a throwing host callback no longer fails the cart operation. - Every part has a stable data-commerce-part styling hook. Co-Authored-By: Claude Opus 5.5 --- .changeset/storefront-extensibility.md | 12 + packages/commerce-storefront/README.md | 91 +++- packages/commerce-storefront/src/api.ts | 5 +- .../commerce-storefront/src/cart-parts.tsx | 101 ++-- packages/commerce-storefront/src/cart.tsx | 46 +- packages/commerce-storefront/src/catalog.tsx | 68 ++- .../src/commerce-provider.tsx | 135 ++++- .../src/extensibility.test.tsx | 507 ++++++++++++++++++ packages/commerce-storefront/src/index.ts | 21 +- packages/commerce-storefront/src/part.ts | 28 + .../commerce-storefront/src/product-card.tsx | 83 ++- .../src/product-details-context.tsx | 103 +++- .../src/product-details.tsx | 31 +- .../src/product-purchase.tsx | 48 +- .../commerce-storefront/src/root-params.ts | 12 + .../commerce-storefront/src/sample-cart.tsx | 13 +- 16 files changed, 1139 insertions(+), 165 deletions(-) create mode 100644 .changeset/storefront-extensibility.md create mode 100644 packages/commerce-storefront/src/extensibility.test.tsx create mode 100644 packages/commerce-storefront/src/root-params.ts diff --git a/.changeset/storefront-extensibility.md b/.changeset/storefront-extensibility.md new file mode 100644 index 00000000..f1aa930d --- /dev/null +++ b/.changeset/storefront-extensibility.md @@ -0,0 +1,12 @@ +--- +"@godaddy/gd-commerce-storefront": minor +--- + +Make the storefront parts more extensible without reimplementing their rules. + +- `ProductDetailsRoot` takes a `productId` prop, which falls back to the route's `:productId`, so a product can render in a quick view or outside its route. `urlState={false}` keeps that root's selection out of the page URL, so two roots on one page no longer share a selection. `loading`, `notFound` and `error` replace those states. A root with no product ID now shows the not-found state without requesting `/products/`, and warns in development. +- `CatalogRoot` and `Catalog` take `pageSize`, which defaults to 6. `CatalogRoot` takes `urlState={false}` for a second catalog on a page. `CatalogProducts` takes `empty`. +- `CartButton`, `AddToCartButton`, `ProductDetailsAddToCart`, `ProductCardAction`, `CartCheckout`, `CartItemRemove`, `CartTitle`, `CartDescription` and `ProductDetailsBackLink` take replacement text as children, or a function of the part's state, such as `({ busy }) => …`. The controls keep their behavior. +- `CommerceProvider` and `CommerceStorefront` take `locale` for price formatting, which defaults to `en-US`; an invalid tag falls back to it. `useMoney()` formats prices in that locale for custom parts, `money()` takes an optional locale, and `ProductImage` is exported. +- `onEvent` reports `item-added`, `quantity-changed`, `item-removed`, `discount-applied`, `checkout-started` and `error` events. A host callback that throws, including `onItemAdded`, is now logged instead of failing the cart operation and showing its message as a cart error. +- Every part's outer element has a stable `data-commerce-part` attribute, such as `cart-checkout`, documented as a styling hook. No elements are added or removed. diff --git a/packages/commerce-storefront/README.md b/packages/commerce-storefront/README.md index 073b35c0..8355b35e 100644 --- a/packages/commerce-storefront/README.md +++ b/packages/commerce-storefront/README.md @@ -55,6 +55,8 @@ Use the providers your application already has; do not create another router or | `productPath` | `/products` | Same-origin prefix for product links; register `${productPath}/:productId` | | `checkoutSuccessPath` | unset | Same-origin return route; enables checkout UI only when supplied | | `onItemAdded` | unset | Called with `{ name, quantity, isSample }` after each add, live or sample; use it to confirm adds on a site with a cart page instead of a drawer | +| `onEvent` | unset | Called with a [`CommerceEvent`](#events) for every cart change and failure, such as for analytics | +| `locale` | `en-US` | BCP 47 locale for prices, such as `de-DE`; an invalid tag falls back to `en-US` with a development warning | | `theme` | inherited text and transparent wrappers; neutral control palette | CSS custom properties applied to storefront surfaces and the portalled drawer | Provide root-relative paths without a trailing slash. Enable `checkoutSuccessPath` only after your server supports checkout and validates merchant readiness. Mount a corresponding return page. A redirect back from checkout is **not proof of payment**; that page must obtain authoritative payment status from your server. This package does not provide a payment receipt page or merchant onboarding. @@ -85,9 +87,9 @@ A connection failure leaves the surrounding application and its state mounted. C The stylesheet includes all required utilities and scopes them to the package's surfaces. The build removes CSS layer wrappers in their declared order, so the exported CSS can pass through a host Tailwind v3 PostCSS pipeline without `@tailwind` directives. Import it directly; consumers do not need to copy or rewrite the CSS. It does not add a global reset or require dependency scanning by a host Tailwind build. The `theme` prop reaches the drawer even though it is portalled into `document.body`. -By default, `.commerce-storefront` wrappers do not paint a background and inherit the host's text color. Set page and section backgrounds on the host application's layout elements. `--commerce-surface` colors controls and the opaque cart drawer, and supplies the base for muted colors; it does not color component wrappers. Set `--commerce-surface` and `--commerce-text` together to adapt controls and the drawer to a dark theme. Avoid setting wrapper backgrounds through CSS or the `theme` prop's `background`, `backgroundColor`, or `backgroundImage` properties, which can still override the transparent default. Descendants inherit the surface text and body font instead of global heading styles. Keep text, controls and focus indicators accessible when changing colors. Internal utility class names and markup are not a customization API; use the [product](#custom-product-layouts), [catalog](#custom-catalog-layouts) and [cart](#custom-cart-layouts) parts to change a layout. +By default, `.commerce-storefront` wrappers do not paint a background and inherit the host's text color. Set page and section backgrounds on the host application's layout elements. `--commerce-surface` colors controls and the opaque cart drawer, and supplies the base for muted colors; it does not color component wrappers. Set `--commerce-surface` and `--commerce-text` together to adapt controls and the drawer to a dark theme. Avoid setting wrapper backgrounds through CSS or the `theme` prop's `background`, `backgroundColor`, or `backgroundImage` properties, which can still override the transparent default. Descendants inherit the surface text and body font instead of global heading styles. Keep text, controls and focus indicators accessible when changing colors. Internal utility class names and markup are not a customization API; use the [product](#custom-product-layouts), [catalog](#custom-catalog-layouts) and [cart](#custom-cart-layouts) parts to change a layout, and the [styling hooks](#styling-hooks) to style inside a part. -The first release uses English UI text and `en-US` currency formatting. The catalog title and description are configurable through `CatalogHeader`. Full localization is outside this initial API. +Prices follow the provider's `locale`, which defaults to `en-US`. UI text is English. The catalog title and description are configurable through `CatalogHeader`, and many parts take [replacement text](#replacing-text). Full localization is outside this initial API. ## Compatibility @@ -100,17 +102,19 @@ The repository example uses React Router 7. Follow each router version's own Rea | Export | Purpose | | --- | --- | | `CommerceStorefront` | Recommended integration: provider and one drawer | -| `Catalog` | Six products per cursor page. Its `title`, `description`, and `showHeader` props are deprecated; compose `CatalogRoot` instead | +| `Catalog` | Six products per cursor page, or `pageSize`. Its `title`, `description`, and `showHeader` props are deprecated; compose `CatalogRoot` instead | | `CatalogRoot` and catalog parts | Build a [custom catalog or card layout](#custom-catalog-layouts) with the same rules as `Catalog` | -| `ProductDetails` | Reads `:productId`; validates URL option selections against catalog results | +| `ProductDetails` | Reads `:productId`; validates URL option selections against catalog results. `ProductDetailsRoot` also takes a `productId` prop | | `ProductDetailsRoot` and product parts | Build a [custom product layout](#custom-product-layouts) with the same rules as `ProductDetails` | | `ProductCard` | Renders one `SKUGroup` with direct add or a product-details link; `ProductCardRoot` and card parts customize it | | `CartDrawer` | The cart dialog; `CommerceStorefront` mounts one | | `CartDrawerRoot`, `CartRoot` and cart parts | Build a [custom drawer or a cart page](#custom-cart-layouts) with the same rules as `CartDrawer` | -| `CartButton` | Opens the shared drawer and displays item count; `useCart()` builds a custom one | -| `AddToCartButton` | Adds a verified `sku`, `name`, and optional integer `quantity`; while disabled, its accessible description says why | +| `CartButton` | Opens the shared drawer and displays item count; its children replace the label, and `useCart()` builds a custom one | +| `AddToCartButton` | Adds a verified `sku`, `name`, and optional integer `quantity`; while disabled, its accessible description says why. Its children replace the label | | `CommerceStatus` | Connection progress/error/retry for custom layouts | | `useCommerce` | Cart, connection, pending/error state and serialized cart actions | +| `useMoney` | Formats minor units in the provider's `locale`, like the package's own prices, for custom parts | +| `ProductImage` | A product image with the package's placeholder for a missing or broken image, for custom parts | | `CommerceProvider` | Lower-level composition when the recommended wrapper does not fit, such as a custom drawer; mount it once | The package exports TypeScript catalog/cart response types and selection/summary helpers for custom product layouts. `useCommerce` actions return `Promise`: `false` means an operation failed or its connection became stale. Inspect `error` for active-session failures. Do not automatically retry a failed mutation: the server may have committed it before the response failed. `applyDiscount(code)` is available to custom layouts; the default drawer does not render a promotion form. @@ -119,7 +123,7 @@ The package exports TypeScript catalog/cart response types and selection/summary ## Custom product layouts -`ProductDetails` is the recommended product page. When its layout does not fit, compose the same parts inside `ProductDetailsRoot`. The root loads the route's `:productId` and shows the connection, loading, error and not-found states itself, so parts render only once the product exists. This is the packaged layout, written out: +`ProductDetails` is the recommended product page. When its layout does not fit, compose the same parts inside `ProductDetailsRoot`. The root loads the route's `:productId`, or its `productId` prop, and shows the connection, loading, error and not-found states itself, so parts render only once the product exists. This is the packaged layout, written out: ```tsx import { @@ -155,6 +159,23 @@ Add your own elements between parts, reorder them, or leave out display parts. ` Every part is named `ProductDetails*` because it works only inside `ProductDetailsRoot`. `AddToCartButton` is the standalone button for a SKU you already have. +The root keeps the selection in the page URL, as `option.` and `sku`, so a reload or a shared link keeps it. To show a product outside its route, such as in a quick view or next to another product, pass `productId` and set `urlState={false}`. That root keeps its selection to itself, and it ends when the root unmounts. Give every root but one on a page `urlState={false}`; otherwise the roots share one selection. A root with no `productId` on a route without `:productId` shows the not-found state and, in development builds, warns. + +```tsx +{/* Your own dialog, opened from a card with the product's ID. */} + setQuickViewId(null)}> + {quickViewId && ( + Loading…

}> + + + + + )} + +``` + +`loading` and `notFound` replace those states. `error` replaces the load failure; as a function, it receives `{ message, retry }`. Replacement content renders inside the root's element, which keeps its `className`, and the error keeps `role='alert'`; a replacement loading message should have its own `role='status'`. + Parts read state from the root and take no product, SKU, price or quantity props. Whatever the layout, only a server-verified SKU can be added, and changing a selection resets the quantity and image. Every part throws if it is rendered outside `ProductDetailsRoot`. In development builds, if no control is rendered for an attribute the product requires, a console warning names the missing ones. A control that mounts later, such as one in a closed accordion, can trigger it; the product becomes purchasable once the control renders. Products without attributes but with several SKUs need `ProductDetailsOptions` or `ProductDetailsPurchase`. Parts can be rendered more than once, such as in a sticky mobile purchase bar; each copy gets its own element IDs. Every part accepts `className`, which is added to the part's outer element, a wrapper the package's CSS reset leaves alone. Host classes there control margin, padding, border, color, width, display, gap and grid placement, including layered utilities such as Tailwind v4's. In `ProductDetailsOptions` and `ProductDetailsPurchase`, each control keeps a 24px bottom margin, even in a host grid. The exception is a class name the package also uses, such as `grid-cols-1` or `p-6`: the package's rule wins, even over the host's responsive variants on the same element, such as `md:grid-cols-4`. The packaged layout sets its spacing and grid placement this way. Elements inside the part, such as the title's `

`, keep the package's own styles: a host font size on `ProductDetailsTitle` does not change the heading's size, but a host color does reach it, because the heading inherits its color. @@ -196,7 +217,7 @@ Parts are flat named exports, not properties such as `ProductDetails.Title`, so ## Custom catalog layouts -`Catalog` is the recommended catalog. When its layout or its cards do not fit, compose the same parts inside `CatalogRoot`. The root loads one cursor page of six products, or the built-in samples when `sampleProducts` is set and no store is connected, and shows the connection state itself. This is `` written out with its packaged card: +`Catalog` is the recommended catalog. When its layout or its cards do not fit, compose the same parts inside `CatalogRoot`. The root loads one cursor page of six products, or `pageSize` products, or the built-in samples when `sampleProducts` is set and no store is connected, and shows the connection state itself. This is `` written out with its packaged card: ```tsx import { @@ -232,14 +253,16 @@ As with product layouts, the grid, spacing and border classes come from your own | --- | --- | | `CatalogHeader` | The `title` as the page's H1 and a `description`; leave it out when the host page owns the H1 | | `CatalogSummary` | The loading, failure or product-count status line | -| `CatalogProducts` | One card per product. Its children are the card, rendered once for each product; without children, the packaged card | +| `CatalogProducts` | One card per product. Its children are the card, rendered once for each product; without children, the packaged card. `empty` replaces the message for a catalog with no products | | `CatalogPagination` | First-page and next-page buttons; nothing for samples | | `ProductCardImage`, `ProductCardTitle` | The first image and the name as an H2, each linked to the product page. With a title in the card, keyboard and screen reader users get only the title link; without one, the image link takes its place once the page is interactive | | `ProductCardDescription`, `ProductCardPrice` | Up to three lines of description (nothing without one), and the price or price range | -| `ProductCardAction` | Adds the product directly only when it has one SKU and no options; otherwise links to the product page to choose | +| `ProductCardAction` | Adds the product directly only when it has one SKU and no options; otherwise links to the product page to choose. Its children replace the label; as a function, they receive the `action`: `add`, `choose-options` or `view-product` | `className` on `CatalogProducts` goes on the element whose direct children are the cards, so a host grid places them, and `className` on `ProductCardRoot` goes on each card, so classes such as `col-span-2` work. While products load, that element holds three placeholder cards, so they follow the host's grid. The error with its retry button and the empty message render just before it. Card parts take no product, SKU or price props. Inside `CatalogProducts`, `ProductCardRoot` takes no `product` prop either and throws if it gets one, so a card always shows the product it is rendered for. Samples use the same card: they show a placeholder image, no description and no links, and add only to the sample cart. Card and catalog parts throw if they are rendered outside their root. Packaged cards fill their grid row, with the price and action at the bottom of each card. +The root keeps its page cursor in the page URL, as `after`. For a second catalog on the same page, such as a featured row above the main grid, set `urlState={false}` on it so the two do not share one cursor. + For a product the host already has, such as a featured product, use `ProductCard` or `ProductCardRoot` with a `product` prop outside the catalog. `useProductCard()` returns read-only `product` (`null` for samples), `name`, `href` (`null` for samples) and `isSample` for building custom card parts. Every part accepts `className` on an outer wrapper that the package's CSS reset leaves alone, with the same limits as [product parts](#custom-product-layouts). ## Custom cart layouts @@ -332,6 +355,54 @@ Two hooks support custom cart markup: - `useCart()` works anywhere inside `CommerceProvider`. It returns read-only `items`, `itemCount`, `subtotal` (minor units, or `null` when the server has not priced the cart), `currency`, `isSample` and `loading`. Combine `itemCount` with `useCommerce().setOpen(true)` for a custom cart button. - `useCartItem()` returns the line inside `CartItemRoot`: `id`, `name`, `quantity`, `imageUrl`, `options`, `subtotal` and `currency`. +## Replacing text + +Parts whose wording a site often changes take replacement content as children. The part keeps its element, accessibility and rules: a replaced checkout label still waits for the cart total and still blocks a second click. As a function, the children receive the part's state, so the label can change with it. Content that renders nothing falls back to the package text, so a button is never left unlabeled. + +```tsx +{({ busy }) => (busy ? 'Redirecting…' : 'Pay securely')} +{({ itemCount }) => `Bag (${itemCount})`} +{({ soldOut }) => (soldOut ? 'Sold out' : 'Add to bag')} +``` + +| Part | Function receives | +| --- | --- | +| `CartTitle`, `CartDescription` | `{ isSample }` | +| `CartCheckout`, `CartItemRemove` | `{ busy }` | +| `CartButton` | `{ itemCount }`. Keep the count in the label | +| `AddToCartButton`, `ProductDetailsAddToCart` | `{ busy, soldOut }` | +| `ProductCardAction` | `{ action, busy, soldOut }` | +| `ProductDetailsBackLink` | Content only | + +Accessible names that include the product name, such as "Remove Mug" and "Increase quantity of Mug", stay in English. + +## Styling hooks + +Every part's outer element has a `data-commerce-part` attribute with the part's name in kebab case, such as `cart-checkout` or `product-details-option`. Roots have one too, such as `product-details-root`, including while they show the connection, loading or error state. `CartButton` and add-to-cart buttons have `cart-button` and `add-to-cart-button` on the button itself. These names, and the controls' standard state attributes (`disabled`, `aria-busy`, `aria-pressed`, `aria-invalid`, `aria-expanded`), are a stable styling API; utility classes and other markup are not. + +```css +.commerce-storefront [data-commerce-part='cart-checkout'] button { border-radius: 9999px; } +.commerce-storefront [data-commerce-part='cart-checkout'] button[aria-busy='true'] { opacity: 0.7; } +.commerce-storefront [data-commerce-part='product-details-option'][data-commerce-attribute='color'] { display: none; } +``` + +`ProductDetailsOption` also has `data-commerce-attribute` with its attribute name. Controls inside a part that has more than one have `data-commerce-control`: `decrease` and `increase` in `CartItemQuantity`, and `thumbnail` in `ProductDetailsGallery`. The package's utilities are unlayered and have the specificity of two classes, such as `.commerce-storefront .w-full`, or three with a state such as `:hover`. To override one, write unlayered CSS that starts with `.commerce-storefront` and a part attribute, and add the same state when the utility has one, as above. Layered host CSS, such as Tailwind v4 utilities, loses to the package's unlayered rules whatever its specificity. + +## Events + +`onEvent` on `CommerceProvider` or `CommerceStorefront` receives every cart change once the server has returned the updated cart, and every cart failure. Sample-cart changes have `isSample: true` and never reach the store. + +| `type` | Fields | +| --- | --- | +| `item-added` | `skuId` (`null` for samples), `name`, `quantity`, `isSample` | +| `quantity-changed` | `itemId`, `quantity`, `isSample` | +| `item-removed` | `itemId`, `isSample` | +| `discount-applied` | `code` | +| `checkout-started` | `cartId`; sent just before the browser leaves for checkout, so use `navigator.sendBeacon` or a keepalive request | +| `error` | `operation` (`add`, `change-quantity`, `remove`, `discount`, `refresh` or `checkout`) and the `message` the cart shows | + +New event types may be added in minor releases, so ignore types you do not handle. A callback that throws, including `onItemAdded`, is logged to the console and does not fail the cart operation. + ## How it works Products are SKU groups. The package purchases only an unambiguous SKU, verifies all selected attributes through the server, uses SKU prices/images, and distinguishes untracked inventory from sold-out inventory. Server-side inventory and pricing checks remain mandatory. diff --git a/packages/commerce-storefront/src/api.ts b/packages/commerce-storefront/src/api.ts index 71e029f9..ef5c1d37 100644 --- a/packages/commerce-storefront/src/api.ts +++ b/packages/commerce-storefront/src/api.ts @@ -87,8 +87,9 @@ export async function request(path: string, init?: RequestInit): Promise { } } -export function money(value: number, currency: string): string { - const formatter: Intl.NumberFormat = new Intl.NumberFormat('en-US', { +/** Formats minor units, such as cents, as currency. Inside the provider, prefer `useMoney`, which follows its `locale`. */ +export function money(value: number, currency: string, locale: string = 'en-US'): string { + const formatter: Intl.NumberFormat = new Intl.NumberFormat(locale, { style: 'currency', currency, }); diff --git a/packages/commerce-storefront/src/cart-parts.tsx b/packages/commerce-storefront/src/cart-parts.tsx index 2b1dc7cc..80a4c2db 100644 --- a/packages/commerce-storefront/src/cart-parts.tsx +++ b/packages/commerce-storefront/src/cart-parts.tsx @@ -10,11 +10,17 @@ import { useState, } from 'react'; import { Link } from 'react-router'; -import { money } from './api'; import { buttonClass } from './cart'; import { type CartItemState, type CartState, useCart } from './cart-state'; -import { CartDrawerRegistry, useCommerce } from './commerce-provider'; -import { hasChildren, type PartRegistry, partClass, usePartRegistry } from './part'; +import { CartDrawerRegistry, useCommerce, useMoney } from './commerce-provider'; +import { + hasChildren, + type PartLabel, + type PartRegistry, + partProps, + renderLabel, + usePartRegistry, +} from './part'; import { useSampleCart } from './sample-cart'; import { CommerceStatus, StorefrontSurface } from './storefront-surface'; @@ -23,6 +29,18 @@ export interface CartPartProps { className?: string; } +/** Props for a cart part whose text the host can replace, with or without the sample wording. */ +export interface CartTextPartProps extends CartPartProps { + /** Replaces the text. A function receives whether the cart is the sample cart. */ + children?: PartLabel<{ isSample: boolean }>; +} + +/** Props for a cart button whose label the host can replace. The button keeps its behavior and state. */ +export interface CartActionPartProps extends CartPartProps { + /** Replaces the button label. A function receives whether the action is running. */ + children?: PartLabel<{ busy: boolean }>; +} + interface CartDrawerInternal { register: PartRegistry['register']; } @@ -104,13 +122,16 @@ export function CartRoot({ children, className }: CartRootProps): ReactElement { {connection === 'ready' || isSample ? ( -
+
{children}
) : ( // Host classes stay on while connecting, so the layout does not jump when the cart replaces the status. -
+
)} @@ -155,7 +176,7 @@ export function CartDrawerRoot({ children, className }: CartDrawerRootProps): Re { event.preventDefault(); restoreFocus(); @@ -173,27 +194,33 @@ export function CartDrawerRoot({ children, className }: CartDrawerRootProps): Re } /** "Your cart", or "Sample cart" before a store is connected, as an H2. In the drawer it names the dialog. */ -export function CartTitle({ className }: CartPartProps): ReactElement { +export function CartTitle({ className, children }: CartTextPartProps): ReactElement { const { isSample } = useCartInternal('CartTitle'); const Heading = useContext(CartDrawerContext) ? Dialog.Title : 'h2'; return ( -
- {isSample ? 'Sample cart' : 'Your cart'} +
+ + {renderLabel(children, { isSample }, isSample ? 'Sample cart' : 'Your cart')} +
); } /** One line about the cart. In the drawer it describes the dialog. */ -export function CartDescription({ className }: CartPartProps): ReactElement { +export function CartDescription({ className, children }: CartTextPartProps): ReactElement { const { isSample } = useCartInternal('CartDescription'); const drawer = useContext(CartDrawerContext); const register = drawer?.register; useEffect(() => register?.('description'), [register]); - const text: string = isSample - ? 'Example products and prices in USD. Nothing can be purchased.' - : 'Review your items before checkout.'; + const text: ReactNode = renderLabel( + children, + { isSample }, + isSample + ? 'Example products and prices in USD. Nothing can be purchased.' + : 'Review your items before checkout.', + ); return ( -
+
{drawer ? ( {text} ) : ( @@ -208,7 +235,7 @@ export function CartClose({ className }: CartPartProps): ReactElement | null { useCartInternal('CartClose'); if (!useContext(CartDrawerContext)) return null; return ( -
+
+
{storageWarning && (

@@ -295,7 +322,7 @@ export function CartItems({ className, children }: CartItemsProps): ReactElement {hydrating &&

Loading your cart…

} {/* A `
    ` needs a package margin and padding reset, which would beat host classes here. */} -
    +
    {items.map((item, index) => ( {template} @@ -320,7 +347,7 @@ export function CartItemRoot({ children, className }: CartItemRootProps): ReactE if (!item) throw new Error('CartItemRoot must be rendered inside .'); return ( -
    +
    {/* An item nested inside this one is not a cart line. */} {children}
    @@ -333,7 +360,7 @@ export function CartItemImage({ className }: CartPartProps): ReactElement | null const { imageUrl } = useCartItemInternal('CartItemImage'); if (!imageUrl) return null; return ( -
    +
    ); @@ -343,7 +370,7 @@ export function CartItemImage({ className }: CartPartProps): ReactElement | null export function CartItemName({ className }: CartPartProps): ReactElement { const { name } = useCartItemInternal('CartItemName'); return ( -
    +

    {name}

    ); @@ -354,7 +381,7 @@ export function CartItemOptions({ className }: CartPartProps): ReactElement | nu const { options } = useCartItemInternal('CartItemOptions'); if (!options.length) return null; return ( -
    +
    {options.map((option) => (

    {option.attribute}: {option.values.join(', ')} @@ -367,8 +394,9 @@ export function CartItemOptions({ className }: CartPartProps): ReactElement | nu /** The line total. */ export function CartItemPrice({ className }: CartPartProps): ReactElement { const { subtotal, currency } = useCartItemInternal('CartItemPrice'); + const money = useMoney(); return ( -

    +

    {subtotal === null ? 'Price unavailable' : money(subtotal, currency)}

    ); @@ -382,12 +410,13 @@ export function CartItemQuantity({ className }: CartPartProps): ReactElement { const { id, name, quantity } = useCartItemInternal('CartItemQuantity'); const { action, locked, run, changeQuantity } = useCartInternal('CartItemQuantity'); return ( -
    +
    ); @@ -463,7 +493,7 @@ export function CartEmpty({ className, children }: CartEmptyProps): ReactElement const { items, hydrating, isSample, catalogPath, close } = useCartInternal('CartEmpty'); if (hydrating || items.length) return null; return ( -
    +
    {hasChildren(children) ? ( children ) : ( @@ -489,15 +519,16 @@ export interface CartSummaryProps extends CartPartProps { export function CartSummary({ className, children }: CartSummaryProps): ReactElement | null { const { items } = useCartInternal('CartSummary'); if (!items.length) return null; - return
    {children}
    ; + return
    {children}
    ; } /** The subtotal, labeled "Sample subtotal" for samples. Renders nothing until the server prices the cart. */ export function CartSubtotal({ className }: CartPartProps): ReactElement | null { const { items, subtotal, currency, isSample } = useCartInternal('CartSubtotal'); + const money = useMoney(); if (!items.length || subtotal === null) return null; return ( -
    +
    {isSample ? 'Sample subtotal' : 'Subtotal'}
    @@ -517,7 +548,7 @@ export function CartCheckoutNote({ className }: CartPartProps): ReactElement | n if (isSample || !items.length) return null; // The stable class is on the outer element, so hiding it also removes the host's spacing. return ( -
    +

    Shipping, taxes, and discounts are calculated at checkout.

    ); @@ -527,7 +558,7 @@ export function CartCheckoutNote({ className }: CartPartProps): ReactElement | n * The checkout button when `checkoutSuccessPath` is set; otherwise a message that checkout is unavailable. * Samples never check out. Renders nothing for an empty cart. */ -export function CartCheckout({ className }: CartPartProps): ReactElement | null { +export function CartCheckout({ className, children }: CartActionPartProps): ReactElement | null { const { items, isSample, checkoutEnabled, checkoutReady, hydrating, action, locked, run, checkout } = useCartInternal('CartCheckout'); if (!items.length) return null; @@ -546,10 +577,14 @@ export function CartCheckout({ className }: CartPartProps): ReactElement | null aria-busy={action === 'checkout'} onClick={() => run('checkout', checkout)} > - {action === 'checkout' ? 'Opening checkout…' : 'Proceed to Checkout'} + {renderLabel( + children, + { busy: action === 'checkout' }, + action === 'checkout' ? 'Opening checkout…' : 'Proceed to Checkout', + )} ); - return
    {content}
    ; + return
    {content}
    ; } /** The packaged cart drawer. Compose `CartDrawerRoot` and the cart parts for a custom drawer. */ diff --git a/packages/commerce-storefront/src/cart.tsx b/packages/commerce-storefront/src/cart.tsx index 117b6d8c..cfbf0833 100644 --- a/packages/commerce-storefront/src/cart.tsx +++ b/packages/commerce-storefront/src/cart.tsx @@ -3,6 +3,7 @@ import { useCart } from './cart-state'; import type { SKU } from './catalog-model'; import { getAvailableInventoryQuantity } from './catalog-model'; import { useCommerce } from './commerce-provider'; +import { type PartLabel, renderLabel } from './part'; import { StorefrontSurface } from './storefront-surface'; export const buttonClass: string = @@ -10,7 +11,13 @@ export const buttonClass: string = export const inputClass: string = 'min-h-11 rounded-lg border border-neutral-400 bg-white px-3 py-2 text-neutral-900 focus-visible:outline focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-neutral-900'; -export function CartButton(): ReactElement { +export interface CartButtonProps { + /** Replaces the label and count. A function receives the item count. Keep the count in the label. */ + children?: PartLabel<{ itemCount: number }>; +} + +/** Opens the cart drawer and shows the item count. */ +export function CartButton({ children }: CartButtonProps = {}): ReactElement { const { setOpen, open, connection } = useCommerce(); const { itemCount } = useCart(); return ( @@ -21,9 +28,17 @@ export function CartButton(): ReactElement { disabled={connection !== 'ready' && connection !== 'unbound'} aria-haspopup='dialog' aria-expanded={open} + data-commerce-part='cart-button' onClick={() => setOpen(true)} > - Cart {itemCount} + {renderLabel( + children, + { itemCount }, + <> + Cart{' '} + {itemCount} + , + )} ); @@ -39,15 +54,23 @@ export function quantityProblem(quantity: number, available: number | null): str return null; } -export function AddToCartButton({ - sku, - name, - quantity = 1, -}: { +/** What an add-to-cart label can depend on. */ +export interface AddToCartLabelState { + /** The add is running. */ + readonly busy: boolean; + /** Tracked stock is used up, so the button stays disabled. */ + readonly soldOut: boolean; +} + +export interface AddToCartButtonProps { sku: SKU; name: string; quantity?: number; -}): ReactElement { + /** Replaces the label. A function receives `busy` and `soldOut`; the button keeps its rules either way. */ + children?: PartLabel; +} + +export function AddToCartButton({ sku, name, quantity = 1, children }: AddToCartButtonProps): ReactElement { const { addItem, pending, hydrating, error, open, connection } = useCommerce(); const [adding, setAdding] = useState(false); const reasonId = useId(); @@ -79,9 +102,14 @@ export function AddToCartButton({ aria-disabled={disabled || pending} aria-busy={adding} aria-describedby={reason ? reasonId : undefined} + data-commerce-part='add-to-cart-button' onClick={() => void handleAdd()} > - {soldOut ? 'Out of stock' : adding ? 'Adding…' : 'Add to cart'} + {renderLabel( + children, + { busy: adding, soldOut }, + soldOut ? 'Out of stock' : adding ? 'Adding…' : 'Add to cart', + )} {reason && (