mixpanel-nuxt

• ✨  Release Notes

Quick Setup

1. Add mixpanel-nuxt dependency to your project

# Using pnpm
pnpm add -D mixpanel-nuxt

# Using yarn
yarn add --dev mixpanel-nuxt

# Using npm
npm install --save-dev mixpanel-nuxt

2. Add mixpanel-nuxt to the modules section of nuxt.config.ts

export default defineNuxtConfig({
  modules: [
    'mixpanel-nuxt'
  ],
})

Basic usage

You can use the provided composable to access Mixpanel anywhere.

const mixpanel = useMixpanel()
mixpanel.track('My event')

Configuration

You just need to set your Mixpanel token in the module options and you're good to go! By default process.env.MIXPANEL_TOKEN is used.

You can also disable the module by setting disabled: true.

export default defineNuxtConfig({
  modules: [
    'mixpanel-nuxt'
  ],
  mixpanel: {
    token: 'your-token',
    disabled: false,
    config: {
      // Mixpanel config
    }
  }
})

Development

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release