@snowplow/browser-plugin-consent

Snowplow Consent Tracking

Browser Plugin to be used with @snowplow/browser-tracker.

Adds consent information to your Snowplow tracking.

Maintainer quick start

Part of the Snowplow JavaScript Tracker monorepo.
Build with Node.js (18 - 20) and Rush.

Setup repository

npm install -g @microsoft/rush 
git clone https://github.com/snowplow/snowplow-javascript-tracker.git
rush update

Package Installation

With npm:

npm install @snowplow/browser-plugin-consent

Usage

Initialize your tracker with the ConsentPlugin:

import { newTracker } from '@snowplow/browser-tracker';
import { ConsentPlugin } from '@snowplow/browser-plugin-consent';

newTracker('sp1', '{{collector}}', { plugins: [ ConsentPlugin() ] }); // Also stores reference at module level

Then use the available functions from this package to track to all trackers which have been initialized with this plugin:

import { enableGdprContext, trackConsentGranted } from '@snowplow/browser-plugin-consent';

enableGdprContext({ basisForProcessing: 'consent' });
trackConsentGranted({ id: '123-456', version: '1' });

Copyright and license

Licensed and distributed under the BSD 3-Clause License (An OSI Approved License).

Copyright (c) 2022 Snowplow Analytics Ltd, 2010 Anthon Pang.

All rights reserved.