VTEX Developer Portal

All ContributorsAll Contributors

The Product List component displays all items in the user's cart and informs the user when some of them are unavailable.

:warning: Currently, the Product List only works with the Minicart v2.

product-list imageproduct-list image

Configuration

  1. Add the Product List app to your theme's dependencies in manifest.json. For example:
  "dependencies": {
    "vtex.product-list": "0.x"
  }
  1. Add the product-list block to the minicart-product-list block (exported by the Minicart app). For example:
  "minicart-product-list#example": {
    "blocks": ["product-list"]
  }

Once you added the product-list to the minicart-product-list, no further actions are required, as the block works with a default implementation behind the scenes. In other words, the Product List component is ready to be rendered.

Advanced Configuration

Currently, the product-list default implementation is as follows:

{
  "product-list": {
    "blocks": [
      "product-list-content-desktop",
      "product-list-content-mobile"
    ]
  },
  "product-list-content-desktop": {
    "children": ["flex-layout.row#list-row.desktop"]
  },
  "flex-layout.row#list-row.desktop": {
    "children": [
      "flex-layout.col#image.desktop",
      "flex-layout.col#main-container.desktop"
    ],
    "props": {
      "fullWidth": true,
      "paddingBottom": "7",
      "paddingTop": "6",
      "colSizing": "auto",
      "preserveLayoutOnMobile": "true"
    }
  },
  "flex-layout.col#image.desktop": {
    "children": ["product-list-image"],
    "props": {
      "marginRight": "6"
    }
  },
  "flex-layout.col#main-container.desktop": {
    "children": [
      "flex-layout.row#sub-container.desktop",
      "flex-layout.row#message.desktop"
    ],
    "props": {
      "width": "grow"
    }
  },
  "flex-layout.row#sub-container.desktop": {
    "children": [
      "flex-layout.col#product-description",
      "flex-layout.col#quantity.desktop",
      "flex-layout.row#price-remove"
    ],
    "props": {
      "preserveLayoutOnMobile": "true",
      "colSizing": "auto"
    }
  },
  "flex-layout.col#quantity.desktop": {
    "children": [
      "flex-layout.row#quantity-selector.desktop",
      "flex-layout.row#unit-price.desktop"
    ],
    "props": {
      "marginLeft": "8"
    }
  },
  "flex-layout.row#price-remove": {
    "children": [
      "flex-layout.col#price.desktop",
      "flex-layout.col#remove-button.desktop"
    ],
    "props": {
      "colSizing": "auto"
    }
  },
  "flex-layout.row#quantity-selector.desktop": {
    "children": ["quantity-selector"],
    "props": {
      "preventHorizontalStretch": "true"
    }
  },
  "flex-layout.row#unit-price.desktop": {
    "children": ["unit-price#desktop"],
    "props": {
      "marginTop": "3",
      "preventHorizontalStretch": "true"
    }
  },
  "unit-price#desktop": {
    "props": {
      "textAlign": "center"
    }
  },
  "flex-layout.col#price.desktop": {
    "children": ["price#desktop"],
    "props": {
      "blockClass": "priceWrapper",
      "marginLeft": "6",
      "preventHorizontalStretch": "true",
      "verticalAlign": "middle"
    }
  },
  "price#desktop": {
    "props": {
      "textAlign": "right"
    }
  },
  "flex-layout.col#remove-button.desktop": {
    "children": ["remove-button"],
    "props": {
      "marginLeft": "6",
      "verticalAlign": "middle"
    }
  },
  "flex-layout.row#message.desktop": {
    "children": ["message#desktop"],
    "props": {
      "marginTop": "4"
    }
  },
  "message#desktop": {
    "props": {
      "layout": "cols"
    }
  },
  "product-list-content-mobile": {
    "children": ["flex-layout.row#list-row.mobile"]
  },
  "flex-layout.row#list-row.mobile": {
    "children": [
      "flex-layout.col#image.mobile",
      "flex-layout.col#main-container.mobile"
    ],
    "props": {
      "fullWidth": true,
      "paddingBottom": "6",
      "paddingTop": "5",
      "colSizing": "auto",
      "preserveLayoutOnMobile": "true"
    }
  },
  "flex-layout.col#image.mobile": {
    "children": ["product-list-image"],
    "props": {
      "marginRight": "5"
    }
  },
  "flex-layout.col#main-container.mobile": {
    "children": [
      "flex-layout.row#top.mobile",
      "flex-layout.row#quantity-selector.mobile",
      "flex-layout.row#unit-price.mobile",
      "flex-layout.row#price.mobile",
      "flex-layout.row#message.mobile"
    ],
    "props": {
      "width": "grow"
    }
  },
  "flex-layout.row#top.mobile": {
    "children": [
      "flex-layout.col#product-description",
      "flex-layout.col#remove-button.mobile"
    ],
    "props": {
      "colSizing": "auto",
      "preserveLayoutOnMobile": "true"
    }
  },
  "flex-layout.row#quantity-selector.mobile": {
    "children": ["quantity-selector"],
    "props": {
      "marginTop": "5",
      "preventHorizontalStretch": "true"
    }
  },
  "flex-layout.row#unit-price.mobile": {
    "children": ["unit-price"],
    "props": {
      "marginTop": "3"
    }
  },
  "flex-layout.row#price.mobile": {
    "children": ["price#mobile"],
    "props": {
      "marginTop": "5",
      "preventHorizontalStretch": "true"
    }
  },
  "price#mobile": {
    "props": {
      "textAlign": "left"
    }
  },
  "flex-layout.col#remove-button.mobile": {
    "children": ["remove-button"],
    "props": {
      "marginLeft": "3"
    }
  },
  "flex-layout.row#message.mobile": {
    "children": ["message#mobile"],
    "props": {
      "marginTop": "3"
    }
  },
  "message#mobile": {
    "props": {
      "layout": "rows"
    }
  }
}

