Product Summary Description

Description

ProductSummaryDescription is a VTEX Component that renders the product's description. 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.

Table of Contents

Usage

You should follow the usage instruction in the main README.

Then, add product-summary-description block into your app theme, as we do in our Product Summary app.

Blocks API

This component has an interface that describes which rules must be implemented by a block when you want to use the ProductSummaryDescription.

  "product-summary-description": {
    "component": "ProductSummaryDescription"
  }

Configuration

Through the Storefront, you can change the ProductSummaryDescription's behavior and interface. However, you also can make in your theme app.

Styles API

This app provides some CSS classes as an API for style customization.

To use this CSS API, you must add the styles builder and create an app styling CSS file.

  1. Add the styles builder to your manifest.json:
  "builders": {
    "styles": "1.x"
  }
  1. Create a file called vtex.product-summary.css inside the styles/css folder. Add your custom styles:
.description {
  margin-top: 10px;
}

CSS Handles

CSS HandlesDescriptionComponent Source
descriptionThe main container of descriptionindex