Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@parcellab/react-use-umami

Package Overview
Dependencies
Maintainers
4
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@parcellab/react-use-umami

React tools for Umami Analytics.

  • 1.1.0
  • npm
  • Socket score

Version published
Weekly downloads
9
increased by28.57%
Maintainers
4
Weekly downloads
 
Created
Source

🥓 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 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>

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.

Keywords

FAQs

Package last updated on 22 Jan 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc