The zebra_cookie from osub

osub / zebra_cookie Goto Github PK

View Code? Open in Web Editor NEW

An extremely small (~500 bytes minified) jQuery plugin for writing, reading and deleting cookies.

License: GNU Lesser General Public License v3.0

zebra_cookie's Introduction

Zebra_Cookie

####An extremely small (~500 bytes minified) jQuery plugin for writing, reading and deleting cookies.

##Features

easily write, read and delete cookies
very simple and intuitive syntax, blending perfectly with jQuery
extremely small: with around 500 bytes when minified is probably the smallest and most optimized jQuery plugin for handling cookies

##Requirements

Zebra_Cookie requires jQuery 1.0+

##How to use First, load the latest version of jQuery from a CDN and provide a fallback to a local source, like:

<script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
<script>window.jQuery || document.write('<script src="public/javascript/jquery-1.9.1.js"><\/script>')</script>

Load the Zebra_Cookie plugin

<script type="text/javascript" src="path/to/zebra_cookie.js"></script>

Usage

// inside the DOM-ready function
// a "cookie" object will be available in jQuery’s namespace
// the object exposes 3 methods that you can use to write, read and delete cookies
$(document).ready(function() {

    // create a session cookie (expires when the browser closes)
    $.cookie.write('cookie_name', 'cookie_value');

    // create a cookie that expires in 1 day
    $.cookie.write('cookie_name', 'cookie_value', 24 * 60 * 60);

    // read a cookie’s value
    // following the examples above, this should return "cookie_value"
    $.cookie.read('cookie_name');

    // the "read" method returns null if the cookie doesn’t exist
    $.cookie.read('non_existing_cookie_name');

    // delete the cookie
    $.cookie.destroy('cookie_name');

});