VTEX Developer Portal

All ContributorsAll Contributors

The Product Quantity allows users to a add a chosen amount of the displayed product in their cart.

product-quantityproduct-quantity

Configuration

  1. Add the Product Quantity app to your dependencies in the theme's manifest.json file:
  "dependencies": {
    "vtex.product-quantity": "1.x"
  }

You are now able to use all blocks that are exported by the Product Quantity app. Check out the full list below:

Block nameDescription
product-quantityDisplays a quantity selector on the product details page. This block must be declared in the theme's store.product page template.
product-summary-quantityDisplays a quantity selector on Product Summary's blocks. This block must be declared as a children of the product-summary.shelf block.
  1. According to your desired scenario, add the product-quantity/product-summary-quantity blocks to your theme. For example:
  "flex-layout.col#product-price": {
    "props": {
      "preventVerticalStretch": true,
      "rowGap": 0
    },
    "children": [
      "product-name",
      "product-price#product-details",
      "product-separator",
+     "product-quantity",
      "sku-selector",
      "flex-layout.row#buy-button",
      "availability-subscriber",
      "shipping-simulator",
      "share"
    ]
  },
  "product-quantity": {
    "props": {
      "warningQuantityThreshold": 9999999,
      "showUnit": true
    }
  },

In the example above a Product Details Page is built using Flex Layout and the product-quantity block.

product-quantity and product-summary-quantity props

Prop nameTypeDescriptionDefault Value
warningQuantityThresholdnumberDisplays the quantity of remaining items in stock if the available quantity is less than or equal to the value given to this property.0 (the quantity is not displayed)
showUnitbooleanWhether the unit of measurement should be displayed (true) or not (false).true
sizeenumPreset size values for font-size and padding. You can check these value measures by accessing the VTEX Styleguide. Possible values are: small, regular, and large.small
showLabelbooleanWhether a label should be displayed (true) or not (false).true
selectorTypeenumDefines how the quantity selector should initially behave. Possible values are: stepper (displays an input field where the quantity can be directly defined, in addition to side buttons to increase or decrease the value) and dropdown (shows a list of predefined-quantity options. In case the last quantity option is selected by users, the component is replaced with an input).stepper
quantitySelectorStepenumDefines how the number of products that have unitMultiplier will works. Possible values are: singleUnit (the quantity will be not affected with the unitMultiplier) and unitMultiplier (the quantity will be affected with the unitMultiplier).unitMultiplier

Customization

In order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on Using CSS Handles for store customization.

CSS Handles
availableQuantityContainer
quantitySelectorContainer
quantitySelectorDropdownContainer
quantitySelectorDropdownMobileContainer
quantitySelectorInputContainer
quantitySelectorInputMobileContainer
quantitySelectorStepper
quantitySelectorTitle
summaryContainer

Contributors ✨

Thanks goes to these wonderful people:

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

Updated 2 months ago


Product Quantity


Suggested Edits are limited on API Reference Pages

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