@nichoth/shopping-cart
v1.0.1
Published
shopping cart thing
Downloads
89
Readme
shopping cart
A shopping cart UI widget
Uses preact
install
npm i -S @nichoth/shopping-cart
A browserified bundle is in /dist
. Or you would import src/cart
if you are bundling these prior to use.
example
With import
import Cart from '@nichoth/shopping-cart'
import EVENTS from '@nichoth/shopping-cart/src/EVENTS'
// args are optional
var cart = new Cart({
storage: true // store the state in localStorage?
key: 'cart' // default is 'cart'
})
// `cart` is an event emitter
cart.on(EVENTS.quantity.change, ev => {
console.log('quantity', ev.quantity)
console.log('index', ev.index)
})
cart.on(EVENTS.cart.remove, index => {
console.log('index of the removed item', index)
})
cart.on(EVENTS.product.change, (index, updatedProduct) => {
console.log('product change', updatedProduct)
})
// pass in an element to mount it at
// or it will automatically mount to the given ID
// for any product, if the `quantity` is greater than the
// `quantityAvaileble`, the icon will render as an exclamation point
cart.createIcon(document.getElementById('shopping-cart-icon'), {
link: '/my-cart'
})
cart.createPage(document.getElementById('shopping-cart-page'), mapper)
function mapper (html, product) { // `html` here is from 'htm' on npm
console.log('in map', product)
return html`
<span>name: ${product.name || 'none'}, </span>
<span>price: ${product.price || 'none'}<//>
`
}
var products = cart.products()
cart.remove(1) // remove the product at index 1
cart.empty() // remove everything in the cart
// add something
// icon and page in the UI will auto update
// index is for the item that was added
// default quantity of 1 will be added if no quantity key is present
var index = cart.add({ name: 'my product', quantity: 1, price: 10 }) {
// index of item & desired quantity
// returns itself for chaining
// will emit EvENTS.quantity.change
cart = cart.changeQuantity(0, 2) {
// will emit EVENTS.product.change (index, updatedProduct)
cart = cart.update(0, { quantityAvailable: 4 })
// -----------------------------------------------------------
// get the cart state
var state = cart.state()
var { products } = state
Without importing
<script src="/path/to/cart/dist/bundle.js"></script>
<script>
var cart = new window.Cart({})
cart.createIcon(document.getElementById('shopping-cart-icon'), {
link: '/my-shopping-cart'
})
cart.createPage(document.getElementById('shopping-cart-page'))
</script>
develop
Start a local dev server
npm start