simple-sync-cart
v1.0.0
Published
A simple JavaScript library for managing and persisting shopping cart state using localStorage or cookies.
Downloads
5
Maintainers
Readme
Simple Cart
Simple Cart is a JavaScript library for synchronizing cart state with localStorage
or cookies. It provides an easy way to manage and persist cart data across sessions.
Features
- Cart Management: Maintain cart state in a centralized object.
- Storage Options: Choose between
localStorage
and cookies for cart persistence. - Cart Operations: Easily add, remove, and clear items from the cart.
- Cross-Session Persistence: Automatically load and save cart state across browser sessions.
Installation
You can install Simple Cart using npm or by including it directly in your project.
Using npm
npm install simple-sync-cart
Using cdn
<script src="path/to/Cart.min.js"></script>
Usage
Basic Example
// Import the library (for module environments)
const Cart = require('simple-sync-cart');
// Initialize Cart
const cart = new Cart({ storage: 'localStorage' });
// Add item to cart
const item = { productId: 1, productName: 'Product A', count: 2, price: 100 };
cart.addToCart(item);
// Remove item from cart
cart.removeFromCart(1);
// Clear cart
cart.clearCart();
Storage Options
const cartLocalStorage = new Cart({ storage: 'localStorage' });
const cartCookie = new Cart({ storage: 'cookie' });
API
new Cart(options)
#options.storage (string): The type of storage to use (localStorage or cookie).
cart.addToCart(item)
#item (object): The item to add to the cart. Should include productId, productName, count, and price.
cart.removeFromCart(productId)
#productId (number): The ID of the product to remove from the cart.
cart.clearCart()
#Clears all items from the cart.
License
This project is licensed under the MIT License. See the LICENSE file for more details.