@snowplow/browser-plugin-link-click-tracking

What is @snowplow/browser-plugin-link-click-tracking?

@snowplow/browser-plugin-link-click-tracking is a plugin for the Snowplow JavaScript tracker that enables automatic tracking of link clicks on a webpage. It helps in capturing user interactions with links, which can be useful for analytics and understanding user behavior.

What are @snowplow/browser-plugin-link-click-tracking's main functionalities?

Automatic Link Click Tracking

This feature allows you to automatically track clicks on links across your website. By integrating the LinkClickTrackingPlugin with the Snowplow tracker, you can capture link click events without manually adding event listeners.

const { newTracker } = require('@snowplow/browser-tracker');
const { LinkClickTrackingPlugin } = require('@snowplow/browser-plugin-link-click-tracking');

newTracker('sp1', '{{collector_url}}', { plugins: [ LinkClickTrackingPlugin() ] });

Custom Link Click Tracking

This feature allows you to customize which link clicks are tracked by providing a filter function. In this example, only clicks on links that include 'example.com' in their href attribute will be tracked.

const { newTracker } = require('@snowplow/browser-tracker');
const { LinkClickTrackingPlugin } = require('@snowplow/browser-plugin-link-click-tracking');

newTracker('sp1', '{{collector_url}}', { plugins: [ LinkClickTrackingPlugin({
  filter: function (element) {
    return element.href && element.href.includes('example.com');
  }
}) ] });

Other packages similar to @snowplow/browser-plugin-link-click-tracking

react-ga

react-ga is a JavaScript module that provides a simple way to integrate Google Analytics with a React application. It allows tracking of page views, events, and other interactions. Compared to @snowplow/browser-plugin-link-click-tracking, react-ga is more focused on Google Analytics and provides a higher-level API for React applications.

analytics.js

analytics.js is a lightweight JavaScript library for tracking user interactions and sending data to various analytics services. It supports multiple analytics providers and offers a flexible API for tracking events, page views, and more. Unlike @snowplow/browser-plugin-link-click-tracking, analytics.js is not specific to link click tracking and provides a broader range of tracking capabilities.

README

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.