@envato/cookie-consent
TypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

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 fix code snippet

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

To publish

Run

npm version (patch/minor/major)
npm publish

Readme

Keywords

none

Package Sidebar

Install

npm i @envato/cookie-consent

Weekly Downloads

557

Version

2.0.1

License

MIT

Unpacked Size

20.2 kB

Total Files

10

Last publish

Collaborators

  • envato