aurelia-google-analytics

Aurelia-Google-Analytics

An Aurelia plugin that adds Google Analytics page tracking to your application with just a small amount of configuration. Set it up once and forget about it.

This plugin was built based on this blog post.

Getting Started

• Install aurelia-google-analytics

jspm install aurelia-google-analytics

# or ...
npm install aurelia-google-analytics --save

• Use the plugin in your app's main.js:

export function configure(aurelia) {
	aurelia.use.plugin('aurelia-google-analytics', config => {
		config.init('<Your Tracker ID>');
		config.attach({
			logging: {
				// Set to `true` to have some log messages appear in the browser console.
				enabled: true
			},
			pageTracking: {
				// Set to `false` to disable in non-production environments.
				enabled: true,
				// Configure fragments/routes/route names to ignore page tracking for
				ignore: {
					fragments: [], // Ignore a route fragment, login fragment for example: ['/login']
					routes: [], // Ignore a route, login route for example: ['login']
					routeNames: [] // Ignore a route name, login route name for example: ['login-route']
				},
				// Optional. By default it gets the title from payload.instruction.config.title.
				getTitle: (payload) => {
					// For example, if you want to retrieve the tile from the document instead override with the following.
					return document.title;
				},
				// Optional. By default it gets the URL fragment from payload.instruction.fragment.
				getUrl: (payload) => {
					// For example, if you want to get full URL each time override with the following.
					return window.location.href;
				}
			},
			clickTracking: {
				// Set to `false` to disable in non-production environments.
				enabled: true,
				// Optional. By default it tracks clicks on anchors and buttons.
				filter: (element) => {
					// For example, if you want to also track clicks on span elements override with the following.
					return element instanceof HTMLElement &&
						(element.nodeName.toLowerCase() === 'a' ||
							element.nodeName.toLowerCase() === 'button' ||
							element.nodeName.toLowerCase() === 'span');
				}
			},
			exceptionTracking: {
				// Set to `false` to disable in non-production environments.
				enabled: true
			}
		});
	});

	aurelia.start().then(a => a.setRoot());
}

• If you are using Aurelia CLI, you need to add the following two libraries to your bundle dependencies.

"deepmerge",
{
	"name": "aurelia-google-analytics",
	"path": "../node_modules/aurelia-google-analytics/dist/amd",
	"main": "index"
}

In order to use the click tracking feature, each HTML element you want to track must contain a data-analytics-category and data-analytics-action attribute. data-analytics-label and data-analytics-value are supported and optional.

Building from source

Install dependencies

npm install

Then

gulp build

The result is 3 module formats separated by folder in dist/.

Dependencies

• aurelia-dependency-injection
• aurelia-event-aggregator
• aurelia-logging
• aurelia-router implicit dependency because this plugin listens to the router:navigation:success event
• deepmerge

Pull Requests

Yes, please!