Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Snowplow Geolocation Tracking

npm version License

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

Adds Geolocation 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-geolocation

Usage

Initialize your tracker with the GeolocationPlugin:

import { newTracker } from '@snowplow/browser-tracker';
import { GeolocationPlugin, enableGeolocationContext } from '@snowplow/browser-plugin-geolocation';

// Enables at tracker load - set to `false` to load later with `enableGeolocationContext`
newTracker('sp1', '{{collector}}', { plugins: [ GeolocationPlugin(true) ] }); 

enableGeolocationContext(); // If initializing with `false`, call this to switch it on

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.