hydrogen/packages/hydrogen/src/components/ProductDescription/README.md
2021-11-09 18:20:09 -08:00

1.3 KiB

The ProductDescription component renders a RawHtml component with the product's descriptionHtml. It must be a descendent of the ProductProvider component.

Example code

import {ProductDescription, ProductProvider} from '@shopify/hydrogen';

export function Product({product}) {
  return (
    <ProductProvider value={product}>
      <ProductDescription />
    </ProductProvider>
  );
}

Alias

The ProductDescription component is aliased by Product.Description. You can use whichever component you prefer.

Component type

The ProductDescription component is a client component, which means that it renders on the client. For more information about component types, refer to React Server Components.