cookie-sanction
v1.2.0
Published
Cookie consent script allowing awaiting user to accept or decline before optionally injecting cookie scripts.
Downloads
3
Readme
Cookie Sanction / Cookie Consent
A JavaScript module for front-end cookie consent functionality which allows for loading scripts after consent is
accepted.
The dist build is compiled to cover latest browsers while compiling from source with your own tool might be more preferable.
Vanilla js
Installation and usage
Install the module from any of the standard channels:
yarn add cookie-sanction
npm install cookie-sanction --save
Include it in your own JavaScript as a module
import { CookieSanction } from 'cookie-sanction';
// alt: { CookieConsent } -"-
// alt: default
const consent = new CookieSanction({
/* options */
});
document.addEventListener('DOMContentLoaded', () => {
consent.active().then((accepted) => {
// accepted is true if user accepted, else false.
}).catch(() => {
});
});
Optional arguments
When creating the cookie consent object, you can change a few default values:
const defaults = {
element: 'div.cookie-consent', // The element that will toggle hidden or shown.
cookie: 'accept-cookies', // Name of the cookie to use.
cookieValue: 'accepted', // Cookie value.
hiddenClass: 'hidden', // Class to toggle to hide/show the element.
rejectButton: 'div.cookie-consent button[name="reject"]', // Selector for the button which rejects cookies.
acceptButton: 'div.cookie-consent button[name="accept"]' // Selector for the button which accept cookies.
};
Just pass in an object with the properties you wish to change from the default, it will merge the options with the default values.
Examples
Check the example/
directory.