A feature-rich jQuery plugin for reading, writing and deleting objects (in cookies, localStorage or sessionStorage) compatible to jquery.cookie

The jquery.cookie.js provides a full backward compatible replacement for jquery.cookie.

Try to merge nearly all ideas from the comunity. If code is incompatible make the idea behind posible. If a problem is solveable one way, remove the other options as noone request them to be back.

* ready to use
* it's a bit bigger then jquery.cookie but it supports a lot more features.
* if want libaries to use webstorage but the hardcoded jquery.cookies then: cookie.defaults.storageType = 'webStorage';
* The getAll-Method is not compatible with the Storage Interface it is supposed to to be changed.
* if you need a stable api you can still rely on the old API
* the new API is "new" so there is still a chance that some things will be changed.

* the file and the project may be seperatet into smaller peaces
* a minimized version is comming soon

Include script after the jQuery library (unless you are packaging scripts somehow else): <script src=“/path/to/jquery.cookie.js”></script>

Don’t use jquery.cookie.js and jquery.storage.js together

If you do not need the old jquery.cookie API you can use the following instead <script src=“/path/to/jquery.storage.js”></script>

Don’t use jquery.cookie.js and jquery.storage.js together

If you need JSON support (for storing objects) load the JSON plugin before

<script src="/path/to/jquery.json.js"></script>

Test to see if cookies are enabled:

$.cookie();

Create session cookie:

$.cookie('the_cookie', 'the_value');

Create expiring cookie, 7 days from then:

$.cookie('the_cookie', 'the_value', { expires: 7 });

Create expiring cookie, valid across entire page:

$.cookie('the_cookie', 'the_value', { expires: 7, path: '/' });

Read cookie:

$.cookie('the_cookie'); // => 'the_value'
$.cookie('not_existing'); // => null

Delete cookie:

$.cookie('the_cookie',null);

Note when clearing cookies, you must pass the exact same options that were used to initially set the cookie.

there are 3 APIs
* The CookieStorage API providing a object to get and set cookies
  var cm = new $.storage.cookieStorage(options);
* The Storage API providing a webStorage with fallback to Cookies, that can only store plain strings
  var cm = $.storage(options);
* The Object Storage API providing a Highlevel API for saving objects by using JSON
  var cm = $.objectStorage.getStorage(options) or new $.objectStorage(storage)

cm.setItem(key,value);
cm.getItem(key);
cm.removeItem(key);

expires: 365

Define lifetime of the cookie. Value can be a Number (which will be interpreted as days from time of creation) or a Date object. If omitted, the cookie is a session cookie.

path: '/'

Default: path of page where the cookie was created.

Define the path where cookie is valid. By default the path of the cookie is the path of the page where the cookie was created (standard browser behavior). If you want to make it available for instance across the entire page use path: '/'. If you want to delete a cookie with a particular path, you need to include that path in the call.

domain: 'example.com'

Default: domain of page where the cookie was created.

secure: true

Default: false. If true, the cookie transmission requires a secure protocol (https).

raw: true

Default: false.

By default the cookie is encoded/decoded when creating/reading, using encodeURIComponent/decodeURIComponent. Turn off by setting raw: true.

• Source hosted at GitHub

• Report issues, questions, feature requests on GitHub Issues

Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change you make.

David Björklund Klaus Hartl (original author)