mixpanel-browser-hook
TypeScript icon, indicating that this package has built-in type declarations

1.0.2 • Public • Published

mixpanel-browser-hook

Provides a react hook for Mixpanel's mixpanel-browser

Installation

Install the package using npm:

npm install mixpanel-browser-hook

Usage

Here is an example of how to use mixpanel-browser-hook in your project:

import useMixpanel from 'mixpanel-browser-hook'

function App() {
  const { trackEvent, identifyUser, setUserProperties } = useMixpanel(
    'YOUR_MIXPANEL_TOKEN',
  )

  // Track an event
  trackEvent('Button Clicked', { buttonName: 'Submit' })

  // Identify a user
  identifyUser('user-123')

  // Set user properties
  setUserProperties({ plan: 'premium', age: 30 })

  return <div>Your App Content</div>
}

API

useMixpanel(token: string)

Returns an object with the following methods:

  • trackEvent(eventName: string, properties?: object): void
    Tracks an event with optional properties.

  • identifyUser(userId: string): void
    Identifies a user with a unique ID.

  • setUserProperties(properties: object): void
    Sets properties for the identified user.

License

This project is licensed under the MIT License.

Contact

  • Email - twitter handle @ gmail.com
  • X - @cbschuld

Contributing

Yes, thank you! Please update the docs and tests and add your name to the package.json file.

Package Sidebar

Install

npm i mixpanel-browser-hook

Weekly Downloads

4

Version

1.0.2

License

MIT

Unpacked Size

15.2 kB

Total Files

10

Last publish

Collaborators

  • cbschuld