jquery.cookie

A simple, lightweight jQuery plugin for reading, writing and deleting cookies.

If you're viewing this at https://github.com/carhartl/jquery-cookie, you're reading the documentation for the master branch. View documentation for the latest release (1.4.1).

Build Status Matrix

Installation

Include script after the jQuery library (unless you are packaging scripts somehow else):

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

Do not include the script directly from GitHub (http://raw.github.com/...). The file is being served as text/plain and as such being blocked in Internet Explorer on Windows 7 for instance (because of the wrong MIME type). Bottom line: GitHub is not a CDN.

The plugin can also be loaded as AMD or CommonJS module.

Usage

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.

Configuration

raw

By default the cookie value is encoded/decoded when writing/reading, using encodeURIComponent/decodeURIComponent. Bypass this by setting raw to true:

$.cookie.raw = true;

json

Turn on automatic storage of JSON objects passed as the cookie value. Assumes JSON.stringify and JSON.parse:

$.cookie.json = true;

Cookie 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

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 becomes a session cookie.

path

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.

Note regarding Internet Explorer:

Due to an obscure bug in the underlying WinINET InternetGetCookie implementation, IE’s document.cookie will not return a cookie if it was set with a path attribute containing a filename.

(From Internet Explorer Cookie Internals (FAQ))

This means one cannot set a path using path: window.location.pathname in case such pathname contains a filename like so: /check.html (or at least, such cookie cannot be read correctly).

domain

domain: 'example.com'

Define the domain where the cookie is valid. Default: domain of page where the cookie was created.

secure

secure: true

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

Converters

Provide a conversion function as optional last argument for reading, in order to change the cookie's value to a different representation on the fly.

Example for parsing a value into a number:

$.cookie('foo', '42');
$.cookie('foo', Number); // => 42

Dealing with cookies that have been encoded using escape (3rd party cookies):

$.cookie.raw = true;
$.cookie('foo', unescape);

You can pass an arbitrary conversion function.

Contributing

Check out the Contributing Guidelines

Authors

Klaus Hartl

HEAD

1.4.1

• Added support for CommonJS.

• Added support for package managers: Jam (http://jamjs.org), volo (http://volojs.org), Component (http://component.io), jspm (http://jspm.io).

• The expires option now interpretes fractions of numbers (e.g. days) correctly.

1.4.0

• Support for AMD.

• Removed deprecated method $.cookie('name', null) for deleting a cookie, use $.removeCookie('name').

• $.cookie('name') now returns undefined in case such cookie does not exist (was null). Because the return value is still falsy, testing for existence of a cookie like if ( $.cookie('foo') ) keeps working without change.

• Renamed bower package definition (component.json -> bower.json) for usage with up-to-date bower.

• Badly encoded cookies no longer throw exception upon reading but do return undefined (similar to how we handle JSON parse errors with json = true).

• Added conversion function as optional last argument for reading, so that values can be changed to a different representation easily on the fly. Useful for parsing numbers for instance:

  $.cookie('foo', '42');
  $.cookie('foo', Number); // => 42

1.3.1

• Fixed issue where it was no longer possible to check for an arbitrary cookie, while json is set to true, there was a SyntaxError thrown from JSON.parse.

• Fixed issue where RFC 2068 decoded cookies were not properly read.

1.3.0

• Configuration options: raw, json. Replaces raw option, becomes config:

  $.cookie.raw = true; // bypass encoding/decoding the cookie value
  $.cookie.json = true; // automatically JSON stringify/parse value

  Thus the default options now cleanly contain cookie attributes only.

• Removing licensing under GPL Version 2, the plugin is now released under MIT License only (keeping it simple and following the jQuery library itself here).

• Bugfix: Properly handle RFC 2068 quoted cookie values.

• Added component.json for bower.

• Added jQuery plugin package manifest.

• $.cookie() returns all available cookies.

1.2.0

• Adding $.removeCookie('foo') for deleting a cookie, using $.cookie('foo', null) is now deprecated.

1.1

• Adding default options.