Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stefangabos/zebra_cookie
A very lightweight JavaScript library for easy cookie management — set, read, and delete browser cookies effortlessly
https://github.com/stefangabos/zebra_cookie
cookie cookies javascript
Last synced: 2 months ago
JSON representation
A very lightweight JavaScript library for easy cookie management — set, read, and delete browser cookies effortlessly
- Host: GitHub
- URL: https://github.com/stefangabos/zebra_cookie
- Owner: stefangabos
- License: other
- Created: 2013-03-07T08:27:13.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-10-27T15:18:09.000Z (2 months ago)
- Last Synced: 2024-10-28T12:03:50.137Z (2 months ago)
- Topics: cookie, cookies, javascript
- Language: JavaScript
- Homepage: https://stefangabos.github.io/Zebra_Cookie/
- Size: 422 KB
- Stars: 17
- Watchers: 4
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# JavaScript Cookie Management Made Easy
with Zebra Cookie [](https://twitter.com/intent/tweet?text=A+ridiculously+small+(~500+bytes+minified)+JavaScript+API+for+writing,+reading+and+deleting+browser+cookies&url=https://github.com/stefangabos/Zebra_Datepicker&via=stefangabos&hashtags=jquery,javascript)
*A very lightweight JavaScript library for easy cookie management — set, read, and delete browser cookies effortlessly*
[](https://www.npmjs.com/package/zebra_cookie) [](https://www.npmjs.com/package/zebra_cookie) [](https://www.npmjs.com/package/zebra_cookie) [](https://www.jsdelivr.com/package/npm/zebra_cookie) [](https://github.com/stefangabos/Zebra_Cookie/blob/master/LICENSE.md)
## Zebra Cookie: Lightweight JavaScript Library for Easy Cookie Management
- very easy to write, read and delete browser cookies
- simple and intuitive syntax
- extremely small: with around 500 bytes when minified (350 bytes gzipped), it is probably the smallest and most optimized API for handling browser cookies from JavaScript
Zebra Cookie is a convenient choice if you want a small, dependency-free solution for cookie management, especially for projects where managing cookies is required but using a larger library isn't necessary.
Check out the [demos](https://stefangabos.github.io/Zebra_Cookie/)
## Installation Instructions for Zebra Cookie JavaScript Library
Zebra Cookie is available as a [npm package](https://www.npmjs.com/package/zebra_cookie). To install it use:
```bash
# the "--save" argument adds the plugin as a dependency in packages.json
npm install zebra_cookie --save
```
## How to Set, Read, and Delete Cookies with Zebra Cookie
Load Zebra Cookie:
```html
```
Alternatively, you can load Zebra Cookie from [JSDelivr CDN](https://www.jsdelivr.com/package/npm/zebra_cookie) like this:
```html
```
Usage
```javascript
// at this point "Cookie" object will be available in the global namespace
// the object exposes 3 methods that you can use to write, read and delete cookies
// create a session cookie (expires when the browser closes)
Cookie.write('cookie_name', 'cookie_value');
// create a cookie that expires in 1 day
Cookie.write('cookie_name', 'cookie_value', 24 * 60 * 60);
// read a cookie’s value
// following the examples above, this should return "cookie_value"
Cookie.read('cookie_name');
// the "read" method returns null if the cookie doesn’t exist
Cookie.read('non_existing_cookie_name');
// delete the cookie
Cookie.destroy('cookie_name');
```
## Methods
### `destroy(name)`
Removes a cookie from the browser.
Returns `TRUE` on success or `FALSE` otherwise.
#### Arguments
`name` - the name of the cookie to remove
```javascript
// create a session cookie (expires when the browser closes)
Cookie.write('cookie_name', 'cookie_value');
// delete the cookie
Cookie.destroy('cookie_name');
```
### `read(name)`
Reads the value of a cookie.
Returns the value of the requested cookie or `null` if the cookie doesn't exist.
#### Arguments
`name` - the name of the cookie to read
```javascript
// create a session cookie (expires when the browser closes)
Cookie.write('cookie_name', 'cookie_value');
// read a cookie's value
// following the examples above, this should return "cookie_value"
Cookie.read('cookie_name');
```
### `write(name, value, [expire = 0], [path = /], [domain = ""], [secure = FALSE])`
Sets a cookie in the browser.
Returns `TRUE` if the cookie was successfully set, or `FALSE` otherwise.
#### Arguments
`name` - The name of the cookie to set
`value` - The value to set
`expire` - *(optional)* - The life time of the cookie, in seconds. If set to `0`, or omitted, the cookie will expire at the end of the session (when the browser closes).
`path` - *(optional)* - The path on the server in which the cookie will be available on. If set to `/`, the cookie will be available within the entire domain. If set to `/foo/`, the cookie will only be available within the `/foo/` directory and all subdirectories such as `/foo/bar/` of the domain. If omitted, it will be set to `/`.
`domain` - *(optional)* - The domain that the cookie will be available on. To make the cookie available on all sub-domains of `example.com`, domain should be set to to `.example.com`. The `.` (dot) is not required but makes it compatible with more browsers. Setting it to `www.example.com` will make the cookie available only in the `www` sub-domain.
`secure` - *(optional)* - Indicates whether cookie information should only be transmitted over a HTTPS connection. Default is `FALSE`.
```javascript
// create a session cookie (expires when the browser closes)
Cookie.write('cookie_name', 'cookie_value');
// create a cookie that expires in 1 day
Cookie.write('cookie_name', 'cookie_value', 24 * 60 * 60);
```
## 🎂 Support the development of this project
Your support means a lot and it keeps me motivated to keep working on open source projects.
If you like this project please ⭐ it by clicking on the star button at the top of the page.
If you are feeling generous, you can buy me a coffee by donating through PayPal, or you can become a sponsor.
Either way - **Thank you!** 🎉
[
](https://github.com/stefangabos/Zebra_Cookie) [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=BB4S849EMJH48) [
](https://github.com/sponsors/stefangabos)