govuk_publishing_components 29.7.0 → 29.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b74221682d0047e390f314e968edf8acd3b89efebfe41d833239d9ca44413c86
-  data.tar.gz: 1f87c5a4288b2a69da1e32598422162bc5017f2dab4ac577b326b582cbd9e8e9
+  metadata.gz: c90f6280f1c3ce88606be0f030883575971e8fd8447cac1b353b2e1163221b63
+  data.tar.gz: 79e9a7c4d8f262fd3dd65d504aabcbff63cf7228479a540f7fb187cf4383e8fa
 SHA512:
-  metadata.gz: 14d60ae3e9876edbbcac836010f6dbfd1655c3be4798119f79ac064cb70cfef71a612694d7b31ae6475c31f9813ca9d7775fb1ab3b3153707643bd61190e057d
-  data.tar.gz: 4e69c991fd6db0d47136d6a7e489fd516e1aa9c62b1422ccf87ed35164e7f6641a60fd64392281f5c99b84c4b9caef8be78bbd73faa922b604d27c227ec7080f
+  metadata.gz: 036a6a9d2e713632f5f8ca68b997017cf728dbf7f0dfa46709762b185ee32d576526bcad7ebbb453a0a8feb9e809c95dd5e86bf20d91d35293b2009fd972f0b3
+  data.tar.gz: 876823d94cae4f3fbbcc4a8e5c178a35e0d9c90b8ea5f0d29b8e9ec737097d9764608f3dbfea13f7d8ae8aa252c07f33fba46e53638cc249b1f20c86e0c99cc6

data/app/assets/javascripts/govuk_publishing_components/analytics/explicit-cross-domain-links.js

