yandex-metrika-module-nuxt3

Yandex Metrika for Nuxt 3

Disclaimer

This package is a fork for those who don't want to wait for the official release of a Yandex Metrika module.

The module was created by Nuxt Community and rewritten by dankerow to support Nuxt 3. All credit belongs to:

• Official Nuxt Community module for Yandex Metrika
• dankerow's fork of Yandex Metrika to support Nuxt 3

This package includes precompiled scripts to let people integrate Yandex Metrika into their project. There's no need to compile anything, it is ready to be used out of the box.

Route change events by default

This module automatically sends first page and route change events to Yandex Metrika.

Note: Yandex Metrika is not enabled in dev mode. You can set environment variable NODE_ENV to production for testing in dev mode.

Setup

• Add yandex-metrika-module-nuxt3 dependency using yarn or npm to your project
• Add yandex-metrika-module-nuxt3 to modules section of nuxt.config.js

{
  modules: ['yandex-metrika-module-nuxt3']
}

Configure

You can pass options directly in module declaration:

{
  modules: [
    [
      'yandex-metrika-module-nuxt3',
      {
        id: 'XXXXXX',
        webvisor: true,
        // consoleLog: true,
        // clickmap: true,
        // useCDN: false,
        // trackLinks: true,
        // accurateTrackBounce: true,
      }
    ]
  ]
}

Or you can specify yandexMetrika key:

{
  modules: ['yandex-metrika-module-nuxt3'],
  yandexMetrika: {
    id: 'XXXXXX',
    // ...
  }
}

In Nuxt 2.13+, you can also use public runtime config:

{
  modules: ['yandex-metrika-module-nuxt3'],
  publicRuntimeConfig: {
    yandexMetrika: {
      id: process.env.YANDEX_METRIKA_ID,
      // ...
    }
  }
}

Options

For more information:

• Documentation for Ya.Metrika
• hit method

Name	Default value	Type	Description
accurateTrackBounce	true	Boolean	Number
childIframe	false	Boolean	Whether to record iframe contents without a tag in a child window
clickmap	true	Boolean	Whether to collect data for a click map
defer	false	Boolean	Whether to disable automatically sending data during tag initialization
ecommerce	false	Boolean	String
params	—	Object	Array
userParams	—	Object	Parameters of site users that are transmitted when initializing the tag To transmit user parameters at any other time, use the userParams method
trackHash	false	Boolean	Hash tracking in the browser's address bar
trackLinks	true	Boolean	Track clicks on outbound links
trustedDomains	—	Array	Indicates a trusted domain for recording the contents of a child iframe. Contains the domain address of the parent window
type	0	Number	Tag type. 1 for YAN
webvisor	false	Boolean	Whether to use Session Replay
triggerEvent	false	Boolean	Whether to check if the tag is ready

Development

• Clone this repository
• Install dependencies using yarn install
• Run yarn dev:prepare to generate type stubs.
• Use yarn dev to start playground in development mode.

License

MIT License