@parcellab/react-use-umami

v2.0.1

Published

a year ago

React tools for Umami Analytics.

Downloads

160

0High
0Medium
0Low

umami react analytics hooks

🥓 react-use-umami

React hooks for umami analytics.
Track page views and events from React components.

Install

React is a peer dependency!

$ npm i react-umami-hooks

Then you'll need to add the script to the <head> section of your page.

This can be done manually: Follow the instructions on the umami docs page to add the script to the <head> section of your page if you have not already. After this (disable the automatic page view tracking)[https://umami.is/docs/tracker-config] ba adding data-auto-track="false" to your tracking script so it looks something like this:

<script async defer
  src="http://mywebsite/umami.js"
  data-website-id="94db1cb1-74f4-4a40-ad6c-962362670409"
  data-auto-track="false"
></script>

Or using registerUmamiScript function from the package.

import React from 'react'
import { registerUmamiScript } from '@parcellab/react-use-umami'

export default function App ({ url, websiteId, dataDomain }) {
  React.useEffect(() => {
    registerUmamiScript(url, websiteId, dataDomain)
  }, [])
  return (
    <>
      <HomePage />
      ...
    </>
  )
}

Usage

You can now import and use useTrackView and useTrackEvent from this module:

const { React } = require('react')
const useUmami = require('@parcellab/react-use-umami')

const HomePage = (props) => {
  const _trackEvt = useUmami('/') // will fire a page view once
  // call this hook only in the top main component and pass the _track function down where it is needed!

const handleSignupClick = () => {
    _trackEvt('Signup CTA', 'click') // will register a 'click' event with value 'Signup CTA'
    // ...
    _trackEvt('Form submitted') // will register a 'custom' event with value 'Form submitted'
  }

  return (
    <>
      <nav></nav>
      ...
    </>
  )
}

useUmami(url, [referrer], [website_id], [skipPageView]) : function trackEvt

Tracks a page view. Only runs once per rendered component. Use this on the top page components for tracking page views. The referrer and website_id values are optional. They will default to the page referrer and data-website-id defined by the script. Returns a function for tracking events. If skipPageView is true, the initial page view will not be triggered.

trackEvt(event_value, [event_type]) : undefined

Tracks a (custom) event. If event_type is omitted it will default to 'custom'. Can be called multiple times.

registerUmamiScript(url, websiteId, dataDomain) : function registerUmamiScript

Adds script with url, websiteId and dataDomain to the header of the html page. Should be triggerd once in the root component (use useEffect hook with an empty array as a second argument to trigger once). This can also be done manually without usage of this function. For reference see the docs umami docs page

Published

Vulnerabilities

Links

Maintainers

Keywords