️ Warning

The Buy Button block has been deprecated in favor of the Add To Cart Button app. Although support for this block is still granted, we strongly recommend you to update your store theme with the Add to Cart Button's blocks in order to keep up with the component's evolution.

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

The buy-button block displays a button that allows users to add products in the Minicart (minicart.v1).

️ Warning

The Buy Button block only works for stores using the Minicart v1. If your store uses the Minicart v2, please refer to the Add To Cart Button instead.

imageimage

Configuration

  1. Import the vtex.store-components app to your theme's dependencies in the manifest.json file as in the following example:
  "dependencies": {
+   "vtex.store-components": "3.x"
  }
  1. Add the buy-button to other theme block using the product context, such as the product-summary.shelf. In the following example, the buy-button component was added to the flex-layout.row block from the store.product template (which uses the product context):
  "store.product": {
    "children": [
      "flex-layout.row#product",
    ]
  },
  "flex-layout.row#product": {
    "children": [
+      "buy-button#product"
    ]
  },
  1. Then, declare the buy-button block using the props stated in the Props table. For example:
  "buy-button#product": {
    "props": {
      "isOneClickBuy": true,
      "showTooltipOnSkuNotSelected": false
    }
  },

Props

Prop nameTypeDescriptionDefault value
availablebooleanWhether the Buy Button block is available for using (true) or not (false).true
customToastURLstringDefines the link to where users will be redirected when the Buy Button is clicked on and the isOneClickBuy prop is set to true./checkout/#/cart
isOneClickBuybooleanWhether the user should be redirected to the checkout page (true) or not (false) when the Add To Cart Button is clicked on.false
largebooleanWhether the Buy Button should fill its whole width (true) or not (false).false
shouldOpenMinicartbooleanWhether the Minicart should be opened when the Buy Button is clicked on (true) or not (false).false
shouldAddToCartbooleanWhether the Buy Button should add products to the minicart when clicked on (true) or not (false).true
showItemsPricebooleanWhether the total price of items added to the cart should be displayed (true) or not (false).false
showToastbooleanWhether a Toast (pop-up notification) should be displayed when adding an item to the minicart (true) or not (false)false
showTooltipOnSkuNotSelectedbooleanWhether a tooltip should be displayed when the Buy Button is clicked on with no SKU was selected (true) or not (false).true

Customization

To apply CSS customizations in this and other blocks, follow the Using CSS handles for store customization guide.

CSS Handles
buttonDataContainer
buttonItemsPrice
buyButtonText

Did this page help you?