https://img.shields.io/badge/-Deprecated-redhttps://img.shields.io/badge/-Deprecated-red

⚠️

Warning

The Discount Badge block has been deprecated in favor of the Product Price app. Although support for this block is still granted, we strongly recommend you to update your store theme with the Product Price's blocks in order to keep up with the component's evolution.

Discount Badge is a VTEX component that shows a discount of a product. This component can be imported and used by any VTEX App.

Usage

You should follow the usage instruction in the main README.

To import it into your code:

import { DiscountBadge } from 'vtex.store-components'

You can use it in your code like a React component with the jsx tag: <DiscountBadge />.

<DiscountBadge listPrice={commertialOffer.ListPrice}
                sellingPrice={commertialOffer.Price}
                label={badgeText}>
  <img src="" alt="">
</DiscountBadge>

Configuration

Prop nameTypeDescription
listPriceNumber!Product's default price
sellingPriceNumber!Product's price with discount
labelStringLabel to track the discount percent
childrenNode!Element where the badge is displayed

Styles API

This app provides some CSS classes as an API for style customization. You should follow the Styles API instruction in the main README.

CSS namespaces

Below, we describe the namespaces that are defined in the DiscountBadge.

Class nameDescriptionComponent Source
discountContainerThe discount containerindex
discountInsideContainerThe discount inner containerindex

Did this page help you?