wideangle-nuxt

Wide Angle Analytics Nuxt3 Module

Wide Angle Analytics module for Nuxt

Enable privacy-friendly web analytics in your Nuxt 3.x application with our official plugin.

Wide Angle Analytics is powerful, strictly-GDPR compliant Google Analytics alternative.

How to get started

You can enable Wide Angle Analytics in your Nuxt projects in just a few steps. No complex configuration needed, as our sane defaults provide you with a reliable and privacy-centric deployment out of the box.

1. Go to the Wide Angle website and create an account. You can enjoy a free 14-day trail. No Credit Card is required. Learn more.
2. Create a new site and activate it.
3. Install the wideangle-vuejs plugin in your Vue application.

npm install wideangle-nuxt

4. Enable and configure the module.

export default defineNuxtConfig({
  modules: ['wideangle-nuxt'],

  runtimeConfig: {
    public: {
      wideangle: {
        siteId: "8D27G3B9ACA01F4241"
      }
    }
  }
})

Configuring Wide Angle Analytics plugin

The Wide Angle Analytics plugin must be initialized with a configuration object as there are required settings without defaults.

option	description	required	default	example
siteId	The Site ID from the Wide Angle Site settings	✅	none	8D27G3B9ACA01F4241
domain	Domain hosting the script, can be found in Wide Angle Analytics Site settings	❌	stats.wideangle.co	your.domain.com
fingerprint	Should script use browser fingerprinting; this might require collecting consent depending on the applicable laws	❌	false	true
supressDnt	Should script ingore Do Not Track browser setting. If not enabled, no events will be sent if user's browser has DNT enabled	❌	false	true
includeParams	An array of query parameters that can be passed as part of tracking event. By default only utm_* and ref parameters are passed in the event	❌	[]	['sessionId', 'offset']
excludePaths	An array of URL paths that should not trigger default events such as page view, page leave	❌	[]	['^/wp-admin/.*', ]
ignoreHash	If enabled, a change in the URL fragment will not trigger page view event	❌	false	true

You can find more details about these settings in the Wide Angle Analytics documentation.

Example:

export default defineNuxtConfig({
  modules: ['wideangle-nuxt'],

  runtimeConfig: {
    public: {
      wideangle: {
        siteId: "8D27G3B9ACA01F4241",
        domain: "your.domain.com",
        fingerprint: false,
        supressDnt: true,
        includeParams: ['q', 'customerId'],
        excludePaths: ['^/admin.*'],
        ignoreHash: true
      }
    }  
  }
})

Usage

The Wide Angle Analytics provides an instance of waa which can be then injected to your component.

useWaaEvent('purchase', {'basket_element': 'dress'}, {'basket_item_price': 123.44});

You will find a fully functional example in this repository.

Tracking Pageviews

No action necessary. The tracker script automatically issues Page View and Page Leave events.

Tracking Events

Wide Angle supports three specialized events:

• clicks
• downloads
• custom actions

Site has to have these events enabled in the Wide Angle Analytics configuration prior to usage. Otherwise the tracker script will not send these events. Consult the official documentation regarding how to enable event handling.

Tracking Clicks

Currently Click Events are emitted automatically based on element data attributes.

Tracking Downloads

Depending on the configured mode, the Download Event will fire automatically when either:

• a file with recognized extension is being downloaded, or
• when a link is marked with data-waa-name attribute.

Tracking Custom Actions

Custom actions are the most flexible and can be triggered directly from Vue components. As such, their usage is not limitted due to the Shadow DOM.

Example:

<template>
  <button @click="sendEvent()">Send Event</button>    
</template>

<script setup>
import { useWaaEvent } from '#imports'
const sendEvent = async () => {
  const params = {
    session: 'cjhw92nf9aq',
    cohort: 'c1233'
  }  
  useWaaEvent('interest', params);  
}
</script>

Module Assets

You can find a high-resolution Wide Angle Analytics logo and icon on our media page.