Snowplow Button Click Tracking

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

Adds button click tracking events 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-button-click-tracking

Usage

Initialize your tracker with the ButtonClickTrackingPlugin:

import { newTracker } from '@snowplow/browser-tracker';
import { ButtonClickTrackingPlugin } from '@snowplow/browser-plugin-button-click-tracking';

newTracker('sp1', '{{collector}}', { plugins: [ ButtonClickTrackingPlugin() ] }); // 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 { enableButtonClickTracking } from '@snowplow/browser-plugin-button-click-tracking';

enableButtonClickTracking({ filter: { .. }, context: { .. } });

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) 2023 Snowplow Analytics Ltd, 2010 Anthon Pang.

All rights reserved.