Skip to content

Latest commit

 

History

History
96 lines (62 loc) · 2.49 KB

analytics.md

File metadata and controls

96 lines (62 loc) · 2.49 KB

Analytics

A jQuery plugin for Google Universal Analytics Events.

Using Analytics

Main

analytics.js

Dependencies

jQuery
core.js
mediaquery.js

Basic

Track click events in Google Analytics by attaching a properly formed data attribute to any element. The data attribute should define at least the required values, category and action. Values should be comma separated:

<button data-analytics-event="category, action [, label] [, value]">...</button>

Advanced

Fire custom events by passing the event field values directly to Analytics:

$.analytics("event", {
	eventCategory: "Category", 
	eventAction: "Action" 
	eventLabel: "Label",
	eventValue: 100
});

Note: eventLabel and eventValue are optional. Learn more about fields and Event Tracking with Universal Analytics.

Scroll Depth

Track scroll depth by enabling the scrollDepth option at initialization. Change the target scroll increments by modifying the scrollStops option:

$.analytics({
	scrollDepth: true,
	scrollStops: 10
});

Page Views

Fire page view by calling the pageview method:

$.analytics("pageview");

Tag Manager Support

Analytics will push to all available trackers, even when loaded using Google Tag Manager.

Note: The Google Analytics Debugger extension helps to ensure events are being properly pushed.

Options

Set instance options by passing a valid object at initialization, or to the public defaults method.

Name Type Default Description
autoEvents boolean false Flag to bind auto-events to mailto, tel, files and external links
fileTypes regex   File types for binding auto-events
eventCallback boolean false Flag to use event callbacks when navigating
eventTimeout int 1000 Event failure timeout
scrollDepth boolean false Flag to track scroll depth events
scrollStops int 5 Number of scroll increments to track
scrollFields object {} Additional event fields for scroll depth events