the compact javascript framework
in partnership with mediatemple
Class for creating, getting, and removing cookies.
Properties | |
set | Sets a cookie in the browser. |
get | Gets the value of a cookie. |
remove | Removes a cookie from the browser. |
Sets a cookie in the browser.
key | the key (name) for the cookie |
value | the value to set, cannot contain semicolons |
options | an object representing the Cookie options. See Options below. Default values are stored in Cookie.options. |
domain | the domain the Cookie belongs to. If you want to share the cookie with pages located on a different domain, you have to set this value. Defaults to the current domain. |
path | the path the Cookie belongs to. If you want to share the cookie with pages located in a different path, you have to set this value, for example to “/” to share the cookie with all pages on the domain. Defaults to the current path. |
duration | the duration of the Cookie before it expires, in days. If set to false or 0, the cookie will be a session cookie that expires when the browser is closed. This is default. |
secure | Stored cookie information can be accessed only from a secure environment. |
An object with the options, the key and the value. You can give it as first parameter to Cookie.remove.
Cookie.set('username', 'Harald'); // session cookie (duration is false), or ... Cookie.set('username', 'JackBauer', {duration: 1}); // save this for 1 day
Gets the value of a cookie.
key | the name of the cookie you wish to retrieve. |
The cookie string value, or false if not found.
Cookie.get("username") //returns JackBauer
Removes a cookie from the browser.
cookie | the name of the cookie to remove or a previous cookie (for domains) |
options | optional. you can also pass the domain and path here. Same as options in Cookie.set |
Cookie.remove('username') //bye-bye JackBauer, cya in 24 hours var myCookie = Cookie.set('username', 'Aaron', {domain: 'mootools.net'}); // Cookie.set returns an object with all values need to remove the cookie Cookie.remove(myCookie);
Documentation by Aaron Newton & Mootools Developers, generated by NaturalDocs and GeSHi