@@ -1,89 +1,88 @@
-;(function (global) {
-  'use strict'
-
-  var GOVUK = global.GOVUK || {}
-  GOVUK.Modules = GOVUK.Modules || {}
-
-  GOVUK.Modules.ExplicitCrossDomainLinks = function () {
-    this.start = function ($module) {
-      this.element = $module[0]
-      this.attribute = 'href'
-      this.attributeValue = this.element.getAttribute(this.attribute)
-      this.eventType = 'click'
-      if (!this.attributeValue) {
-        this.attribute = 'action'
-        this.attributeValue = this.element.getAttribute(this.attribute)
-        this.eventType = 'submit'
-      }
-
-      this.handleEvent = this.handleEvent.bind(this)
-      this.handleCookiesAccepted = this.handleCookiesAccepted.bind(this)
-      // Listens for the 'submit' event if the element is a form, and the 'click' event if it is a link
-      this.element.addEventListener(this.eventType, this.handleEvent)
-    }
+window.GOVUK = window.GOVUK || {}
+window.GOVUK.Modules = window.GOVUK.Modules || {};
+
+(function (Modules) {
+  function ExplicitCrossDomainLinks ($module) {
+    this.$module = $module
+  }
 
-    this.handleEvent = function (e) {
-      //  prevent default: we want the link href and/or form action to be decorated before we navigate away
-      e.preventDefault()
-      var cookieBannerEngaged = GOVUK.cookie('cookies_preferences_set')
-      var cookieConsent = GOVUK.getConsentCookie()
-
-      if (cookieBannerEngaged !== 'true') {
-        // If not engaged, append only ?cookie_consent=not-engaged
-        this.decorate(this.element, 'cookie_consent=not-engaged', this.attribute)
-      } else if (cookieConsent && cookieConsent.usage === true) {
-        this.handleCookiesAccepted()
-      } else {
-        this.decorate(this.element, 'cookie_consent=reject', this.attribute)
-      }
-
-      // remove the event listener to avoid an infinite loop
-      this.element.removeEventListener(this.eventType, this.handleEvent)
-
-      // if the element is a form, submit it. If it is a link, click it
-      if (this.eventType === 'submit') {
-        this.element.submit()
-      } else {
-        this.element.click()
-      }
+  ExplicitCrossDomainLinks.prototype.init = function () {
+    this.attribute = 'href'
+    this.attributeValue = this.$module.getAttribute(this.attribute)
+    this.eventType = 'click'
+    if (!this.attributeValue) {
+      this.attribute = 'action'
+      this.attributeValue = this.$module.getAttribute(this.attribute)
+      this.eventType = 'submit'
     }
 
-    this.handleCookiesAccepted = function () {
-      // If the cookie banner was engaged and usage cookie accepted, append ?_ga=clientid if available and cookie_consent=accept
-      var element = this.element
-      var attribute = this.attribute
-      this.decorate(element, 'cookie_consent=accept', attribute)
+    this.handleEvent = this.handleEvent.bind(this)
+    this.handleCookiesAccepted = this.handleCookiesAccepted.bind(this)
+    // Listens for the 'submit' event if the element is a form, and the 'click' event if it is a link
+    this.$module.addEventListener(this.eventType, this.handleEvent)
+  }
 
-      if (!global.ga) {
-        return
-      }
+  ExplicitCrossDomainLinks.prototype.decorate = function (element, param, attribute) {
+    var attributeValue = element.getAttribute(attribute)
 
-      global.ga(function () {
-        var trackers = global.ga.getAll()
+    if (!attributeValue) { return }
 
-        if (!trackers.length) { return }
+    if (attributeValue.indexOf('?') !== -1) {
+      attributeValue += '&' + param
+    } else {
+      attributeValue += '?' + param
+    }
 
-        var linker = new global.gaplugins.Linker(trackers[0])
-        var attrValue = element.getAttribute(attribute)
+    element.setAttribute(attribute, attributeValue)
+  }
 
-        element.setAttribute(attribute, linker.decorate(attrValue))
-      })
+  ExplicitCrossDomainLinks.prototype.handleEvent = function (e) {
+    //  prevent default: we want the link href and/or form action to be decorated before we navigate away
+    e.preventDefault()
+    var cookieBannerEngaged = window.GOVUK.cookie('cookies_preferences_set')
+    var cookieConsent = window.GOVUK.getConsentCookie()
+
+    if (cookieBannerEngaged !== 'true') {
+      // If not engaged, append only ?cookie_consent=not-engaged
+      this.decorate(this.$module, 'cookie_consent=not-engaged', this.attribute)
+    } else if (cookieConsent && cookieConsent.usage === true) {
+      this.handleCookiesAccepted()
+    } else {
+      this.decorate(this.$module, 'cookie_consent=reject', this.attribute)
     }
 
-    this.decorate = function (element, param, attribute) {
-      var attributeValue = element.getAttribute(attribute)
+    // remove the event listener to avoid an infinite loop
+    this.$module.removeEventListener(this.eventType, this.handleEvent)
 
-      if (!attributeValue) { return }
+    // if the element is a form, submit it. If it is a link, click it
+    if (this.eventType === 'submit') {
+      this.$module.submit()
+    } else {
+      this.$module.click()
+    }
+  }
 
-      if (attributeValue.indexOf('?') !== -1) {
-        attributeValue += '&' + param
-      } else {
-        attributeValue += '?' + param
-      }
+  ExplicitCrossDomainLinks.prototype.handleCookiesAccepted = function () {
+    // If the cookie banner was engaged and usage cookie accepted, append ?_ga=clientid if available and cookie_consent=accept
+    var element = this.$module
+    var attribute = this.attribute
+    this.decorate(element, 'cookie_consent=accept', attribute)
 
-      element.setAttribute(attribute, attributeValue)
+    if (!window.ga) {
+      return
     }
+
+    window.ga(function () {
+      var trackers = window.ga.getAll()
+
+      if (!trackers.length) { return }
+
+      var linker = new window.gaplugins.Linker(trackers[0])
+      var attrValue = element.getAttribute(attribute)
+
+      element.setAttribute(attribute, linker.decorate(attrValue))
+    })
   }
 
-  global.GOVUK = GOVUK
-})(window)
+  Modules.ExplicitCrossDomainLinks = ExplicitCrossDomainLinks
+})(window.GOVUK.Modules)

data/app/assets/javascripts/govuk_publishing_components/analytics/page-content.js

@@ -13,6 +13,10 @@
         return document.querySelectorAll('[data-track-count="accordionSection"]').length
       case isDocumentCollectionPage():
         return document.querySelectorAll('.document-collection .group-title').length
+      case isNewBrowsePageLevelTwo():
+        // if there are no accordion sections on the browse level 2 page
+        // then it is a default page with one or two lists
+        return document.querySelectorAll('[data-track-count="accordionSection"]').length || document.querySelectorAll('main .govuk-list').length
       case isNewBrowsePage():
         return document.querySelectorAll('[data-track-count="cardList"]').length
       case isMainstreamBrowsePage():
@@ -46,6 +50,8 @@
         return document.querySelectorAll('a[data-track-category="navAccordionLinkClicked"]').length
       case isDocumentCollectionPage():
         return document.querySelectorAll('.document-collection .group-document-list li a').length
+      case isNewBrowsePageLevelTwo():
+        return document.querySelectorAll('[data-track-count="contentLink"]').length
       case isNewBrowsePage():
         return document.querySelectorAll('[data-track-count="cardLink"]').length
       case isMainstreamBrowsePage():
@@ -71,7 +77,6 @@
   var metaApplicationSelector = 'meta[name="govuk:rendering-application"]'
   var metaFormatSelector = 'meta[name="govuk:format"]'
   var metaNavigationTypeSelector = 'meta[name="govuk:navigation-page-type"]'
-  var metaSectionSelector = 'meta[name="govuk:section"]'
 
   function getMetaAttribute (selector) {
     var element = document.querySelector(selector)
@@ -98,9 +103,15 @@
       getMetaAttribute(metaNavigationTypeSelector) === 'leaf'
   }
 
+  function isNewBrowsePageLevelTwo () {
+    return getMetaAttribute(metaApplicationSelector) === 'collections' &&
+      getMetaAttribute(metaNavigationTypeSelector) === 'browse level 2'
+  }
+
   function isNewBrowsePage () {
     return getMetaAttribute(metaApplicationSelector) === 'collections' &&
-      getMetaAttribute(metaSectionSelector) === 'new_browse_page' &&
+      (getMetaAttribute(metaNavigationTypeSelector) === 'browse level 0' ||
+       getMetaAttribute(metaNavigationTypeSelector) === 'browse level 1') &&
       getMetaAttribute(metaFormatSelector) === 'mainstream_browse_page'
   }
 

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/gtm-click-tracking.js

@@ -0,0 +1,49 @@
+window.GOVUK = window.GOVUK || {}
+window.GOVUK.Modules = window.GOVUK.Modules || {};
+
+(function (Modules) {
+  'use strict'
+
+  function GtmClickTracking (module) {
+    this.module = module
+    this.trackingTrigger = 'data-gtm-event-name' // elements with this attribute get tracked
+  }
+
+  GtmClickTracking.prototype.init = function () {
+    var trackClicksOn = [this.module]
+    if (!this.module.getAttribute(this.trackingTrigger)) {
+      trackClicksOn = this.module.querySelectorAll('[' + this.trackingTrigger + ']')
+    }
+
+    for (var i = 0; i < trackClicksOn.length; i++) {
+      trackClicksOn[i].addEventListener('click', this.trackClick.bind(this))
+    }
+  }
+
+  GtmClickTracking.prototype.trackClick = function (event) {
+    if (window.dataLayer) {
+      var target = event.currentTarget
+      var data = {
+        event: 'analytics',
+        event_name: target.getAttribute('data-gtm-event-name'),
+        // get entire URL apart from domain
+        link_url: window.location.href.substring(window.location.origin.length),
+        ui: JSON.parse(target.getAttribute('data-gtm-attributes'))
+      }
+      var ariaExpanded = this.checkExpandedState(target)
+      if (ariaExpanded) {
+        data.ui.state = ariaExpanded === 'false' ? 'opened' : 'closed'
+      }
+      window.dataLayer.push(data)
+    }
+  }
+
+  GtmClickTracking.prototype.checkExpandedState = function (clicked) {
+    var expanded = clicked.querySelector('[aria-expanded]')
+    if (expanded) {
+      return expanded.getAttribute('aria-expanded')
+    }
+  }
+
+  Modules.GtmClickTracking = GtmClickTracking
+})(window.GOVUK.Modules)

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4.js

@@ -0,0 +1 @@
+//= require ./analytics-ga4/gtm-click-tracking

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

@@ -131,7 +131,6 @@ window.GOVUK.Modules.GovukAccordion = window.GOVUKFrontend.Accordion;
 
     if (window.GOVUK.analytics && window.GOVUK.analytics.trackEvent) {
       window.GOVUK.analytics.trackEvent('pageElementInteraction', action, options)
-      console.log('pageElementInteraction', action, options)
     }
   }
 

data/app/assets/javascripts/govuk_publishing_components/modules.js

@@ -35,7 +35,6 @@
         for (var j = 0, k = moduleNames.length; j < k; j++) {
           var moduleName = camelCaseAndCapitalise(moduleNames[j])
           var started = element.getAttribute('data-' + moduleNames[j] + '-module-started')
-
           if (typeof GOVUK.Modules[moduleName] === 'function' && !started) {
             // Vanilla JavaScript GOV.UK Modules and GOV.UK Frontend Modules
             if (GOVUK.Modules[moduleName].prototype.init) {

data/app/assets/javascripts/govuk_publishing_components/vendor/lux/lux-measurer.js

@@ -157,3 +157,40 @@ if (
     LongTaskObserver.observe({ type: ["longtask"] });
   } catch (e) {}
 }
+
+// As per RFC 147[1], this adds in monitoring of the type of HTTP protocol that
+// is used when a browser loads a page.
+//
+// The User Timing API (aka window.performance) is used to record the data - to
+// avoid the use of this from breaking the JavaScript for the small number of
+// browsers that don't support it, it's been wrapped in a try/catch block plus a
+// couple of checks to prevent "is not defined" errors.
+//
+// Because the `nextHopProtocol` isn't immediately available - it seems to need
+// a request to be made before it's populated - we need to wait for the
+// `DOMContentReady` event before we can see what the HTTP version is.
+//
+// [1]: https://github.com/alphagov/govuk-rfcs/pull/148
+
+var measureHTTPProtocol = function () {
+  var getEntriesByType = performance.getEntriesByType('navigation')
+
+  if (getEntriesByType.length > 0) {
+    var httpProtocol = JSON.parse(JSON.stringify(performance.getEntriesByType('navigation')[0].nextHopProtocol))
+    LUX.addData("http-protocol", httpProtocol)
+  }
+}
+
+try {
+  if (typeof performance !== 'undefined' && typeof performance.getEntriesByType !== 'undefined') {
+    if (document.readyState === 'complete') {
+      measureHTTPProtocol()
+    } else {
+      window.addEventListener('load', function() {
+        measureHTTPProtocol()
+      })
+    }
+  }
+} catch (e) {
+  console.error('Error in LUX reporting the HTTP protocol (' + window.location + '):', e)
+}