Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/discolabs/cartjs
A Javascript library to power cart management for Shopify themes.
https://github.com/discolabs/cartjs
rivets shopify shopify-theme
Last synced: 3 days ago
JSON representation
A Javascript library to power cart management for Shopify themes.
- Host: GitHub
- URL: https://github.com/discolabs/cartjs
- Owner: discolabs
- License: mit
- Created: 2014-06-13T09:56:25.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2023-10-19T12:37:46.000Z (about 1 year ago)
- Last Synced: 2024-12-20T16:10:49.498Z (11 days ago)
- Topics: rivets, shopify, shopify-theme
- Language: CoffeeScript
- Homepage: https://cartjs.org
- Size: 3.38 MB
- Stars: 481
- Watchers: 29
- Forks: 86
- Open Issues: 47
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/shopify-cartjs)
[](https://badge.fury.io/bo/shopify-cartjs)
# Cart.js
Cart.js is a Javascript library that makes it easy to add dynamic cart features
to Shopify themes.
It abstracts away the difficult parts of working with Shopify's AJAX API and
provides a simple, consistent interface to manipulating a customer's cart.
Without having to worry about the quirks in Shopify's endpoints or about making
all of your requests synchronous, you can just write code like this:
```js
function example() {
// Clear the existing cart.
CartJS.clear();
// Add 3x "12345678" items, with a custom "size" property of "XL".
CartJS.addItem(12345678, 3, {
"size": "XL"
});
// Add multiple items in a single call.
CartJS.addItems([
{
id: 12345678,
quantity: 3,
properties: {
"size": "XL"
}
},
{
id: 87654321,
quantity: 2
}
]);
// Set a custom cart note.
CartJS.setNote('This is a custom cart note.');
}
```
Neat, huh? But that's just the beginning.
Cart.js bundles two powerful optional modules that make it even easier to build
dynamic carts into your themes:
### Data API Module
Lets you use simple `data-*` markup attributes to hook in to Cart.js methods,
without having to write *any* Javascript yourself.
For example, to create a button that added a particular product to your cart,
all that's required is:
```html
Add Product
```
### DOM Binding Module
In combination with [Rivets.js][], the DOM Binding module lets you write HTML
templates in your `.liquid` files that are re-rendered dynamically when the
contents of your cart change, like this:
```html
You currently have {cart.item_count} item(s) in your cart, for a total of {cart.total_price | money_with_currency}.
```
## Getting Started and Documentation
Documentation and examples are available on the [home page][].
You can check out a list of who's using Cart.js in production on the
[Built with Cart.js][] page.
[home page]: https://cartjs.org?utm_source=github&utm_medium=readme&utm_campaign=cartjs
[Built with Cart.js]: https://cartjs.org/pages/built-with-cart-js
## Dependencies
Cart.js currently depends on [jQuery][] for its AJAX helpers, custom event
bindings and utility methods. This usually isn't a problem as most Shopify
themes ship with jQuery.
[Rivets.js] is required if you want to use the DOM Binding module. The
distribution of Cart.js includes a minified asset (`rivets-cart.min.js`) which
contains both the Cart.js library and a bundled version of Rivets.js.
[Rivets.js]: http://rivetsjs.com
[jQuery]: http://jquery.com
## Release History
Refer to the [change log](https://github.com/discolabs/cartjs/blob/master/CHANGELOG.md)
for a full list of changes.
## Contributions
Contributions are very much welcome! Read our [contribution guidelines][] for
details on submitting pull requests that will be accepted.
[contribution guidelines]: https://github.com/discolabs/cartjs/blob/master/CONTRIBUTING.md
---
#### About the Author
[Gavin Ballard][] is the founder, CEO, and occasional developer at [Disco Labs][],
a Shopify Plus partner agency specialising in solutions for merchants with complex
needs.
[Gavin Ballard]: http://gavinballard.com/?utm_source=github&utm_medium=readme&utm_campaign=cartjs
[Disco Labs]: https://www.discolabs.com/?utm_source=github&utm_medium=readme&utm_campaign=cartjs
#### Thanks
Thanks to the following people who have contributed their time and code to Cart.js!
* [Michaël Gallego](https://github.com/bakura10)
* [Michael Shannon](https://github.com/michaelrshannon)
* [Stewart Knapman](https://github.com/stewartknapman)
* [Jonathan Moore](https://github.com/jonathanmoore)
* [Ty Carlson](https://github.com/tywayne)