Collection Badges

Description

Collection Badges is a VTEX component that will render an image with the list of collection badges located at the bottom. 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.

To import it into your code:

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

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

<CollectionBadges collectionBadgesText={[ 'foo', 'bar' ]}>
  <img src="..." alt="...">
</CollectionBadges>

Configuration

Prop nameTypeDescriptionDefault Values
collectionBadgesTextArray(String)!An array of collection badges text[]
childrenNode!Children components that should be rendered inside the collection badge item-

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 CollectionBadges.

Class nameDescriptionComponent Source
collectionContainerThe collection badger main containerindex
itemThe collection badge item main containerindex