This page is about version 3.151.2 of the app, which is not the most recent version. The latest stable version is 3.178.2.
Description
ProductDescription
is a VTEX block that displays the description of a product.
This Component can be imported and used by any VTEX App.
:loudspeaker: Disclaimer: Don't fork this project, use, contribute, or open issue with your feature request.
Configuration
- Import the
vtex.store-components
app to your theme's dependencies in themanifest.json
, for example:
_10 "dependencies": {_10 "vtex.store-components": "2.x"_10 }
- Add the
product-description
block to any block belowstore.product
(Product template). For example:
_10 "store.product": {_10 "children": [_10 "flex-layout.row#product",_10 ]_10 },_10 "flex-layout.row#product": {_10 "children": [_10 "product-description"_10 ]_10 }
Configuration
Prop name | Type | Description | Default |
---|---|---|---|
collapseContent | Boolean | If true, whenever the product description is too big, it will collapse and show a "Show More" button. When false, it will never collapse and will always show the whole description. | true |
title | string | Defines a custom title for the description section. | undefined |
classes | CustomCSSClasses | Used to override default CSS handles. To better understand how this prop works, we recommend reading about it here. Note that this is only useful if you're using this block as a React component. | undefined |
showTitle | boolean | Define whether or not to show the title. | true |
Customization
In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on Using CSS Handles for store customization.
CSS Handles |
---|
productDescriptionContainer |
productDescriptionTitle |
productDescriptionText |