📢 Use this project, contribute to it or open issues to help evolve it.

Shelf Components

VTEX Shelf Components is a collection of components that can be used to create shelves in your store, which are responsible for displaying a list of products.

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

Table of Contents

• Usage
  • Styles API
• Components Specs
• Troubleshooting
• Contributing

Usage

This app uses our store builder with the blocks architecture. To know more about Store Builder click here.

To use this app, you need to import in your dependencies on manifest.json.

  "dependencies": {
    "vtex.shelf-components": "0.x"
  }

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"
  }

2. Create a file called vtex.shelf-components.css inside the styles/css folder. Add your custom styles:

.container {
  margin-top: 10px;
}

Components Specs

Below we have a README for each component of this project that explains how to use them.

• Shelf
• Refresh Shelf

Troubleshooting

You can check if others are passing through similar issues here. Also feel free to open issues or contribute with pull requests.

Contributing

Check it out how to contribute with this project.

Contributors

Thanks goes to these wonderful people (emoji key):

Pierre Grimaud 📖

This project follows the all-contributors specification. Contributions of any kind welcome!