Google Analytics

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]

> Google Analytics integration for Nuxt.js with vue-analytics

📖 Release Notes

Setup

1. Add @nuxtjs/google-analytics dependency to your project

``bash
yarn add --dev @nuxtjs/google-analytics # or npm install --save-dev @nuxtjs/google-analytics
`

2. Add @nuxtjs/google-analytics to the buildModules section of nuxt.config.js

`js
export default {
buildModules: [
['@nuxtjs/google-analytics', {
id: 'UA-12301-2'
}]
]
}
`

:warning: If you are using Nuxt < v2.9 you have to install the module as a dependency (No --dev or --save-dev flags) and use modules section in nuxt.config.js instead of buildModules.

$3

`js
export default {
buildModules: [
'@nuxtjs/google-analytics'
],
googleAnalytics: {
id: 'UA-12301-2'
}
}
`

$3

You can use runtime config if need to use dynamic environment variables in production. Otherwise, the options will be hardcoded during the build and won't be read from nuxt.config anymore.

`js
export default {
buildModules: [
'@nuxtjs/google-analytics'
],

googleAnalytics: {
id: 'UA-12301-2', // Used as fallback if no runtime config is provided
},

publicRuntimeConfig: {
googleAnalytics: {
id: process.env.GOOGLE_ANALYTICS_ID
}
},
}
`

Usage

Click here for all options and features of vue-analytics

Differences between vue-analytics and the Nuxt.js implementation:

- The router instance is already added out of the box (read here if you need to disable it)
- The id and ua properties have the exact same behaviour. The ua property has been added for backwards compatibily with previous releases
- You can disable module for nuxt dev by setting dev: false option in module options
- Note: By default, you won't see hits going out in dev mode. For testing analytics in dev mode, you must add the following to the googleAnalytics options in nuxt.config.js:

`js
debug: {
enabled: true,
sendHitTask: true
}
``

License

MIT License

Copyright (c) Nuxt Community

[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/google-analytics/latest.svg
[npm-version-href]: https://npmjs.com/package/@nuxtjs/google-analytics

[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxtjs/google-analytics.svg
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/google-analytics

[github-actions-ci-src]: https://github.com/nuxt-community/analytics-module/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/nuxt-community/analytics-module/actions?query=workflow%3Aci

[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/analytics-module.svg
[codecov-href]: https://codecov.io/gh/nuxt-community/analytics-module

[license-src]: https://img.shields.io/npm/l/@nuxtjs/google-analytics.svg
[license-href]: https://npmjs.com/package/@nuxtjs/google-analytics