npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@phntms/react-gtm

v0.1.1

Published

A lightweight React library to implement custom Google Tag Manager events.

Downloads

3,183

Readme

@phntms/react-gtm

NPM version Actions Status PR Welcome

A lightweight React library to implement custom Google Tag Manager events.

Introduction

Designed to use and extend Google Analytics 4. Note: If upgrading from react-gtm 0.0.6 or older, or currently using an older version of Google Analytics, you'll need to upgrade. This library is also SSR safe and does not break when used without window existing. This package is intended to be used with React / older Next.JS apps, for Next.JS 11 and above we recommend using @phntms/next-gtm.

Installation

Install this package with npm.

npm i @phntms/react-gtm

Usage

<TrackingHeadScript />

| Property | Type | Default | Notes | | ----------- | --------- | --------- | --------------------------------------------------------------------------------------------------------- | | id | string | undefined | ID that uniquely identifies GTM Container. Example format: GTM-xxxxxx. | | disable | boolean | false | Used to disable tracking events. Use if you want user to consent to being tracked before tracking events. |

To initialize GTM, add TrackingHeadScript to the head of the page.

Example initialization in Next.js:

import Document, {
  Html,
  Head,
  Main,
  NextScript,
} from "next/document";
import { TrackingHeadScript } from "@phntms/react-gtm";

const GA_TRACKING_ID = process.env.NEXT_PUBLIC_GA_TRACKING_ID || "";

export default class MyDocument extends Document {
  render = () => (
    <Html>
      <Head>
        <TrackingHeadScript id={GA_TRACKING_ID} />
      </Head>
      <body>
        <Main />
        <NextScript />
      </body>
    </Html>
  );
}

Note: If used alongside any cookie consent scripts, <TrackingHeadScript /> must be placed after.

trackEvent()

| Parameter | Type | Default | Notes | | --------- | -------------------- | --------- | ----------------------------------------------- | | props | EventTrackingProps | undefined | Custom tracking event to push to GTM container. |

Example of a basic tracking event:

import { trackEvent } from "@phntms/react-gtm";

trackEvent({
  event: "customEvent",
  data: {
    action: "Click - To: https://phantom.land/",
    category: "CTA",
    label: "Click",
  },
});

enableTracking()

| Parameter | Type | Default | Notes | | ---------- | --------- | --------- | ------------------------------------------------------------------- | | id | string | undefined | Same ID used in TrackingHeadScript. Example format: GTM-xxxxxx. | | enable | boolean | true | Used to enable or disable tracking events. |

Note: This should only be used if needed, for example after user has consented to being tracked. You shouldn't need to toggle this in normal usage.

EventDataProps

| Parameter | Type | Default | Required | Notes | | --------- | ---------------- | ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | event | string | "customEvent" | No | Custom GTM event name, defaults to customEvent. | | data | EventDataProps | undefined | No | Supports any value(s) in the format [key: string]: any. Example of recommended properties to include; action, category and label. |

window.dataLayer

This library extends window and exposes the window.dataLayer GTM container object.

Further Resources

Useful resource for implementing custom GTM events:

  • Omnibug - Chrome browser extension to decode and display outgoing GTM events from within Inspect Element.

🍰 Contributing

Want to get involved, or found an issue? Please contribute using the GitHub Flow. Create a branch, add commits, and open a Pull Request or submit a new issue.

Please read CONTRIBUTING for details on our CODE_OF_CONDUCT, and the process for submitting pull requests to us!