Scripts

Hotjar is a screen recorder and heatmap tool that helps you understand how users interact with your website.

Hotjar

View source

Nuxt Config Setup

Add this to your nuxt.config.ts to load Hotjar globally. Alternatively you can use the useScriptHotjar composable for more control.

export default defineNuxtConfig({
  scripts: {
    registry: {
      hotjar: {
        id: '1234567',
        trigger: 'onNuxtReady',
      }
    }
  }
})

This config automatically enables first-party mode (bundle + proxy). See below to customise.

useScriptHotjar()

The useScriptHotjar composable lets you have fine-grain control over when and how Hotjar is loaded on your site.

const { proxy } = useScriptHotjar()

proxy.hj('event', 'conversion')

Please follow the Registry Scripts guide to learn more about advanced usage.

First-Party Mode: Privacy Focused Proxy

No extra config needed. The script is bundled from your domain (faster loads, no extra DNS lookup) and runtime requests are reverse-proxied through your server with automatic anonymisation (user IPs stay hidden from Hotjar, works with ad blockers). Learn more.

Mode
Bundle Proxy
Privacy
IP, language, and hardware fingerprints are anonymised. Screen dimensions pass through so heatmaps render accurately.
export default defineNuxtConfig({
  scripts: {
    // ✅ First-party mode: bundled + proxied
    registry: {
      hotjar: {
        id: '1234567',
        trigger: 'onNuxtReady',
      },
    },
  },
})

Example

Using Hotjar in a component with the proxy to send events .

<script setup lang="ts">
const { proxy } = useScriptHotjar()

// noop in development, ssr
// just works in production, client
function handleAction() {
  proxy.hj('event', 'conversion')
}
</script>

<template>
  <div>
    <button @click="handleAction">
      Send Event
    </button>
  </div>
</template>
idnumber required

Your Hotjar Site ID.

svnumber = 6

The Hotjar snippet version.