Skip to content

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

Notifications You must be signed in to change notification settings

tomkins/jquery-cookie

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

jquery.cookie

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

Installation

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

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

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 page:

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

Read cookie:

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

Delete cookie by passing null as value:

$.cookie('the_cookie', null);

Note: when deleting a cookie, you must pass the exact same path, domain and secure options that were used to set the cookie.

Options

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: '/'.

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.

Changelog

Development

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

Authors

Klaus Hartl

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%