govuk_admin_template 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8b45722d3edde572beabb4220b028ef4830f294
-  data.tar.gz: 4c7b2288a16fa72ecb293945ed9470fe36034f03
+  metadata.gz: 2da4cdc6289a8ee886aa81882a5cbd7ae148bd2b
+  data.tar.gz: 2fdf20196a4ca95a87ca1629366626a47ab25df9
 SHA512:
-  metadata.gz: 774dd7c3f83ca6dbf5f0eda5ebbf5c770eee54d3a9df65203f2a6132d82772c53e0a2d2974b447975ca6a4ccab347474ef8d1dbd4a6ecb02a4901e6957b47357
-  data.tar.gz: 679ad2d783007b3b6f6a64bd76f6710a1ed1e12039052dd7852849e49d362b114fded9ca0e7f6181fd24a2f62b7f5a375324ba4265439d229aad37d8fa9d13b3
+  metadata.gz: b8f2c6ba99a0fb45323ea8508dd473352baee9a6026b288d90f84578a79b9327b04165fb763af4734e1e01a8afaf2dfd4f22e2fdc9e40a56262515152123933d
+  data.tar.gz: 64c0bccfc9263304bde2e80d77089e7311b957b27190087106777fc7336b66aeed27c96837a106c64a843db2d51cbd4f9914e7a6490d7d6b8f30ba7fc54e4165

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 3.3.0
+
+* Add track-click module for Analytics tracking of button clicks
+
 # 3.2.0
 
 * Enable sendBeacon for all admin analytics events

data/JAVASCRIPT.md

@@ -104,3 +104,4 @@ confirm.js | `Confirm` | `confirm` | Show a [window.confirm](https://developer.m
 filterable_table.js | `FilterableTable` | `filterable-table` | Filter the contents of a table, showing only matching rows
 fixed_table_header.js | `FixedTableHeader` | `fixed-table-header` | Fix the `<thead>` portion of a table when scrolling offscreen
 toggle.js | `Toggle` | `toggle` | A simple toggle
+track_click.js | `TrackClick` | `track-click` | Track button clicks in Google Anayltics using `sendBeacon`

data/app/assets/javascripts/govuk-admin-template/modules/track_click.js

@@ -0,0 +1,19 @@
+(function(Modules) {
+  "use strict";
+
+  Modules.TrackClick = function() {
+    var that = this;
+
+    that.start = function(container) {
+      var trackClick = function() {
+        var action = container.data("track-action") || "button-pressed",
+            label = $(this).data("track-label") || $(this).text();
+
+        GOVUKAdmin.trackEvent(action, label);
+      };
+
+      container.on("click", ".js-track", trackClick);
+    }
+  };
+
+})(window.GOVUKAdmin.Modules);

data/app/views/govuk_admin_template/style_guide/index.html.erb

@@ -551,3 +551,40 @@
   </div>
 </div>
 <hr>
+
+<h2>Analytics</h2>
+<div class="row">
+  <div class="col-md-6">
+    <h3>Auto Track Events</h3>
+    <p>Adding this module to a page will cause an event to be sent to Google Analytics with
+      a specified action, label and value</p>
+  </div>
+  <div class="col-md-6">
+    <pre class="add-top-margin">&lt;div class=&quot;alert-success&quot;
+     data-module=&quot;auto-track-event&quot;
+     data-track-action=&quot;alert-success&quot;
+     data-track-label=&quot;Logged in successfully&quot;&gt;
+  Logged in successfully
+&lt;/div&gt;</pre>
+  </div>
+</div>
+<div class="row">
+  <div class="col-md-6">
+    <h3>Track Click</h3>
+    <p>This module is intended as an easy way to track individual button/link
+    clicks as events in Google Analytics. Groups of buttons may end up
+    redirecting to the same place, meaning they’re not trackable via URLs
+    in GA. This will use the sendBeacon functionality to fire off an event
+    once the button has been clicked and during navigation.</p>
+    <p>The module should be added to the container of the buttons, where the
+    GA action can be changed from the default of <code>button-pressed</code> using the
+    <code>data-track-action</code> attribute. The label defaults to the link/button
+    text, but can be overridden with <code>data-track-label</code>.</p>
+  </div>
+  <div class="col-md-6">
+    <pre class="add-top-margin">&lt;div data-module=&quot;track-click&quot; data-track-action=&quot;dialog-buttons&quot;&gt;
+  &lt;button class=&quot;js-track&quot;&gt;Yes&lt;/button&gt;
+  &lt;a href=&quot;#&quot; class=&quot;js-track&quot; data-track-label=&quot;No&quot;&gt;Get me out&lt;/a&gt;
+&lt;/div&gt;</pre>
+  </div>
+</div>

data/app/views/layouts/govuk_admin_template.html.erb

@@ -108,6 +108,10 @@
           ga('set', 'anonymizeIp', true);
           ga('send', 'pageview');
         </script>
+      <% else %>
+        <script>
+          if (console) {window.ga = function() {console.log.apply(console, arguments);};}
+        </script>
       <% end %>
     <% end %>
   </body>

data/lib/govuk_admin_template/version.rb

@@ -1,3 +1,3 @@
 module GovukAdminTemplate
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_admin_template
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2015-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -149,6 +149,7 @@ files:
 - app/assets/javascripts/govuk-admin-template/modules/fixed_table_header.js
 - app/assets/javascripts/govuk-admin-template/modules/radio_toggle.js
 - app/assets/javascripts/govuk-admin-template/modules/toggle.js
+- app/assets/javascripts/govuk-admin-template/modules/track_click.js
 - app/assets/javascripts/govuk-admin-template/vendor/html5.js
 - app/assets/javascripts/govuk-admin-template/vendor/respond.min.js
 - app/assets/javascripts/lte-ie8.js