cookie-consent

Overview

The npm package for cookie consent helpers. These functions are tighly coupled to using the cookiebot api at the moment.

Usage

Installation

npm install @envato/cookie-consent --save
# or using `yarn`
yarn add @envato/cookie-consent

Examples

import { Consent, consented, deferRun } from '@envato/cookie-consent'

// Check for consent inline (note that on the initial page load this function may return false)
if (consented(Consent.statistics)) {
  // Do something..
}

// Manually parse and check the consent type in the CookieConsent cookie
checkCookieConsent(Cookies.get('CookieConsent'), Consent.statistics)

// Run function after consent
deferRun(() => {
  doSomething()
}, Consent.marketing)

// Types of consent we support:
Consent.marketing
Consent.statistics
Consent.preferences
Consent.necessary

Override CSS

There is a cookiebot.css in the module, you can include it to partially override the default Cookiebot style.

The CLS issue fix

In the 2.0.0 release, two CSS rules and a JS snippet were added to fix a CLS issue caused by the cookiebot dialog.

If using a version >= 2.0.0, you need to load the JS snippet on your application, otherwise the Cookiebot dialog won't be displayed.

The file clsFixSnippet.ts contains the snippet. It's being exported as a string. When including the code in your app, make sure it runs before the main cookiebot code.

Publishing

Publishing is automated via GitHub Actions. Trigger with the following steps:

1. Ensure the latest version is committed in the package.json. eg. "version": "1.1.1"
2. Ensure the latest version is tagged from main. eg. git tag v1.1.1 && git push origin v1.1.1
3. Create a release via the Github Releases
4. Verify the build in Github Actions
5. Verify the package published to Github Packages
6. Verify the package published to NPM