- Overview
- Documents
jQuery Cookie is a simple, lightweight jQuery plugin for reading, writing and deleting cookies.
Build Status Matrix
Source: github.com
1. INCLUDE JS FILES
<script src="http://code.jquery.com/jquery-1.11.1.min.js"></script> <script src="/path/to/jquery.cookie.js"></script>
2. JAVASCRIPT
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 site:
$.cookie('the_cookie', 'the_value', { expires: 7, path: '/' });
Read cookie:
$.cookie('the_cookie'); // => "the_value" $.cookie('not_existing'); // => undefined
Read all available cookies:
$.cookie(); // => { "the_cookie": "the_value", "...remaining": "cookies" }
Delete cookie:
// Returns true when cookie was found, false when no cookie was found... $.removeCookie('the_cookie'); // Same path as when the cookie was written... $.removeCookie('the_cookie', { path: '/' });
Note: when deleting a cookie, you must pass the exact same path, domain and secure options that were used to set the cookie, unless you're relying on the default options that is.
3. OPTIONS
Cookie attributes can be set globally by setting properties of the $.cookie.defaults object or individually for each call to $.cookie() by passing a plain object to the options argument. Per-call options override the default options.
expires: 365
Define lifetime of the cookie. Value can be a Number which will be interpreted as days from time of creation or aDate object. If omitted, the cookie becomes a session cookie.
path: '/'
Define the path where the 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 domain use path: '/'. Default: path of page where the cookie was created.
domain
domain: 'example.com'
Define the domain where the cookie is valid. Default: domain of page where the cookie was created.
secure: true
If true, the cookie transmission requires a secure protocol (https). Default: false.
4. CONFIGURATION
raw
By default the cookie value is encoded/decoded when writing/reading, usingencodeURIComponent/decodeURIComponent. Bypass this by setting raw to true:
$.cookie.raw = true;
Turn on automatic storage of JSON objects passed as the cookie value. Assumes JSON.stringify andJSON.parse:
$.cookie.json = true;