govuk_publishing_components 35.1.1 → 35.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da29b78f56ceabe774802deed6b8570f0459ba1414b60d0a46b1c891facb5b25
-  data.tar.gz: 2b431b2babeb7dc74281f27b13f23525b658d8cace7727ed08658945d0669763
+  metadata.gz: 0f87c9fa99d845d53392c5a02a8c4330f7a9557b94290a55cc18b5f169862215
+  data.tar.gz: ee6d97596ccbc7cfc9704f95dd3b1940e6b60254fc3fe7f6c51d5d6c16d1ead4
 SHA512:
-  metadata.gz: 74a753d9e83276ae6c71bf0ce682a8cfd269195adda6ca9d04188d729f19da63103de4a31285902a5195b87762921a905adb91acf5674a19e1b0e90a9b3c5f6d
-  data.tar.gz: 17a2048555b604f03a55ab8756c9a33a8b1324b8c2db8944868264d06526e1e01fd2ced69b3fb06746be8252e32aaeb0d7b2a28ae005b0ccd082986f5b408d4a
+  metadata.gz: 635eaae4b3ce872688184197dd240be9751f6d9286680f324a876cea3d00a9bfa0b6037b5817fbf58a66d319510dcbca747ff5c7bc69e5d76a7c33cb345963cb
+  data.tar.gz: 595feac64b2542ef4ff5cb669e7e12462cea78d250cb0d44f01312de9297379d0e2c9f4d8bff0ab75a59a3b523fd6d801df93518f4c407c600b87695c17c1ea8

data/app/assets/javascripts/component_guide/application.js

@@ -2,4 +2,5 @@
 //= require_tree .
 //= require ../govuk_publishing_components/dependencies
 //= require ../govuk_publishing_components/components/accordion
+//= require ../govuk_publishing_components/components/intervention
 //= require ../govuk_publishing_components/components/tabs

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

@@ -230,13 +230,18 @@ window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {};
           // Only index links that are not search results
           if (!link.getAttribute('data-ga4-ecommerce-path')) {
             totalLinks++
-            link.setAttribute('data-ga4-index', totalLinks)
+            link.setAttribute('data-ga4-index', '{"index_link": ' + totalLinks + '}')
           }
         }
 
-        var ga4LinkData = JSON.parse(module.getAttribute('data-ga4-link'))
-        ga4LinkData.index_total = totalLinks
-        module.setAttribute('data-ga4-link', JSON.stringify(ga4LinkData))
+        try {
+          var ga4LinkData = JSON.parse(module.getAttribute('data-ga4-link'))
+          ga4LinkData.index_total = totalLinks
+          module.setAttribute('data-ga4-link', JSON.stringify(ga4LinkData))
+        } catch (e) {
+          // if there's a problem with the config, don't start the tracker
+          console.error('Unable to JSON.parse or JSON.stringify index: ' + e.message, window.location)
+        }
       },
 
       // index is given as a string of the form 1.2.3 or 1.2
@@ -268,6 +273,31 @@ window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {};
               index_link: parseInt(index[2])
             }
         }
+      },
+
+      addAttributesToElements: function (selector, dataAttributes) {
+        var targetElements = document.querySelectorAll(selector)
+
+        for (var i = 0; i < targetElements.length; i++) {
+          var element = targetElements[i]
+
+          for (var j = 0; j < dataAttributes.length; j++) {
+            var key = dataAttributes[j].key
+            var value = dataAttributes[j].value
+
+            // value must check for undefined only as it would return false on an empty string, the number 0, etc.
+            if (key && value !== undefined) {
+              var existingAttributeValue = element.getAttribute(key)
+
+              if (key === 'data-module' && existingAttributeValue) {
+                // Combines values to prevent replacing any existing data-module values.
+                element.setAttribute(key, existingAttributeValue + ' ' + value)
+              } else {
+                element.setAttribute(key, value)
+              }
+            }
+          }
+        }
       }
     },
 

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

@@ -87,8 +87,7 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
       data.link_path_parts = window.GOVUK.analyticsGa4.core.trackFunctions.populateLinkPathParts(data.url)
       data.method = window.GOVUK.analyticsGa4.core.trackFunctions.getClickType(event)
       data.external = window.GOVUK.analyticsGa4.core.trackFunctions.isExternalLink(data.url) ? 'true' : 'false'
-      data.index = event.target.getAttribute('data-ga4-index') ? parseInt(event.target.getAttribute('data-ga4-index')) : data.index || undefined
-      data.index = window.GOVUK.analyticsGa4.core.trackFunctions.createIndexObject(data.index)
+      data.index = this.setIndex(data.index, event.target)
 
       if (data.type === 'smart answer' && data.action === 'change response') {
         data.section = PIIRemover.stripPIIWithOverride(data.section, true, true)
@@ -108,5 +107,24 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
     }
   }
 
