/aurelia-google-analytics

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

Primary LanguageJavaScriptMIT LicenseMIT

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

# In case the above does not work for some reason, the following will work:
# jspm install aurelia-google-analytics=github:miguelzakharia/aurelia-google-analytics
  • 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: {
					enabled: true // Set to `true` to have some log messages appear in the browser console.
				},
				pageTracking: {
					enabled: true // Set to `false` to disable in non-production environments.
				},
				clickTracking: {
					enabled: true // Set to `false` to disable in non-production environments.
				}
		});
		
    aurelia.start().then(a => a.setRoot());
}

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 is 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

Pull Requests

Yes, please!