Skip to content

Easy, strong typed, and a modern way to use google analytics gtag lib.

License

Notifications You must be signed in to change notification settings

mrahhal/mr-gtag

Repository files navigation

mr-gtag

npm License

Easy, strong typed, and a modern way to use google analytics gtag lib.

Both umd and es bundles are produced, along with type definitions.

Install

npm i mr-gtag

Usage

First, calling installGtag injects the lib:

import { installGtag } from 'mr-gtag';

installGtag(trackingId);

This injects the lib and then calls what is equivalent to gtag('config', trackingId, ...);.

Some options are available here:

import { installGtag } from 'mr-gtag';

installGtag(trackingId, {
  send_page_view: false, // If set to false, tells gtag to not send the default pageview event. Default is true.
  user_id: 'USER_ID', // You can set the user_id like this
  // Or any other option supported by the google gtag lib
});

From here on, use any of the gtag functions available.

Send an event:

import { gtag } from 'mr-gtag';

gtag('event', 'page_view', { ... });

Refer to the google docs for more info and to see the different kinds of events you can send.

Release notes

2.0.0

  • BREAKING CHANGE: Options that installGtag accepts were renamed to be the exact same as the gtag ones. Be sure to update those.
  • We now correctly handle registering more than one tracking id.

1.0.0

Initial version.

About

Easy, strong typed, and a modern way to use google analytics gtag lib.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published