https://github.com/pixelunion/bc-quick-shop
https://github.com/pixelunion/bc-quick-shop
library
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/pixelunion/bc-quick-shop
- Owner: pixelunion
- License: mit
- Created: 2018-05-08T18:40:31.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-05-21T15:36:51.000Z (about 5 years ago)
- Last Synced: 2025-03-29T08:17:27.556Z (over 1 year ago)
- Topics: library
- Language: JavaScript
- Size: 14.6 KB
- Stars: 0
- Watchers: 18
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# BigCommerce Quick Shop Module
### Installation
```
npm i --save github:pixelunion/bc-quick-shop
```
### Usage
```
import $ from 'jquery';
import QuickShop from 'bc-quick-shop';
if ($('.quick-shop-trigger').length) {
new QuickShop({
el: $('.quick-shop-wrapper'),
template: 'products/quick-shop'
});
}
```
### Options
**template:** Template in which to render quick shop content.
**quickShop:** Selector for quick shop wrapper child (secondary wrapper).
**quickShopTrigger:** Selector for quick shop trigger.
**quickShopClose:** Optional. Selector for close button. Must be placed within the **quickShop** element.
**productOptions:** Selector for product options wrapper.
**bodyOverflowClass:** Class that toggles body overflow hidden (e.g., 'scroll-locked').
**onProductAdd:** Optional. Callback fired when add to cart button is clicked.
**afterProductAdd:** Optional. Callback fired after BC api responds to add to cart button being clicked.
**onOptionChange:** Optional. Callback fired when an option is changed.