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

@amsterdam/piwik-tracker-react

v2.0.3

Published

Piwik tracker for React projects

Downloads

172

Readme

Piwik Tracker (React)

Stand alone library for using Piwik tracking in React projects. This package contains React bindings for @amsterdam/piwik-tracker package. It is therefor not compatible with default Piwik implementations.

Installation

npm install @amsterdam/piwik-tracker-react

Usage

Before you're able to use this Piwik Tracker you need to create a Piwik instance with your project specific details and wrap your application with the PiwikProvider that this package exposes.

import { PiwikProvider, createInstance } from '@amsterdam/piwik-tracker-react';

const instance = createInstance({
  urlBase: 'https://LINK.TO.DOMAIN',
  siteId: '3',
  disabled: false, // optional, false by default. Makes all tracking calls no-ops if set to true.
  heartBeat: {
    // optional, enabled by default
    active: true, // optional, default value: true
    seconds: 10, // optional, default value: `15
  },
});

ReactDOM.render(
  <PiwikProvider value={instance}>
    <MyApp />
  </PiwikProvider>
);

After wrapping your application with the PiwikProvider you can use the usePiwik hook to track your application from anywhere within the PiwikProvider component tree:

import React from 'react';
import { usePiwik } from '@amsterdam/piwik-tracker-react';

const MyPage = () => {
  const { trackPageView } = usePiwik();

  // Track page view
  React.useEffect(() => {
    trackPageView({
      href: 'https://LINK.TO.PAGE',
    });
  }, []);

  return (
    <button type="button" onClick={handleOnClick}>
      Click me
    </button>
  );
};

Advanced usage

Custom dimensions can be used:

import React from 'react';
import { usePiwik } from '@amsterdam/piwik-tracker-react';

const MyPage = () => {
  const { trackPageView } = usePiwik();

  // Track page view
  React.useEffect(() => {
    trackPageView({
      href: 'https://LINK.TO.PAGE',
      customDimensions: [
        {
          id: 1,
          value: 'loggedIn',
        },
      ], // optional
    });
  }, []);

  return (
    <button type="button" onClick={handleOnClick}>
      Click me
    </button>
  );
};

The usePiwik hook also exposes the following methods:

  • trackSiteSearch()
  • trackLink()
  • pushInstruction()
  • trackDownload()

For example, the pushInstruction() function can be used to push instructions to Piwik for execution. This is equivalent to pushing entries into the _paq array.

const { pushInstruction } = usePiwik();
pushInstruction('setUserId', 'USER_ID_HERE');