JQueryCookie < System < BACCHUS Wiki

You are here: BACCHUS Wiki>System Web>JQueryPlugin>JQueryCookie (revision 1) (raw view)

---+ %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).

Topic revision: r1 - 12 Feb 2010, ProjectContributor

System

Copyright &© by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding BACCHUS Wiki? Send feedback