4 * Copyright (c) 2006 Klaus Hartl (stilbuero.de)
5 * Dual licensed under the MIT and GPL licenses:
6 * http://www.opensource.org/licenses/mit-license.php
7 * http://www.gnu.org/licenses/gpl.html
12 * Create a cookie with the given name and value and other optional parameters.
14 * @example $.cookie('the_cookie', 'the_value');
15 * @desc Set the value of a cookie.
16 * @example $.cookie('the_cookie', 'the_value', { expires: 7, path: '/', domain: 'jquery.com', secure: true });
17 * @desc Create a cookie with all available options.
18 * @example $.cookie('the_cookie', 'the_value');
19 * @desc Create a session cookie.
20 * @example $.cookie('the_cookie', null);
21 * @desc Delete a cookie by passing null as value. Keep in mind that you have to use the same path and domain
22 * used when the cookie was set.
24 * @param String name The name of the cookie.
25 * @param String value The value of the cookie.
26 * @param Object options An object literal containing key/value pairs to provide optional cookie attributes.
27 * @option Number|Date expires Either an integer specifying the expiration date from now on in days or a Date object.
28 * If a negative value is specified (e.g. a date in the past), the cookie will be deleted.
29 * If set to null or omitted, the cookie will be a session cookie and will not be retained
30 * when the the browser exits.
31 * @option String path The value of the path atribute of the cookie (default: path of page that created the cookie).
32 * @option String domain The value of the domain attribute of the cookie (default: domain of page that created the cookie).
33 * @option Boolean secure If true, the secure attribute of the cookie will be set and the cookie transmission will
34 * require a secure protocol (like HTTPS).
39 * @author Klaus Hartl/klaus.hartl@stilbuero.de
43 * Get the value of a cookie with the given name.
45 * @example $.cookie('the_cookie');
46 * @desc Get the value of a cookie.
48 * @param String name The name of the cookie.
49 * @return The value of the cookie.
54 * @author Klaus Hartl/klaus.hartl@stilbuero.de
56 jQuery
.cookie = function(name
, value
, options
) {
57 if (typeof value
!= 'undefined') { // name and value given, set cookie
58 options
= options
|| {};
64 if (options
.expires
&& (typeof options
.expires
== 'number' || options
.expires
.toUTCString
)) {
66 if (typeof options
.expires
== 'number') {
68 date
.setTime(date
.getTime() + (options
.expires
* 24 * 60 * 60 * 1000));
70 date
= options
.expires
;
72 expires
= '; expires=' + date
.toUTCString(); // use expires attribute, max-age is not supported by IE
74 // CAUTION: Needed to parenthesize options.path and options.domain
75 // in the following expressions, otherwise they evaluate to undefined
76 // in the packed version for some reason...
77 var path
= options
.path
? '; path=' + (options
.path
) : '';
78 var domain
= options
.domain
? '; domain=' + (options
.domain
) : '';
79 var secure
= options
.secure
? '; secure' : '';
80 document
.cookie
= [name
, '=', encodeURIComponent(value
), expires
, path
, domain
, secure
].join('');
81 } else { // only name given, get cookie
82 var cookieValue
= null;
83 if (document
.cookie
&& document
.cookie
!= '') {
84 var cookies
= document
.cookie
.split(';');
85 for (var i
= 0; i
< cookies
.length
; i
++) {
86 var cookie
= jQuery
.trim(cookies
[i
]);
87 // Does this cookie string begin with the name we want?
88 if (cookie
.substring(0, name
.length
+ 1) == (name
+ '=')) {
89 cookieValue
= decodeURIComponent(cookie
.substring(name
.length
+ 1));