+  Ga4LinkTracker.prototype.setIndex = function (indexData, target) {
+    var index = window.GOVUK.analyticsGa4.core.trackFunctions.createIndexObject(indexData)
+
+    if (target.getAttribute('data-ga4-index')) {
+      try {
+        var indexLink = JSON.parse(target.getAttribute('data-ga4-index'))
+
+        // Check whether the index object already exists on a parent element, as is the case with tracking accordion links.
+        // If true, combine data-ga4-index with the index object. Otherwise, just return indexLink
+        index = index ? window.GOVUK.extendObject(index, indexLink) : indexLink
+      } catch (e) {
+        console.error('Unable to parse index as JSON: ' + e.message, window.location)
+        return
+      }
+    }
+
+    return index
+  }
+
   Modules.Ga4LinkTracker = Ga4LinkTracker
 })(window.GOVUK.Modules)

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

@@ -8,6 +8,11 @@ var initFunction = function () {
     window.GOVUK.analyticsGa4.vars.internalDomains = []
     window.GOVUK.analyticsGa4.vars.internalDomains.push(window.GOVUK.analyticsGa4.core.trackFunctions.getHostname())
     window.GOVUK.analyticsGa4.core.trackFunctions.appendDomainsWithoutWWW(window.GOVUK.analyticsGa4.vars.internalDomains)
+    var attachmentLinkData = [
+      { key: 'data-module', value: 'ga4-link-tracker' },
+      { key: 'data-ga4-track-links-only', value: '' },
+      { key: 'data-ga4-link', value: JSON.stringify({ event_name: 'navigation', type: 'html attachment' }) }]
+    window.GOVUK.analyticsGa4.core.trackFunctions.addAttributesToElements('[data-ga4-attachment-link]', attachmentLinkData)
     window.GOVUK.analyticsGa4.core.load()
 
     var analyticsModules = window.GOVUK.analyticsGa4.analyticsModules

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

@@ -0,0 +1,69 @@
+window.GOVUK = window.GOVUK || {}
+window.GOVUK.Modules = window.GOVUK.Modules || {};
+
+(function (Modules) {
+  function Intervention ($module) {
+    this.$module = $module
+    this.$closeLink = this.$module.querySelector('.js-dismiss-link')
+    this.$campaignName = this.$module.getAttribute('data-intervention-name')
+    this.$campaignCookie = window.GOVUK.cookie('intervention_campaign') || ''
+  }
+
+  Intervention.prototype.init = function () {
+    this.$cookieHasCampaign = this.cookieHasCampaign()
+
+    if (this.$closeLink) {
+      this.$module.close = this.handleClose.bind(this)
+      this.$closeLink.addEventListener('click', this.$module.close)
+    }
+
+    if (this.$cookieHasCampaign) {
+      this.hideBanner()
+    }
+  }
+
+  Intervention.prototype.handleClose = function (event) {
+    event.preventDefault()
+
+    if (this.$cookieHasCampaign) {
+      this.setCookies()
+    }
+    this.hideBanner()
+  }
+
+  Intervention.prototype.cookieHasCampaign = function () {
+    if (this.$campaignCookie) {
+      return this.cookieValues().includes(this.$campaignName)
+    }
+    return false
+  }
+
+  Intervention.prototype.cookieValues = function () {
+    if (this.$campaignCookie !== null && this.$campaignCookie.length > 0) {
+      return this.$campaignCookie.split(',')
+    }
+  }
+
+  Intervention.prototype.appendCookieValues = function () {
+    return this.$campaignCookie + ',' + this.$campaignName
+  }
+
+  Intervention.prototype.setCookies = function () {
+    if (this.$campaignCookie) {
+      window.GOVUK.setCookie('intervention_campaign', this.appendCookieValues(), { days: 30 })
+    } else {
+      window.GOVUK.setCookie('intervention_campaign', this.$campaignName, { days: 30 })
+    }
+  }
+
+  Intervention.prototype.hideBanner = function () {
+    if (!this.$cookieHasCampaign) {
+      this.setCookies()
+    }
+
+    this.$module.hidden = true
+    this.$module.style.display = 'none'
+  }
+
+  Modules.Intervention = Intervention
+})(window.GOVUK.Modules)

data/app/assets/javascripts/govuk_publishing_components/components/step-by-step-nav.js

@@ -196,8 +196,11 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
           event_name: 'select_content',
           type: 'step by step',
           text: titleText.trim(),
-          index: i + 1,
-          index_total: this.$module.totalSteps
+          index: {
+            index_section: i + 1,
+            index_section_count: this.$module.totalSteps
+          },
+          index_total: thisel.querySelectorAll('a').length
         }
 
         var button = thisel.querySelector('.js-step-title-button')

data/app/assets/javascripts/govuk_publishing_components/lib/cookie-functions.js

@@ -17,6 +17,7 @@
     cookie_preferences_set: 'essential',
     cookies_preferences_set: 'essential',
     '_email-alert-frontend_session': 'essential',
+    intervention_campaign: 'essential',
     licensing_session: 'essential',
     govuk_contact_referrer: 'essential',
     multivariatetest_cohort_coronavirus_extremely_vulnerable_rate_limit: 'essential',