VTEX Developer Portal

All ContributorsAll Contributors

:information_source: Minicart v1 block has been deprecated in favor of Minicart v2 which can be customized using the blocks defined by Product List and Checkout Summary. If you’re still using the former version, you can find its documentation here: Minicart v1 documentation

The VTEX Minicart is a block that displays a summary list of all items added by customers in their shopping cart. Its data is fetched from the Checkout OrderForm API.

minicart-v2-gifminicart-v2-gif

Configuration

  1. Import the Minicart app to your theme's dependencies in the manifest.json as shown below:
"dependencies": {
  "vtex.minicart": "2.x"
}
  1. Add the minicart.v2 block to your header. For example:
"header.full": {
   "blocks": ["header-layout.desktop", "header-layout.mobile"]
 },

 "header-layout.desktop": {
   "children": [
     "header-row#1-desktop",
   ]
 },

 "header-row#1-desktop": {
   "children": ["minicart.v2"],
 },

:warning: The Minicart v2 will only effectively function if the store uses the Add To Cart Button instead of the Buy Button in blocks such as the Shelf and the Product Details Page. This is because Minicart v2 was built based on an indirect dependency with the Add To Cart button. That means that any other shopping buttons, as the Buy Button, are unable to render Minicart v2, even if it was correctly configured in the code. `

Prop nameTypeDescriptionDefault value
variationenumMinicart behavior when rendered. Possible values are: popup (it pops up on the Homepage in a minitab window), drawer (it is rendered through a sidebar), link (when clicked on, it redirects the user to the Checkout page), popupWithLink (it joins link and popup to work together) and block renders the minicart as a fixed block on the pagedrawer
drawerSlideDirectionenumSlide direction for the drawer Minicart opening. Possible values are: rightToLeft or leftToRight).rightToLeft
linkVariationUrlstringLink associated to the link Minicart.undefined
maxDrawerWidthnumberMaximum width (in pixels) for the drawer Minicart when opened.440
openOnHoverbooleanWhether the popup minicart should open when the user hovers over it.false
quantityDisplayenumShows the quantity badge even when the amount of products in the cart is zero. Possible values are: always or not-empty or never).not-empty
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 (only displays the number of different products added to the cart), totalAvailable (displays the number of available items added to the cart), and distinctAvailable (displays the number of different and available products added to the cart).distinct
backdropModeenumControls whether the backdrop should be displayed when the drawer Minicart is opened or not. Possible values are: visible (rendering the backdrop) or none (rendering the drawer without backdrop).none
MinicartIconblockIcon displayed in the Minicart button. This prop's value must match the name of the block responsible for rendering the desired icon.icon-cart (from Store Icons app)
customPixelEventIdstringStore event ID responsible for triggering the minicart.v2 to automatically open itself on the interface.undefined
customPixelEventNamestringStore event name responsible for triggering the minicart.v2 to automatically open itself on the interface. Some examples are: 'addToCart' and 'removeFromCart'. Notice that using this prop will make the minicart.v2 open in every event with the specified name if no customPixelEventId is specified.undefined
classesCustomCSSClassesUsed to override default CSS handles. To better understand how this prop works, we recommend reading about it here. Note that this is only useful if you're importing this block as a React component.undefined

Advanced Configuration

According to the minicart.v2 composition, it can be highly customizable using other blocks. Currently, its default implementation is as follows:

// This is the default blocks implementation for the minicart-layout
{
  "minicart.v2": {
    "props": {
      "MinicartIcon": "icon-cart#minicart-icon"
    },
    "children": ["minicart-base-content"]
  },
  "icon-cart#minicart-icon": {
    "props": {
      "size": 24
    }
  },
  "minicart-base-content": {
    "blocks": ["minicart-empty-state"],
    "children": ["minicart-product-list", "flex-layout.row#minicart-footer"]
  },
  "flex-layout.row#minicart-footer": {
    "props": {
      "blockClass": "minicart-footer"
    },
    "children": ["flex-layout.col#minicart-footer"]
  },
  "flex-layout.col#minicart-footer": {
    "children": ["minicart-summary", "minicart-checkout-button"]
  },
  "minicart-product-list": {
    "blocks": ["product-list#minicart"]
  },
  "product-list#minicart": {
    "blocks": ["product-list-content-mobile"]
  },
  "minicart-summary": {
    "blocks": ["checkout-summary.compact#minicart"]
  },

  "checkout-summary.compact#minicart": {
    "children": ["summary-totalizers#minicart"],
    "props": {
      "totalizersToShow": ["Items", "Discounts"]
    }
  },
  "summary-totalizers#minicart": {
    "props": {
      "showTotal": true,
      "showDeliveryTotal": false
    }
  },
  "minicart-empty-state": {
    "children": ["flex-layout.row#empty-state"]
  },
  "flex-layout.row#empty-state": {
    "children": ["flex-layout.col#empty-state"]
  },
  "flex-layout.col#empty-state": {
    "children": [
      "icon-cart#minicart-empty-state",
      "rich-text#minicart-default-empty-state"
    ],
    "props": {
      "horizontalAlign": "center",
      "verticalAlign": "middle",
      "rowGap": 5
    }
  },
  "icon-cart#minicart-empty-state": {
    "props": {
      "size": 64,
      "blockClass": "minicart-empty-state"
    }
  },
  "rich-text#minicart-default-empty-state": {
    "props": {
      "text": "Your cart is empty."
    }
  }
}

By default implementation we mean that whenever you use minicart.v2 in your store you're actually using the json above behind the scenes.

Therefore, in order to customize the Minicart configuration, you can simply copy the code above and change it as you wish.

For further information on how to configure each of the blocks used to compose minicart.v2, check out Product List and Checkout Summary.

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
arrowUp
minicartCheckoutButton
minicartContainer
minicartContentContainer
minicartFooter
minicartIconContainer
minicartProductListContainer
minicartQuantityBadge
minicartSideBarContentWrapper
minicartTitle
minicartWrapperContainer
popupChildrenContainer
popupContentContainer
popupWrapper

Contributors

Thanks goes to these wonderful people (emoji key):

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

Updated 9 days ago


Minicart


Suggested Edits are limited on API Reference Pages

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