-
Notifications
You must be signed in to change notification settings - Fork 38
/
JQueryCookie.txt
34 lines (29 loc) · 1.49 KB
/
JQueryCookie.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
%META:TOPICINFO{author="ProjectContributor" date="1456220586" format="1.1" version="1"}%
%META:TOPICPARENT{name="JQueryPlugin"}%
---+ %TOPIC%
%JQPLUGINS{"cookie"
format="
Homepage: $homepage <br />
Author(s): $author <br />
Version: $version
"
}%
%STARTSECTION{"summary"}%
Easy cookie handling using jQuery.
%ENDSECTION{"summary"}%
---++ Usage
* =$.cookie('the_cookie');=: return the value of the cookie
* =$.cookie('the_cookie', 'the_value');=: set the value of a cookie
* =$.cookie('the_cookie', 'the_value', { expires: 7, path: '/', domain: 'jquery.com', secure: true });=:
create a cookie with all available options.
* =$.cookie('the_cookie', null);=: delete a cookie by passing null as value.
Keep in mind that you have to use the same path and domain used when the cookie was set.
---++ Options
* expires: either an integer specifying the expiration date from now on in days or a Date object.
If a negative value is specified (e.g. a date in the past), the cookie will
be deleted. If set to null or omitted, the cookie will be a session cookie and
will not be retained when the the browser exits.
* path: the value of the path atribute of the cookie (default: path of page that created the cookie).
* domain: the value of the domain attribute of the cookie (default: domain of page that created the cookie).
* secure: if true, the secure attribute of the cookie will be set and the cookie transmission will
require a secure protocol (like HTTPS).