Migrating from jquery-cookie

JavaScript Cookie 1.x internal behavior is totally backward compatible with jquery-cookie.
To start migrating from jquery-cookie to JavaScript Cookie, just rename the API accordingly:

$.cookie('name', 'value') === Cookies.set('name', 'value')
$.cookie('name') === Cookies.get('name')
$.removeCookie('name') === Cookies.remove('name')
$.cookie() === Cookies.get()

JavaScript Cookie

A simple, lightweight JavaScript API for handling cookies

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

Build Status Matrix

Installation

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

<script src="/path/to/js.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:

Cookies.set('name', 'value');

Create expiring cookie, 7 days from then:

Cookies.set('name', 'value', { expires: 7 });

Create expiring cookie, valid across entire site:

Cookies.set('name', 'value', { expires: 7, path: '/' });

Read cookie:

Cookies.get('name'); // => "value"
Cookies.get('nothing'); // => undefined

Read all available cookies:

Cookies.get(); // => { "name": "value" }

Delete cookie:

// Returns true when cookie was successfully deleted, otherwise false
Cookies.remove('name'); // => true
Cookies.remove('nothing'); // => false

// Need to use the same attributes (path, domain) as what the cookie was written with
Cookies.set('name', 'value', { path: '/' });
// This won't work!
Cookies.remove('name'); // => false
// This will work!
Cookies.remove('name', { path: '/' }); // => true

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.

Avoid namespace conflicts:

// Restore the Cookies namespace to its original value
var NewCookies = Cookies.noConflict();
NewCookies.set('name', 'value');

If there is any danger of a conflict with the namespace Cookies, the .noConflict method will allow you define a new namespace and preserve the original namespace.

This is especially useful when running the script on third party sites e.g. as part of a widget or SDK.

Configuration

raw

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

Cookies.raw = true;

json

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

Cookies.json = true;

Cookie Options

Cookie attributes can be set globally by setting properties of the Cookies.defaults object or individually for each call to Cookies.set() 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:

Cookies.set('foo', '42');
Cookies.get('foo', Number); // => 42

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

Cookies.raw = true;
Cookies.get('foo', unescape);

You can pass an arbitrary conversion function.

Contributing

Check out the Contributing Guidelines

Manual release steps

• Remove the "-pre" suffix of the "version" attribute of bower.json, package.json and component.json
• Remove the "-pre" suffix of the version number in the CHANGELOG.md and src/js.cookie.js files
• Commit with the message "Release version x.x.x"
• Create version tag in git
• Create a github release and upload the minified file
• Release on npm
• Increment and add the "-pre" suffix to the "version" attribute of bower.json, package.json and component.json
• Increment and add the "-pre" suffix to the version number in the CHANGELOG.md and src/js.cookie.js files
• Link the documentation of the latest release tag in the README.md
• Commit with the message "Prepare for the next development iteration"

Authors

Klaus Hartl