Product Summary Buy Button

Description

ProductSummaryBuyButton is a VTEX Component that renders the buy button. This Component can be imported and used by any VTEX App.

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

Table of Contents

Usage

You should follow the usage instruction in the main README.

Then, add product-summary-buy-button block into your app theme, as we do in our Product Summary app.

Blocks API

This component has an interface that describes which rules must be implemented by a block when you want to use the ProductSummaryBuyButton.

1
2
3
  "product-summary-buy-button": {
    "component": "ProductSummaryBuyButton"
  }

Configuration

Through the Storefront, you can change the ProductSummaryBuyButton's behavior and interface. However, you also can make in your theme app.

Prop nameTypeDescriptionDefault value
isOneClickBuyBooleanShould redirect to checkout after clicking on buyfalse
buyButtonTextStringCustom buy button text
displayBuyButtonEnumSet display mode of buy button (displayButtonAlways, displayButtonHover, displayButtonNone)displayButtonAlways

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:
1
2
3
  "builders": {
    "styles": "1.x"
  }
  1. Create a file called vtex.product-summary.css inside the styles/css folder. Add your custom styles:
1
2
3
.buyButtonContainer {
  margin-top: 10px;
}

CSS namespaces

Below, we describe the namespaces that are defined in the menu.

Token nameDescriptionComponent Source
buyButtonContainerThe main container of buy buttonindex
buyButtonClass right before buy buttonindex
isHiddenClass when button is hiddenindex