Nuxt 3 module to integrate Segment analytics 2.0.
- 📯 Track events and page views manually with composables
- 📯 Optionally track page views automatically with the router integration
- 📂
.env
file support - 🧺 Sensible default options
- 🦾 SSR-ready
- Add
@hexdigital/nuxt-segment
dependency to your project
# Using pnpm
pnpm add -D @hexdigital/nuxt-segment
# Using yarn
yarn add --dev @hexdigital/nuxt-segment
# Using npm
npm install --save-dev @hexdigital/nuxt-segment
Add @hexdigital/nuxt-segment
to the modules
section of your Nuxt configuration:
// `nuxt.config.ts`
export default defineNuxtConfig({
modules: ['@hexdigital/nuxt-segment']
})
- Add configuration in
nuxtConfig.segment
or innuxtConfig.runtimeConfig.public.segment
This module supports two ways of configuration:
- Directly in key
segment
of the Nuxt config:nuxtConfig.segment
- In public runtimeConfig:
nuxtConfig.runtimeConfig.public.segment
# 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