# Mixpanel plugin for `analytics`
Integration with Mixpanel for [analytics](https://www.npmjs.com/package/analytics)
This analytics plugin will load Mixpanel's client side tracking script into your application and send custom events, page views, and identify visitors inside Mixpanel.
[View the docs](https://getanalytics.io/plugins/mixpanel/)
Click to expand
- [Installation](#installation)
- [How to use](#how-to-use)
- [Platforms Supported](#platforms-supported)
- [Browser usage](#browser-usage)
- [Browser API](#browser-api)
- [Configuration options for browser](#configuration-options-for-browser)
- [Additional examples](#additional-examples)
## Installation
Install `analytics` and `@analytics/mixpanel` packages
```bash
npm install analytics
npm install @analytics/mixpanel
```
## How to use
The `@analytics/mixpanel` package works in [the browser](#browser-usage). To use, install the package, include in your project and initialize the plugin with [analytics](https://www.npmjs.com/package/analytics).
Below is an example of how to use the browser plugin.
```js
import Analytics from 'analytics'
import mixpanelPlugin from '@analytics/mixpanel'
const analytics = Analytics({
app: 'awesome-app',
plugins: [
mixpanelPlugin({
token: 'abcdef123'
})
]
})
/* Track a page view */
analytics.page()
/* Track a custom event */
analytics.track('cartCheckout', {
item: 'pink socks',
price: 20
})
/* Identify a visitor */
analytics.identify('user-id-xyz', {
firstName: 'bill',
lastName: 'murray'
})
```
After initializing `analytics` with the `mixpanelPlugin` plugin, data will be sent into Mixpanel whenever [analytics.identify](https://getanalytics.io/api/#analyticsidentify), [analytics.page](https://getanalytics.io/api/#analyticspage), or [analytics.track](https://getanalytics.io/api/#analyticstrack) are called.
See [additional implementation examples](#additional-examples) for more details on using in your project.
## Platforms Supported
The `@analytics/mixpanel` package works in [the browser](#browser-usage)
## Browser usage
The Mixpanel client side browser plugin works with these analytic api methods:
- **[analytics.identify](https://getanalytics.io/api/#analyticsidentify)** - Identify visitors and send details to Mixpanel
- **[analytics.page](https://getanalytics.io/api/#analyticspage)** - Sends page views into Mixpanel
- **[analytics.track](https://getanalytics.io/api/#analyticstrack)** - Track custom events and send to Mixpanel
- **[analytics.reset](https://getanalytics.io/api/#analyticsreset)** - Reset browser storage cookies & localstorage for Mixpanel values
### Browser API
```js
import Analytics from 'analytics'
import mixpanelPlugin from '@analytics/mixpanel'
const analytics = Analytics({
app: 'awesome-app',
plugins: [
mixpanelPlugin({
token: 'abcdef123'
})
]
})
```
### Configuration options for browser
| Option | description |
|:---------------------------|:-----------|
| `token`
**required** - string| The mixpanel token associated to a mixpanel project |
| `pageEvent`
_optional_ - string| Event name to use for page() events (default to page path) |
| `customScriptSrc`
_optional_ - string| Load mixpanel script from custom source |
## Additional examples
Below are additional implementation examples.
Using in HTML
Below is an example of importing via the unpkg CDN. Please note this will pull in the latest version of the package.
```html
Using @analytics/mixpanel in HTML
....
```
Using in HTML via ES Modules
Using `@analytics/mixpanel` in ESM modules.
```html
Using @analytics/mixpanel in HTML via ESModules
....
```