Smart Cart: Documentation

flexible and feature rich jQuery plug-in for shopping cart

Getting Started:

Basic Usage:
  $('#SmartCart').smartCart();
Using with option parameters:
$('# SmartCart'). smartCart ({
   selected: 0,  // 0 = produts list, 1 = cart  
   resultName: 'products_selected[]', 
   enableImage: true,
   enableImageTooltip: true,
   enableSearch: true,
   enableCategoryFilter: true,
   productItemTemplate:'<strong><%=pname%></strong><br />Category: <%=pcategory%><br />
                        <small><%=pdesc%></small><br /><strong> 
                        Price: <%=pprice%></strong>',
   cartItemTemplate:'<strong><%=pname%></strong>',

   // Events
   onAdd: null,	     
   onAdded: null,    
   onRemove: null,   
   onRemoved: null,  
   onUpdate: null,   
   onUpdated: null,  
   onCheckout: null 
});
Parameters and Events are describing on the table below

Installing Smart Cart 2.0

Step 1: Include Files

Include the javascript and css files to your page
Files are:
  1. jQuery Library file (Don't include if already have it on your page)
  2. CSS(Style Sheet) file for Smart Cart
  3. Javascript plugin file for Smart Cart

To include the files copy and paste the below lines inside the <head> tag of your page.
Make sure the path to the files are correct with your working enviorment.
  <script type="text/javascript" src="js/jquery-1.3.2.min.js"></script>
  <script type="text/javascript" src="js/jquery.smartCart-2.0.js"></script>
  <link href="styles/smart_cart.css" rel="stylesheet" type="text/css">

Step 2: The JavaScript

Inititialize the Smart Cart, copy and paste the below lines inside the <head> tag of your page
  <script type="text/javascript">
      $(document).ready(function(){  
      	$('#SmartCart').smartCart();
      });
  </script>

Step 3: The HTML

Finally the html, below shows the HTML markup for the Smart Cart,
Copy and paste the below html inside the <body> tag of your page.
  <div id="SmartCart" class="scMain">
    <input type="hidden" pimage="products/product1.jpg" pprice="2299.99" 
    pdesc="" pcategory="Computers" 
    pname="Apple MacBook Pro MA464LL/A 15.4" pid="100">
  
    <input type="hidden" pimage="products/product6.jpg" pprice="2699.99" 
    pdesc=""  pcategory="Computers" 
    pname="Sony VAIO 11.1&quot; Notebook PC" 
    pid="101"> 
    
    <input type="hidden" pimage="products/product3.jpg" 
    pprice="550.00" pdesc="" pcategory="Cameras" 
    pname="Canon Digital Rebel" pid="102">
  </div>
Note that there are some pseudo attributes added and they are used to describes about the product, like product name, price, description etc.

pid : Product ID
pname : Name of the product
pdesc : Description of the product
pprice : Price of the product
pimage : Product image source
pcategory : Category of the product

You can add more product details by adding new attributes to the input element, and so you can show them on product list or cart by editing the template.
You can customize the pseudo attribute names, and configure it on the Attribute Settings section of the plug-in file.

More details & descriptions:

1. How to show more product details on product list / How to customize Template?
  <input type="hidden" pimage="products/product1.jpg" 
  pprice="2299.99" pdesc="The Intel Core Duo." 
  pcategory="Computers" pname="Apple MacBook Pro" pid="100"
  product_sku="SDK334455">

Here added a new pseudo attribute "product_sku".
Describes below is how to apply product list template, and the highlighted part will be replaced with the SKU of specified for corresponding product.

Specify your attribute by wrapping it with <%= and %> on the templates (productItemTemplate, cartItemTemplate) will be replaced with the value of the attribute on the product list or cart when displayed.
Example: <%=YOUR_ATTRIBUTE_NAME%>
  
  var productTemplateWithSKU = '<strong><%=pname%></strong><br />Category: <%=pcategory%>
                                <br /> <small><%=pdesc%></small><br /><strong>
                                Price: <%=pprice%></strong><br />
                                <strong>SKU:  <%=product_sku%></strong>';
  // calling Smart Cart
  $('#SmartCart').smartCart({productItemTemplate: productTemplateWithSKU });  
2. How to enable category filter?

Category filter is an automatic option and you can enable or disable by specifying the Option parameter: enableCategoryFilter to true/false
Also the product category attribute should present the hidden element, if it is empty or null the category filter will be disabled. The category select box is filled automatically by reading the category attribute.

So to enable category filter you have to do only 2 things:
1. Enable it on option parameter enableCategoryFilter : true (true by default).
2. Specify category attribute in the hidden element.
 <input type="hidden" pimage="products/product1.jpg" pprice="2299.99" 
 pdesc="The Intel Core Duo." pcategory="Computers" 
 pname="Apple MacBook Pro" pid="100">

Parameter Description:

Parameter Name Description Values Default Value
selected specify the selected tab 0 = product list
1= cart
0
resultName the name of the request to be passed when submitted
enableImage Enable/Disable Image display on product list and cart true = enabled
false= disabled
true
enableImageTooltip Enable/Disable Image tool tip display on product list and cart true = enabled
false= disabled
true
enableSearch Enable/Disable search for the products on product list true = enabled
false= disabled
true
enableCategoryFilter Enable/Disable category filter for the products on product list. Automatically disables if category attributes are not presents in the hidden elements true = enabled
false= disabled
true
productItemTemplate Template for the product display on product list String
(see details)
<strong><%=pname%></strong><br />
Category: <%=pcategory%><br />

<small><%=pdesc%></small><br />
<strong>Price: <%=pprice%></strong>
cartItemTemplate Template for the product display on cart String
(see details)
<strong><%=pname%></strong>

 
 

Event Description:

Event Name Description Parameters Default
onAdd Triggered immediately when click on add to cart button and just before staring add to cart process. This is a decision making event, based on its function return value (true/false) the product add to cart process can be canceled or continued. Object: object of the hidden element of the product to add.
Quantity: The quantity of the product to add.
null
onAdded Triggered when click on add to cart button but only after finish adding the product to cart. This event doesn't accept return values. Object: object of the hidden element of the product added.
Quantity: The quantity of the product added.
null
onRemove Triggered immediately when a product is about to remove from cart, i.e. when click remove button on cart. This a decision making event, based on its function return value (true/false) the remove process can be canceled on continued. Object: object of the hidden element of the product to remove. null
onRemoved Triggered when the product remove (from cart) process is finished. This event doesn't accept return values. Object: object of the hidden element of the product removed. null
onUpdate Triggered when a product quantity is updated by changing it from cart. This a decision making event, based on its function return value (true/false) the update process can be canceled on continued. Object: object of the hidden element of the product to update.
Quantity: The quantity of the product to update
null
onUpdated Triggered when product quantity is finished updating. This event doesn't accept return values. Object: object of the hidden element of the product updated.
Quantity: The quantity of the product updated.
null
onCheckout Triggered when click on Checkout button on cart. If this even is not specified it will automatically submits the form element available. This event doesn't accept return values. Object: an object of the select element which contains option elements with value as the pair of product_id and quantity delimited with pipe '|' symbol. null

Programmer in PHP and C# with added interest in jQuery, Bootstrap, HTML and CSS. Believes that the code should be as beautiful as the design.

Comments