VTEX Developer Portal

VTEX Product Kit

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

*The Product Kit app has been deprecated. Although support for this app is still granted by VTEX, we strongly recommend you to update your store theme in order to keep up with the framework's evolution!*

All ContributorsAll Contributors

Description

The VTEX product kit app shows two or more products as a kit. Usually these products are sold together and offer a discount. This app is used by store theme.

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

Release schedule

ReleaseStatusInitial ReleaseMaintenance LTS StartEnd-of-lifeStore Compatibility
[1.x]Current Release2018-11-052.x
[0.x]Maintenance LTS2018-07-062018-11-05March 20191.x

See our LTS policy for more information.

Table of Contents

Usage

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

We add the product-kit as a block in our Store.

To configure or customize this app, you need to import it in your dependencies in manifest.json.

  dependencies: {
    "vtex.product-kit": "1.x"
  }

Then, add product-kit block into our app theme as we do in our Store theme app.

Now, you can change the behavior of the product-kit block. See an example of how to configure:

"product-kit": {
    "blocks": [
      "product-summary"
    ],
    "props":{
      "showArrows": true,
      "nextArrow": "next",
      "prevArrow": "prev",
      "showDots": true,
      "dots": "dots",
      "showListPrice": true,
      "showLabel": true,
      "showInstallments": true,
      "showBadge": true,
      "badgeText": "badge",
      "showCollections": true,
      "allowSwap": true,
      "allowRemoval": true,
    }
  }

Blocks API

This app has an interface that describes what rules must be implemented by a block when you want to use the product kit.

  "product-kit": {
    "required": [
      "product-summary"
    ],
    "component": "index"
  }
}

The product kit has as a required block the product-summary. So, any product kit block implementation created must add a product-summary as a block that is inside of product kit. (Similarly, product-summary has its own inner block structure that can be configured. There is a link to its API in the next section.)

Configuration

Through the Storefront you can change the behavior and interface of ProductKit. But, you can also make adjusts in your theme app, like Store does.

Prop nameTypeDescriptionDefault Value
showArrowsBooleanShow or not the arrowstrue
nextArrowStringNext arrow icon''
prevArrowStringPrevious arrow icon''
showDotsBooleanShow or not the slider dotstrue
dotsStringSlider dots icon''
showListPriceBooleanShow or not the list pricetrue
showLabelsBooleanShow or not the labels "from" and "to"false
showInstallmentsBooleanShow or not the installmentsfalse
showBadgeBooleanShow or not the discount badgefalse
badgeTextStringText of the discount badgeBadge Text/Texto de badge/Texto da badge
showCollectionsBooleanShow or not the collections badgestrue
allowSwapBooleanAllow or not the item swaptrue
allowRemovalBooleanAllow or not the item removaltrue

Also, you can configure the product summary that is defined on product-kit. See here the Product Summary API.

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-kit.css inside the styles/css folder. Add your custom styles:
.container {
  margin-top: 10px;
}

CSS namespaces

Below, we describe the namespaces that are define in the ProductKit.

Class nameDescriptionComponent Source
containerA wrapper that envolves all the elements of the product kit, responsible for the main margins and paddingsProductKitContent
listContainerThe container for the products and final pricesindex
listDetailsThe container for the total price of the kitListDetails
itemThe container of one productProductKitItem

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.

Tests

To execute our tests go to react/ folder and run yarn test

Travis CI

Build StatusBuild Status
Coverage StatusCoverage Status

Contributors ✨

Thanks goes to these wonderful people (emoji key):

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

Updated 8 months ago


VTEX Product Kit


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.