jethron / snowplow-browser-plugin-simple-template

A simple template for creating and publishing a Browser Plugin for the Snowplow JavaScript Trackers

Snowplow Browser Plugin Simple Example

This template demonstrates how to create a Browser Plugin to be used with @snowplow/browser-tracker.

This example can be cloned, modified and then published to npm.

Maintainer quick start

Requires Node (10+).

Setup repository

$ npm install
$ npm test
$ npm run build

Package Publishing

Update banner.js and package.json with your information.

We advise naming the package snowplow-browser-plugin-* where * describes what this plugin does.

npm run build
npm login
npm publish

Example Usage from npm

Initialize your tracker with the SimpleContextTemplate:

import { newTracker } from '@snowplow/browser-tracker';
import { SimpleContextTemplate } from 'snowplow-browser-plugin-simple-template';

newTracker('sp1', '{{collector}}', { plugins: [ SimpleContextTemplate() ] });

Example Usage with tag based tracker

Assuming sp.js or sp.lite.js has been loaded on window.snowplow, and this plugin is published on npm:

window.snowplow('addPlugin', 
  "https://cdn.jsdelivr.net/npm/snowplow-browser-plugin-simple-template@latest/dist/index.umd.min.js",
  ["snowplowSimpleTemplate", "SimpleContextPlugin"]
);

Copyright and license

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

Copyright (c) 2021 Snowplow Analytics Ltd.

All rights reserved.