Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.27 KB

ProductDescription.md

File metadata and controls

51 lines (38 loc) · 2.27 KB

Product Description

Description

ProductDescription is a VTEX block that displays the description of a product. This Component can be imported and used by any VTEX App.

📢 Disclaimer: Don't fork this project, use, contribute, or open issue with your feature request.

Configuration

  1. Import the vtex.store-components app to your theme's dependencies in the manifest.json, for example:
  "dependencies": {
    "vtex.store-components": "2.x"
  }
  1. Add the product-description block to any block below store.product(Product template). For example:
  "store.product": {
    "children": [
      "flex-layout.row#product",
    ]
  },
  "flex-layout.row#product": {
    "children": [
      "product-description"
    ]
  }

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

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