By default implementation we mean that whenever you declare the product-list block in your store you're actually telling your theme to render the json above behind the scenes.

Therefore, in order to customize the product-list configuration, you can simply copy the code above, paste it and then change it as you wish.

Block nameDescription
product-listhttps://img.shields.io/badge/-Mandatory-redhttps://img.shields.io/badge/-Mandatory-red Top level block that must be declared in the minicart-product-list block to render a default detailed list with all products added to the shopping cart.
product-list-content-desktopCreates the product list layout for desktop devices.
product-list-content-mobileCreates the product list layout for mobile devices.
messageRenders a message text about the product availability.
product-nameRenders the product names.
product-referenceRenders the product reference information.
priceRenders the product prices.
unit-priceRenders the price for each product unit added to the cart.
product-list-imageRenders the product images.
product-brandRenders the product brands.
product-variationsRenders the product variations.
product-quantity-labelRenders a product label that displays a sua quantidade de unidades added to the cart.
quantity-selectorRenders a selector that allows users to add a chosen number of a product in their cart.
remove-buttonRenders a button that allows users to remove a product from the list.

product-list props

Prop nameTypeDescriptionDefault value
itemCountModeenumQuantity badge behavior when displaying the number of total items added in Minicart. Possible values are: total (quantity badge displays the number of items added to the cart), distinct (quantity badge only displays the number of different products added to the cart), totalAvailable (quantity badge displays the number of available items added to the cart), and distinctAvailable (quantity badge only displays the number of different and available products added to the cart).distinct
lazyRenderHeightnumberThe height (px) of each item's loading element.100
lazyRenderOffsetnumberThe distance (px) to the bottom of the viewport that each item should be at the moment of it's render.300

message props

Prop nameTypeDescriptionDefault value
layoutenumAvailability message position on the list. Possible values are: rows (displaying the message in the product row) or cols (displaying in the product column).cols

price props

Prop nameTypeDescriptionDefault value
textAlignstringProduct price position on the list.left
showListPricebooleanWhether the product prices should be displayed on the list (true) or not (false).true

unit-price props

Prop nameTypeDescriptionDefault value
textAlignstringProduct unit prices position on the list.left
unitPriceTypeenumDefines whether the price type should be displayed. Possible values are: sellingPrice or priceprice
unitPriceDisplayenumDefines when the unit price should be displayed. Possible values are: always (unit price is always displayed) or default (unit price is only displayed when the number of products is greater than one).default
displayUnitListPriceenumDefines whether the product list price should be displayed or not. Possible values are: showWhenDifferent (list price is displayed when it is different from the regular price) ornotShow (list price is never displayed).notShow

product-list-image props

Prop nameTypeDescriptionDefault value
widthnumberProduct image width (in pixels).96

product-reference props

Prop nameTypeDescriptionDefault value
identifierLabelstringText label to be displayed to the left of the product reference value.undefined
identifierOptionenumDesired product reference data i.e. product identifier to be displayed. Possible options are: ProductId, ProductSkuItemId, ProductReferenceId, and ProductSkuReferenceId.ProductReferenceId

remove-button props

Prop nameTypeDescriptionDefault value
variationenumVariation for the button visual proeminence based on the VTEX Styleguide. Possible values are: primary, secondary, tertiary, inverted-tertiary, danger and danger-tertiary.danger
displayModeenumDefines how the remove button should be displayed. Possible values are: icon-button (to render an icon button) and text-button (to render a text message button). If you desire to create a modal in the remove button, use the icon-button value.icon-button

quantity-selector props

Prop nameTypeDescriptionDefault value
modeenumMode of the quantity selector input. Possible values are default and stepper. On the default mode, the quantity stepper will initially render a dropdown component, and after the quantity exceeds 10, it will switch to an input. In the stepper mode it will always render a numeric stepper component.default
showBultAsUnitbooleanShow as unit the quantity of products, this is usefull in the case that the product have unitMultiplier. Possible values are true and false. On the false showBultAsUnit, the quantity will be affected with the unitMultiplier. On the true showBultAsUnit, the quantity will be not affected with the unitMultiplier.false

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
availabilityMessageContainer
availabilityMessageTextContainer
availabilityMessageText
productBrandName
productImageAnchor
productImageContainer
productImage
productListAvailableItemsMessage
productListItem
productListUnavailableItemsMessage
productName
productPriceContainer
productPriceCurrency
productPrice
productQuantityLabel
productIdentifier
productIdentifierValue
productIdentifierLabelValue
productVariationsContainer
productVariationsItem
quantityDropdownContainer
quantityDropdownMobileContainer
quantityInputContainer
quantityInputMobileContainer
quantitySelectorContainer
removeButtonContainer
removeButton
unitPriceContainer
unitListPrice
unitPriceMeasurementUnit
unitPricePerUnitCurrency

Contributors ✨

Thanks goes to these wonderful people:

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

Updated 8 days ago


Product List


Suggested Edits are limited on API Reference Pages

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