@kgierke/nuxt-matomo

Nuxt Module for Matomo Analytics
2,879
Install
npm install @kgierke/nuxt-matomo
Latest Version:0.0.3
Vue:3
License:MIT
Last Updated:Jul 15, 2024
Links: npm
Maintainer: kgierke

Nuxt Matomo

npm version npm downloads License Nuxt

Nuxt Module for easy Matomo integration.

  • ✨  Release Notes

Features

  • ✅ Simple to use
  • ✅ Convenient useMatomo composable
  • ✅ Fully typed Matomo Client

Quick Setup

Install the module to your Nuxt application with one command:

npx nuxi module add @kgierke/nuxt-matomo

Configure the module to your nuxt.config.js:

export default {
  modules: ["@kgierke/nuxt-matomo"],
  matomo: {
    host: "https://your-matomo-instance.com",
    siteId: 1,
  },
};

That's it! You can now use Nuxt Matomo in your Nuxt app ✨

Options

Option Type Default Description
host string '' The URL of your Matomo instance
siteId number 0 The ID of the site you want to track
enabled boolean or string true Whether the module should be enabled or not
debug boolean or string false Whether to enable debug mode
enableLinkTracking boolean true Whether to enable link tracking
disableCookies boolean true Whether to disable cookies. Disabled by default for better GDPR Compliance.
enableHeartBeatTimer boolean true Whether to enable the heart beat timer
heartBeatTimerInterval number 15 The interval of the heart beat timer in seconds
trackerFileName string 'matomo.js' The name of the tracker file
crossOrigin string '' The cross origin configuration for the tracker file
scriptInterval number 50 The interval in milliseconds to wait between loading the Matomo script and the tracker file
scriptTimeout number 5000 The timeout in milliseconds to wait for the Matomo script to load

Contribution

Local 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

Related Packages

@kgierke/nuxt-basic-auth

Nuxt 3 Module for Basic Authentication

371,682

Version History

Version Released Vue License
0.0.3 ^3.0 MIT
0.0.2 ^3.0 MIT