https://github.com/cbschuld/mixpanel-browser-hook
Provides a react hook for Mixpanel's `mixpanel-browser`
https://github.com/cbschuld/mixpanel-browser-hook
Last synced: 4 months ago
JSON representation
Provides a react hook for Mixpanel's `mixpanel-browser`
- Host: GitHub
- URL: https://github.com/cbschuld/mixpanel-browser-hook
- Owner: cbschuld
- Created: 2025-04-01T14:51:19.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-01T15:51:00.000Z (about 1 year ago)
- Last Synced: 2025-09-22T16:24:45.153Z (9 months ago)
- Language: TypeScript
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mixpanel-browser-hook
Provides a react hook for Mixpanel's `mixpanel-browser`
## Installation
Install the package using npm:
```bash
npm install mixpanel-browser-hook
```
## Usage
Here is an example of how to use `mixpanel-browser-hook` in your project:
```javascript
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
Your App Content
}
```
## 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.