@snowplow/browser-plugin-enhanced-consent

Snowplow Enhanced Consent Plugin

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

This plugin is the recommended way to track marketing consent events on your website. Usage and a complete setup journey is showcased on the Consent Tracking for Marketing accelerator.

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-enhanced-consent

Usage

Initialize your tracker with the EnhancedConsentPlugin:

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

newTracker('sp1', '{{collector_url}}', { 
   appId: 'my-app-id', 
   plugins: [ EnhancedConsentPlugin() ],
});

For a full API reference, you can read the plugin documentation page.

Copyright and license

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

Copyright (c) 2022 Snowplow Analytics Ltd.

All rights reserved.