Product Highlights

Description

ProductHighlights is a VTEX Component that shows the general specifications 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.

Table of Contents

Usage

You should follow the usage instruction in the main README.

Then, add product-highlights block into your app theme, as we do in our Product Details app.

Now, you can change the behavior of the product-details through blocks. See an example of how to configure:

1
2
3
4
5
6
  "product-details": {
      "blocks": [
        "...",
        "product-highlights"
      ]
    }

Configuration

Through the Storefront, you can change the ProductDescription's behavior and interface. However, you also can make in your theme app, as Store Theme does.

Prop nameTypeDescriptionDefault value
highlightsArray(Highlights)Highlights of a product[]

Highlights:

Prop nameTypeDescription
nameString!Highlights name
valuesArray(String)!Highlights values

Styles API

You should follow the Styles API instruction in the main README.

CSS Namespaces

Below, we describe the namespace that are defined in the ProductHighlights.

Class nameDescriptionComponent Source
highlightContentThe content of ProductHighlights section.index
itemHighlightThe area that wrapper a highlight.index
highlightTitleThe content that contains the highlight's title.index
highlightValueThe content that contains the highlight's value.index