Snowplow Link Click Tracking

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

Adds link 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-link-click-tracking

Usage

Initialize your tracker with the LinkClickTrackingPlugin:

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

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

enableLinkClickTracking({ options: { ... }, psuedoClicks: true });

You can also explicitly track a click without installing listeners:

import { trackLinkClick } from '@snowplow/browser-plugin-link-click-tracking';

trackLinkClick({ element: document.querySelector("a, area") });
trackLinkClick({ targetUrl: "http://example.com/" });

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.