GitHub - osano/cookieconsent: A free solution to the EU, GDPR, and California Co...

README.md

What is Cookie Consent?

Cookie Consent is a lightweight JavaScript plugin for alerting users about the use of cookies on your website.

It is designed to help you quickly comply with the EU Cookie Law. So we made it fast, free, and relatively painless.

Cookie Consent is seen over 2 BILLION times every month and is used on millions of sites, making this by far the most popular consent project on the internet.

We welcome community contributions and actively review pull requests.

Basic Use

With version 4.0 you only need to attach the script as we've bundled everything together now. The initialization style has changed as have the callbacks (they're gone). Please see the text below to get started. Then, take a look at updated API via the docs.

Module

import CC from "CookieConsent"
// or
const CC = require( "CookieConsent" )

Classic

const CC = window.CookieConsent

Initialization:

const cc = new CC({
  //...options,
  type   : "categories"
})

Lifecycle hooks, are now events:

cc.on( "initialized", ( ...args ) => console.log( args ) )
cc.on( "error", console.error )
cc.on( "popupOpened", () => console.log( "Popup Open" ) )
cc.on( "popupClosed", () => console.log( "Popup Closed" ) )
cc.on( "revokeChoice", () => console.log( "Popup Reset" ) )
cc.on( "statusChanged", ( ...args ) => console.log( args ) )

Version 4.0

Lots of updates & some breaking changes... but they're all for the better, we promise!

Now actively maintained by:

• @arlogilbert
• @L0key
• @pgoforth
• @Donsky-Osano

Version 3.1

Reflects the ownership change of the Cookie Consent project. Now actively maintained by:

• @arlogilbert
• @L0key
• @pgoforth
• @relicmelex

Version 3.0

Version 3.0 is a complete rewrite from version 2. The most substantial new features are:

• Ability to GeoLocate and only show the add-on to people in the relevant countries
• Callback hooks for showing/accepting/revoking the banner
• Support for different types of compliance, giving you the flexibility to obey even the strictest cookie laws
• Easy no-fuss themes and customisable styles

Installation

The easiest way to get up and running is to use our wizard.

You can also install this project through npm:

npm install cookieconsent

Or through Yarn:

yarn add cookieconsent@3

Or through Bower:

bower install cookieconsent

Or via a jsDelivr:

<script src="https://cdn.jsdelivr.net/npm/cookieconsent@3/build/cookieconsent.min.js"></script>

Documentation

See our full documentation.

Contributing

Feel free to improve the plugin and send us a pull request.

The easiest way to develop is to host the files with a local webserver. e.g.

python -m SimpleHTTPServer

We use Babel, Terser, and PostCSS to compile the SCSS and minify the JavaScript. You can run a build with:

npm run build

or

yarn run build

Credits

Cookie Consent v3

• Alex Morley-Finch (@alexmorleyfinch) - JavaScript
• Piiu Pilt - JavaScript
• Oliver Emberton (@oliveremberton) - a couple of lines of CSS, maybe

Cookie Consent v2

• David Ball (@drball) - CSS / themes
• Adam Hutchinson (@adjohu) - JavaScript

Export Control

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this Apache Software Foundation distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.