Nuxt Clarity Analytics

A module to easily integrate Clarity Analytics into your Nuxt 3 project.

[!NOTE] I recommend you to give a try to Nuxt Scripts, a more complete solution.

• ✨  Release Notes

Features

• ✅  Works with Nuxt 3 using Nitro (SSR and SSG)

Quick Setup

1. Add nuxt-clarity-analytics dependency to your project

npx nuxi@latest module add clarity-analytics

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

export default defineNuxtConfig({
  modules: [
    'nuxt-clarity-analytics'
  ]
})

Then, you must register your clarity ID project NUXT_CLARITY_ID in your environment variables.

And Voilà!

You can easily check that the script is correctly injected by inspecting your page on your browser. Note that nothing is injected if the key is missing!

You can also use the util clarityContent to use a cookie when the user consent to it. It's a wrapper around window.clarity. See Clarity documentation.

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