COMDOX-1671: Removed all references to ProductDetails except the deprecation notice#888
COMDOX-1671: Removed all references to ProductDetails except the deprecation notice#888bdenham wants to merge 7 commits into
Conversation
sirugh
left a comment
There was a problem hiding this comment.
This is really good, but we need to talk about whether it's better to remove entirely, or retain but with deprecated label.
| <Aside type="caution"> | ||
| The monolithic `ProductDetails` container is deprecated. It is not used in the Commerce boilerplate. Do not use it for new work. Compose the smaller containers in this table instead (for example, [ProductHeader](/dropins/product-details/containers/product-header/), [ProductGallery](/dropins/product-details/containers/product-gallery/), [ProductPrice](/dropins/product-details/containers/product-price/), and [ProductOptions](/dropins/product-details/containers/product-options/)), then use [Slots](/dropins/product-details/slots/) on each container when you need slot-based customization. | ||
| </Aside> | ||
|
|
||
| Add to Cart, Add to Wishlist, and similar primary actions are not provided through the Product Details slots in the [Slots](/dropins/product-details/slots/) table. The storefront composes them in the product-details block using separate mount points and the Wishlist or cart patterns described in [Add to Cart and Add to Wishlist](/dropins/product-details/slots/#add-to-cart-and-add-to-wishlist) on that page. | ||
|
|
| | Container | Slots | | ||
| |-----------|-------| | ||
| | [`ProductAttributes`](#productattributes-slots) | `Attributes` | | ||
| | [`ProductDetails`](#productdetails-slots) | `Title`, `SKU`, `RegularPrice`, `SpecialPrice`, `Options`, `Quantity`, `Actions`, `ShortDescription`, `Description`, `Attributes`, `Breadcrumbs`, `GalleryContent`, `InfoContent`, `Content` | |
There was a problem hiding this comment.
Same, I'd re-add this with clear indication that it is deprecated, like in the Container column of this table it was removed from. Or even a new column, Deprecated that has boolean entries?.
| } | ||
| })(block); | ||
| ``` | ||
| Slots for the deprecated monolithic single-container API are not documented on this page, and that pattern is not used in the Commerce boilerplate. For the full container list, links to each topic, and the canonical deprecation notice, use the [containers overview](/dropins/product-details/containers/). For migration context, see [Product details page architectural evolution](/boilerplate/updates/#product-details-page-architectural-evolution). |
There was a problem hiding this comment.
Would have to change this if we decide to keep the deprecated API.
Co-authored-by: Stephen <sirugh@users.noreply.github.com>
| ``` | ||
|
|
||
| ## ProductDetails slots | ||
| ## ProductDetails slots (deprecated) |
There was a problem hiding this comment.
Nit: The slots aren't deprecated, the container is. Can we tune this slightly on the entire PR? I noticed it's a bit backwards (to me at least)
Good:
ProductDetails Container (deprecated)
ProductDetails (deprecated) slots
Bad:
ProductDetails (deprecated) container
ProductDetails slots (deprecated)
| import { ProductDetails } from '@dropins/storefront-pdp/containers/ProductDetails.js'; // (deprecated) | ||
|
|
||
| // New: Multiple independent containers | ||
| // After: multiple independent containers |
There was a problem hiding this comment.
"Old" vs "New"
"Before" vs "After"
See line 373. Pick one :)
Purpose of this pull request
This pull request (PR) deprecates and removes public documentation for the monolithic Product Details
ProductDetailscontainer while keeping a single canonical deprecation on the containers overview and in enrichments. It updates PDP migration copy, slots, prerender examples, sidebar.Preview
https://commerce-docs.github.io/microsite-commerce-storefront/dropins/product-details/containers/product-details/
Associated JIRA ticket
COMDOX-1671
Affected pages