node package manager

ga-wrapper

ga-wrapper

Google Analytics wrapper, automation via inline attributes and bindings.

Google Analytics wrapper (gaw) assumes use of the category, action, and label parameters, and that category is the top-level element in your event naming conventions. Gaw will send an event when an element has all 3 parameters defined, whether explicitly from it's own attributes or implicitly from parent attributes.

Check out the example page with the console open.

Setup

//isogram code here
<script src="/javascript/gaWrapper.js"></script>  

Inline event parameters

gaw uses a global event listener and inline data attributes to determine if a push event is necessary. Given the following code, clicking on li would send an event with the category "Featured Models", the action "Clicked Product Category", and the label "Example Product".

<div data-ga-category="Featured Models">
  <ul data-ga-action="Clicked Product Category">
    <li data-ga-label="Example Product">Example</li>
    <li data-ga-label="Example Product">Example</li>
  </ul>
</div>

Event parameter bindings

gaw supports bindings using the @ syntax. The following would replace @element-text with the clicked element's text.

<div data-ga-category="Featured Models">
  <ul data-ga-action="Clicked Product Category">
    <li data-ga-label="@element-text">Example 1</li>
    <li data-ga-label="@element-text">Example 2</li>
  </ul>
</div>
gaw.bind('element-text', function(element) {
    return $(element).text();
});

Dynamic event parameters

gaw also supports dynamic parameters via ga-bind.

<div data-ga-category="Featured Models">
  <ul data-ga-action="Clicked Product Category" data-ga-bind-label="@element-text">
    <li data-ga-label>Example 1</li>
    <li data-ga-label>Example 2</li>
  </ul>
</div>
gaw.bind('element-text', function(element) {
    return $(element).text();
});

Parameter prefixes

Global prefixes for each parameter can be declared on parent elements. The following would prefix all category parameters within the div the attribute is declared upon. This is especially useful when combined with bindings.

<div data-ga-category-prefix="language-" data-ga-category="Example Category">
  <ul data-ga-action="Clicked Product Category">
    <li data-ga-label="Example 1">Example 1</li>
    <li data-ga-label="Example 2">Example 2</li>
  </ul>
</div>

API

gaw.bind(keyword, fn)
registers a binding to replace based on the given function

keyword, String, binding name

fn, Function, logic to replace keyword with

gaw.refresh()
refreshes all binds. Useful when elements are added after page load.

gaw.trigger(element)
triggers a click event on the passed element

element, jQuery object, the element to trigger

gaw.push(category, action, label, element)
pushes an event to Google Analytics given non-empty params. Element is optional.

category, String, the event category.

action, String, the event action.

label, String, the event label.

element, Object, the element that triggered the push.

gaw.testMode(set)
toggles stopping of events from propagating to google analytics and disabling link click navigation

set, Boolean
defaults to false

gaw.verbose(set)
toggles verbose logging

set, Boolean
defaults to false

Dependencies

jQuery

Licence

Copyright (c) 2015 Red Lion Canada

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.