govuk_publishing_components 21.9.0 → 21.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d362c075a89db5f3d1587d72e9a3d0c8070cbe2713a35b778fdb3d545b36e487
-  data.tar.gz: 1dc4a84c352fc5b14dcbf4f56d983c6d4393dd2fbbaca7e8bebb32ebe01c4520
+  metadata.gz: f3b714e4ac16dcb7d35863086c6f857ef31d142bfcc7b80f3fece4a113b96bd7
+  data.tar.gz: 8268154d670cdcfdc51009609e2724c9695dfa5e2f8a782133917dbdf3ab26cb
 SHA512:
-  metadata.gz: 3a824a6145852638cedcd298c05e21298a79e23c12773f1e5cf331767ecd23966981d6cfa9e698c6e3f576ddcb22ebc92485fb1328e3eba3f20430a80705172e
-  data.tar.gz: 7531c820a83f0132b353e5a35fdba7095f0f1a49f9899cdd26a7c99212da6fcb052e030d03488da7dfc16533a28210ac3f206c38d5c9060be8c37e778371180a
+  metadata.gz: 98c6cc5de694a0496ff98451e8f7a56317b92747b8c0266ca4fb4f43365731d393008fd17f87a9be00e93efa7d7e53203f9c1bd639c6bf2b28e58885950a0c24
+  data.tar.gz: 58b9b92e675013a7c65baa7a91e7d5b9c8cd3c673fa22a13b3bfa75429fdbbe527139b2efb88874d0ab0ed7bfc52d83d4a90414a43fbe5d2d1f4004c621fd3cd

data/app/assets/javascripts/govuk_publishing_components/components/details.js

@@ -0,0 +1,48 @@
+/* eslint-env jquery */
+// = require govuk/components/details/details.js
+window.GOVUK = window.GOVUK || {}
+window.GOVUK.Modules = window.GOVUK.Modules || {};
+
+(function (Modules) {
+  'use strict'
+
+  Modules.GovukDetails = function () {
+    this.start = function (element) {
+      var customTrackLabel = element[0].getAttribute('data-track-label')
+
+      // If a custom label has been provided, we can simply call the tracking module
+      if (customTrackLabel) {
+        var trackDetails = new window.GOVUK.Modules.TrackClick()
+        trackDetails.start(element)
+      } else {
+        // If no custom label is set, we use the open/close status as the label
+        var detailsComponent = element[0]
+        var detailsClick = detailsComponent.querySelector('[data-details-track-click]')
+        var that = this
+
+        $(detailsClick).click(function (e) {
+          that.trackDefault(detailsComponent)
+        })
+      }
+    }
+
+    this.trackDefault = function (element) {
+      if (window.GOVUK.analytics && window.GOVUK.analytics.trackEvent) {
+        var componentStatus = (element.getAttribute('open') == null) ? 'open' : 'closed'
+        var trackCategory = element.getAttribute('data-track-category')
+        var trackAction = element.getAttribute('data-track-action')
+        var trackOptions = element.getAttribute('data-track-options')
+
+        if (typeof trackOptions !== 'object' || trackOptions === null) {
+          trackOptions = {}
+        }
+
+        trackOptions['label'] = componentStatus
+
+        if (trackAction && trackCategory) {
+          window.GOVUK.analytics.trackEvent(trackCategory, trackAction, trackOptions)
+        }
+      }
+    }
+  }
+})(window.GOVUK.Modules)

data/app/views/govuk_publishing_components/components/_details.html.erb

@@ -10,7 +10,7 @@
   data_attributes[:module] = 'govuk-details'
 %>
 <%= tag.details class: css_classes, data: data_attributes, open: open do %>
-  <summary class="govuk-details__summary">
+  <summary class="govuk-details__summary" data-details-track-click>
     <span class="govuk-details__summary-text">
       <%= title %>
     </span>

data/app/views/govuk_publishing_components/components/docs/details.yml

@@ -22,6 +22,18 @@ examples:
       block: |
         We need to know your nationality so we can work out which elections you’re entitled to vote in. If you can’t provide your nationality, you’ll have to send copies of identity documents through the post.
   with_data_attributes:
+    description: Can be used for tracking. By default, `track-label` is set to the status ("open" or "closed") unless a track_label is passed into the component.
+    data:
+      title: Help with nationality
+      data_attributes:
+        track_category: "checker-qa"
+        track_action: "business-question"
+        track_label: "custom label here"
+        track_options:
+          dimension20: "custom dimension"
+      block: |
+        We need to know your nationality so we can work out which elections you’re entitled to vote in. If you can’t provide your nationality, you’ll have to send copies of identity documents through the post.
+  with_GTM_tracking:
     data:
       title: Help with nationality
       data_attributes:

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '21.9.0'.freeze
+  VERSION = '21.10.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 21.9.0
+  version: 21.10.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2019-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
@@ -405,6 +405,7 @@ files:
 - app/assets/javascripts/govuk_publishing_components/components/contextual-guidance.js
 - app/assets/javascripts/govuk_publishing_components/components/cookie-banner.js
 - app/assets/javascripts/govuk_publishing_components/components/copy-to-clipboard.js
+- app/assets/javascripts/govuk_publishing_components/components/details.js
 - app/assets/javascripts/govuk_publishing_components/components/error-summary.js
 - app/assets/javascripts/govuk_publishing_components/components/feedback.js
 - app/assets/javascripts/govuk_publishing_components/components/govspeak.js