Nupital Pomp Mesmerises

    @snowplow/browser-tracker
    TypeScript icon, indicating that this package has built-in type declarations

    3.5.0 • Public • Published

    Snowplow Browser Tracker

    npm version License

    Add Snowplow Tracking to your Web Application with @snowplow/browser-tracker.

    Maintainer quick start

    Part of the Snowplow JavaScript Tracker monorepo.
    Build with Node.js (12 LTS or 14 LTS) 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-tracker

    Usage

    Initialize your tracker with your desired configuration and optional plugins:

    import { newTracker } from '@snowplow/browser-tracker';
    import { SiteTrackingPlugin } from '@snowplow/browser-plugin-site-tracking';
    import { PerformanceTimingPlugin } from '@snowplow/browser-plugin-performance-timing';
    import { ClientHintsPlugin } from '@snowplow/browser-plugin-client-hints';
    import { FormTrackingPlugin, enableFormTracking } from '@snowplow/browser-plugin-form-tracking';
    
    newTracker('sp1', '{{collector}}', { plugins: [ PerformanceTimingPlugin(), SiteTrackingPlugin(), ClientHintsPlugin(), FormTrackingPlugin() ] }); // Also stores reference at module level
    newTracker('sp2', '{{collector}}', { plugins: [ PerformanceTimingPlugin(), SiteTrackingPlugin() ] }); // You can have multiple trackers with different configs!
    
    enableFormTracking() // Switch on form tracking

    Then use the trackX functions from this package and your plugins to track to all trackers which have been initialized, or select just some trackers:

    import { trackPageView } from '@snowplow/browser-tracker';
    import { trackSocialInteraction } from '@snowplow/browser-plugin-site-tracking';
    
    trackPageView({}, ['sp1']); // Just to `sp1`
    
    // OR to all trackers with some extra context!
    trackPageView({
      title: 'My Title',
      context: [
        {
          schema: 'iglu:org.schema/WebPage/jsonschema/1-0-0',
          data: {
            keywords: ['tester'],
          },
        },
      ],
    });
    
    // Use your plugin track methods too
    trackSocialInteraction({
      action: 'retweet',
      network: 'twitter',
      target: '1234',
    });
    

    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.

    Install

    npm i @snowplow/browser-tracker

    Homepage

    bit.ly/sp-js

    DownloadsWeekly Downloads

    38,681

    Version

    3.5.0

    License

    BSD-3-Clause

    Unpacked Size

    1.85 MB

    Total Files

    13

    Last publish

    Collaborators

    • snowplow-analytics
    • cogsp
    • paul_boocock