Snowplow Screen Tracking Plugin

[![npm version][npm-image]][npm-url]
[![License][license-image]](LICENSE)

Browser Plugin to be used with @snowplow/browser-tracker. The plugin is already included in @snowplow/react-native-tracker.

This plugin is the recommended way to track screen view events.

Maintainer quick start

Part of the Snowplow JavaScript Tracker monorepo.
Build with Node.js (18 - 20) and Rush.

$3

``bash
npm install -g @microsoft/rush
git clone https://github.com/snowplow/snowplow-javascript-tracker.git
rush update
`

Package Installation

With npm:

`bash
npm install @snowplow/browser-plugin-snowplow-screen-tracking
`

Usage

Initialize your tracker with the ScreenTrackingPlugin:

`js
import { newTracker } from '@snowplow/browser-tracker';
import { ScreenTrackingPlugin } from '@snowplow/browser-plugin-screen-tracking';

newTracker('sp1', '{{collector_url}}', {
appId: 'my-app-id',
plugins: [ ScreenTrackingPlugin() ],
});
``

For a full API reference, you can read the plugin documentation page.

Copyright and license

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

Copyright (c) 2022 Snowplow Analytics Ltd.

All rights reserved.

[npm-url]: https://www.npmjs.com/package/@snowplow/browser-plugin-screen-tracking
[npm-image]: https://img.shields.io/npm/v/@snowplow/browser-plugin-screen-tracking
[docs]: https://docs.snowplowanalytics.com/docs/collecting-data/collecting-from-own-applications/javascript-tracker/
[osi]: https://opensource.org/licenses/BSD-3-Clause
[license-image]: https://img.shields.io/npm/l/@snowplow/browser-plugin-screen-tracking