aurelia-google-analytics

KO | EN

gitlite — search

#python #javascript #nodejs #java #css #golang #react #typescript #tailwindcss #reactjs #html #rust

aurelia-google-analytics

★ 28 Open GitHub ↗

An Aurelia.io plugin that adds Google Analytics page tracking to your project.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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](https://mjau-mjau.com/blog/ajax-universal-analytics/) blog post.

## Getting Started

* Install aurelia-google-analytics

```bash
jspm install aurelia-google-analytics

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

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

```javascript
export function configure(aurelia) {
	aurelia.use.plugin('aurelia-google-analytics', config => {
		const options = {
			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
			}
		};
		config.attach(options);
		config.init('<Your Tracker ID>');
	});

aurelia.start().then(a => a.setRoot());
}
```
* If you are using [Aurelia CLI](http://aurelia.io/hub.html#/doc/article/aurelia/framework/latest/the-aurelia-cli/10), 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.

### Alternative trackings

For custom trackings, for example, if you want to use the simplicity of the `aurelia-google-analytics` but tracking using Google Tag Manager (GTM) ou similars, you can use custom functions passing these function in `options`.

In this case, see options below:

`options.useNativeGaScript` _(default: true)_

Passing `false` in this option to disable native script of GA. The `aurelia-google-analytics` don't load the `<script>` tag to Google Analytics (GA). It's good when you load GA from GTM for example.

With this option disabled, the `aurelia-google-analytics` automatically set internal lib as `loaded`, so you don't need to execute `config.init`.

`options.pageTracking.customFnTrack` _(default: false)_

You can pass a function in this option to customize the tracking of pages. For example, if you use GTM, perhaps do you want to track events sending data to you `dataLayer` variable.

For example:

```javascript

`options.clickTracking.customFnTrack` _(default: false)_

Same of `options.pageTracking.customFnTrack`, but for links.

For example:

```javascript

## Building from source

Install dependencies

```shell
npm install
```

Then

```shell
gulp build
```

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

## Dependencies

* [aurelia-dependency-injection](https://github.com/aurelia/dependency-injection)
* [aurelia-event-aggregator](https://github.com/aurelia/event-aggregator)
* [aurelia-logging](https://github.com/aurelia/logging)
* [aurelia-router](https://github.com/aurelia/router) _implicit dependency because this plugin listens to the router:navigation:success event_
* [deepmerge](https://github.com/KyleAMathews/deepmerge)

## Pull Requests

Yes, please!

aurelia-google-analytics

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README