govuk_publishing_components 40.1.0 → 41.0.0

data/app/assets/javascripts/govuk_publishing_components/analytics/auto-scroll-tracker.js

@@ -1,221 +0,0 @@
-window.GOVUK = window.GOVUK || {}
-window.GOVUK.Modules = window.GOVUK.Modules || {}
-window.GOVUK.analyticsVars = window.GOVUK.analyticsVars || {};
-
-(function (Modules) {
-  function AutoScrollTracker ($module) {
-    this.$module = $module
-    this.pageHeight = document.querySelector('body').clientHeight
-    this.trackedNodes = []
-    this.config = {
-      allowHeadingsInside: ['main'],
-      percentages: [20, 40, 60, 80, 100],
-      scrollTimeoutDelay: 20,
-      resizeTimeoutDelay: 100,
-      pageHeightTimeoutDelay: 500
-    }
-  }
-
-  AutoScrollTracker.prototype.init = function () {
-    var consentCookie = window.GOVUK.getConsentCookie()
-
-    if (consentCookie && consentCookie.usage) {
-      this.startModule()
-    } else {
-      this.start = this.startModule.bind(this)
-      window.addEventListener('cookie-consent', this.start)
-    }
-  }
-
-  AutoScrollTracker.prototype.startModule = function () {
-    window.removeEventListener('cookie-consent', this.start)
-    if (window.GOVUK.analyticsVars.scrollTrackerStarted) {
-      return
-    }
-
-    this.trackType = this.$module.getAttribute('data-track-type')
-    var trackHeadings = this.$module.getAttribute('data-track-headings')
-    if (trackHeadings) {
-      try {
-        this.config.trackHeadings = JSON.parse(trackHeadings)
-      } catch (e) {
-        // if there's a problem with the config, don't start the tracker
-        console.error('Scroll tracker configuration error: ' + e.message, window.location)
-        window.GOVUK.analyticsVars.scrollTrackerStarted = false
-        return
-      }
-    }
-
-    window.GOVUK.analyticsVars.scrollTrackerStarted = true
-
-    if (this.trackType === 'headings') {
-      this.track = new AutoScrollTracker.Heading(this.config)
-    } else {
-      this.track = new AutoScrollTracker.Percentage(this.config)
-    }
-
-    this.getWindowDetails()
-    // if the URL has a hash we want to prevent tracking on initial page load
-    // until the browser jumps down the page, at which point a scroll event
-    // will happen and tracking will continue normally
-    var windowHash = window.location.hash
-    var dontTrackOnLoad = windowHash && document.getElementById(windowHash.substring(1))
-    if (!dontTrackOnLoad) {
-      this.trackVisibleNodes()
-    }
-
-    if (this.trackedNodes.length) {
-      // store event listener functions as variables so they can be removed if needed
-      this.scrollEvent = this.onScroll.bind(this)
-      window.addEventListener('scroll', this.scrollEvent)
-      this.resizeEvent = this.onResize.bind(this)
-      window.addEventListener('resize', this.resizeEvent)
-
-      // check if the page height changes e.g. accordion opened
-      this.interval = window.setInterval(function () {
-        var pageHeight = document.querySelector('body').clientHeight
-        if (pageHeight !== this.pageHeight) {
-          this.pageHeight = pageHeight
-          this.getWindowDetails()
-          this.trackVisibleNodes()
-        }
-      }.bind(this), this.config.pageHeightTimeoutDelay)
-    }
-  }
-
-  AutoScrollTracker.prototype.onScroll = function () {
-    clearTimeout(this.scrollTimeout)
-    this.scrollTimeout = setTimeout(function () {
-      this.trackVisibleNodes()
-    }.bind(this), this.config.scrollTimeoutDelay)
-  }
-
-  AutoScrollTracker.prototype.onResize = function () {
-    clearTimeout(this.resizeTimeout)
-    this.resizeTimeout = setTimeout(function () {
-      this.getWindowDetails()
-      this.trackVisibleNodes()
-    }.bind(this), this.config.resizeTimeoutDelay)
-  }
-
-  AutoScrollTracker.prototype.getWindowDetails = function () {
-    this.pageHeight = document.querySelector('body').clientHeight
-    this.windowHeight = window.innerHeight
-    this.trackedNodes = this.track.getTrackingNodes(this.trackedNodes)
-  }
-
-  AutoScrollTracker.prototype.trackVisibleNodes = function () {
-    for (var i = 0; i < this.trackedNodes.length; i++) {
-      var node = this.trackedNodes[i]
-      if (this.isVisible(node.top, node.bottom) && !node.alreadySeen) {
-        node.alreadySeen = true
-        // we store whether a heading has been tracked or not on the heading
-        // because if headings appear/disapper (e.g. inside an accordion)
-        // the order changes, so we can't refer to the previous trackedNodes
-        // as we do with percentages
-        if (node.node) {
-          node.node.setAttribute('data-autoscrolltracker-already-seen', true)
-        }
-
-        var action = node.eventData.action
-        var label = node.eventData.label
-
-        if (window.GOVUK.analytics && window.GOVUK.analytics.trackEvent) {
-          window.GOVUK.analytics.trackEvent('ScrollTo', action, { label: label, nonInteraction: true })
-        }
-      }
-    }
-  }
-
-  AutoScrollTracker.prototype.isVisible = function (top, bottom) {
-    var scroll = window.scrollY || document.documentElement.scrollTop // IE fallback
-    return scroll <= top && (scroll + this.windowHeight) >= bottom
-  }
-
-  AutoScrollTracker.Heading = function (config) {
-    this.config = config
-  }
-
-  AutoScrollTracker.Heading.prototype.getTrackingNodes = function () {
-    var headingsDetails = []
-    var headingsFound = this.findAllowedHeadings()
-
-    for (var i = 0; i < headingsFound.length; i++) {
-      var heading = headingsFound[i]
-      // only track headings that are visible i.e. not inside display: none
-      if (this.visible(heading)) {
-        var pos = heading.getBoundingClientRect()
-        headingsDetails.push({
-          node: heading,
-          alreadySeen: heading.getAttribute('data-autoscrolltracker-already-seen'),
-          top: pos.top + document.documentElement.scrollTop,
-          bottom: pos.bottom + document.documentElement.scrollTop,
-          eventData: { action: 'Heading', label: heading.textContent.replace(/\s+/g, ' ').trim() }
-        })
-      }
-    }
-    return headingsDetails
-  }
-
-  // check heading is inside allowed elements, generally ignores everything outside of page content
-  AutoScrollTracker.Heading.prototype.findAllowedHeadings = function () {
-    var headingsFound = []
-    var headings = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6']
-    var trackHeadings = this.config.trackHeadings
-
-    // this is a loop that only happens once as we currently only have one
-    // allowed element for headings to be in - 'main'
-    for (var h = 0; h < this.config.allowHeadingsInside.length; h++) {
-      var insideElements = document.querySelectorAll(this.config.allowHeadingsInside[h])
-      for (var e = 0; e < insideElements.length; e++) {
-        var found = insideElements[e].querySelectorAll(headings)
-        for (var f = 0; f < found.length; f++) {
-          if (trackHeadings) {
-            if (trackHeadings.includes(found[f].textContent.trim())) {
-              headingsFound.push(found[f])
-            }
-          } else {
-            headingsFound.push(found[f])
-          }
-        }
-      }
-    }
-    return headingsFound
-  }
-
-  // this is bit more verbose than checking offsetParent !== null but more reliable for IE10+
-  AutoScrollTracker.Heading.prototype.visible = function (el) {
-    return !!(el.offsetWidth || el.offsetHeight || el.getClientRects().length)
-  }
-
-  AutoScrollTracker.Percentage = function (config) {
-    this.config = config
-  }
-
-  AutoScrollTracker.Percentage.prototype.getTrackingNodes = function (trackedNodes) {
-    var body = document.body
-    var html = document.documentElement
-    var pageHeight = Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight)
-
-    var percentDetails = []
-
-    for (var i = 0; i < this.config.percentages.length; i++) {
-      var percent = this.config.percentages[i]
-      // subtract 1 pixel to solve a bug where 100% can't be reached in some cases
-      var pos = ((pageHeight / 100) * percent) - 1
-      var alreadySeen = false
-      if (trackedNodes.length) {
-        alreadySeen = trackedNodes[i].alreadySeen
-      }
-      percentDetails.push({
-        alreadySeen: alreadySeen,
-        top: pos,
-        bottom: pos,
-        eventData: { action: 'Percent', label: String(percent) }
-      })
-    }
-    return percentDetails
-  }
-
-  Modules.AutoScrollTracker = AutoScrollTracker
-})(window.GOVUK.Modules)

data/app/assets/javascripts/govuk_publishing_components/analytics/auto-track-event.js

@@ -1,30 +0,0 @@
-window.GOVUK = window.GOVUK || {}
-window.GOVUK.Modules = window.GOVUK.Modules || {};
-
-(function (Modules) {
-  function AutoTrackEvent ($module) {
-    this.$module = $module
-  }
-
-  AutoTrackEvent.prototype.init = function () {
-    var options = { nonInteraction: 1 } // automatic events shouldn't affect bounce rate
-    var category = this.$module.getAttribute('data-track-category')
-    var action = this.$module.getAttribute('data-track-action')
-    var label = this.$module.getAttribute('data-track-label')
-    var value = parseInt(this.$module.getAttribute('data-track-value'))
-
-    if (typeof label === 'string') {
-      options.label = label
-    }
-
-    if (value || value === 0) {
-      options.value = value
-    }
-
-    if (window.GOVUK.analytics && window.GOVUK.analytics.trackEvent) {
-      window.GOVUK.analytics.trackEvent(category, action, options)
-    }
-  }
-
-  Modules.AutoTrackEvent = AutoTrackEvent
-})(window.GOVUK.Modules)

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

@@ -1,55 +0,0 @@
-window.GOVUK = window.GOVUK || {}
-window.GOVUK.Modules = window.GOVUK.Modules || {};
-
-(function (Modules) {
-  function CrossDomainTracking ($module) {
-    this.$module = $module
-    Modules.crossDomainLinkedTrackers = Modules.crossDomainLinkedTrackers || []
-  }
-
-  CrossDomainTracking.prototype.init = function () {
-    if (this.isTrackable(this.$module)) {
-      this.addLinkedTrackerDomain(this.$module)
-    } else {
-      this.findTrackableElements()
-    }
-  }
-
-  CrossDomainTracking.prototype.isTrackable = function (element) {
-    if (element.getAttribute('href') && element.getAttribute('data-tracking-code') && element.getAttribute('data-tracking-name')) {
-      return true
-    }
-  }
-
-  CrossDomainTracking.prototype.findTrackableElements = function () {
-    var links = this.$module.querySelectorAll('a')
-    for (var i = 0; i < links.length; i++) {
-      if (this.isTrackable(links[i])) {
-        this.addLinkedTrackerDomain(links[i])
-      }
-    }
-  }
-
-  CrossDomainTracking.prototype.addLinkedTrackerDomain = function (element) {
-    var name = element.getAttribute('data-tracking-name')
-    var code = element.getAttribute('data-tracking-code')
-    var trackEvent = (element.getAttribute('data-tracking-track-event') === 'true')
-
-    if (window.GOVUK.analytics !== 'undefined') {
-      if (Modules.crossDomainLinkedTrackers.indexOf(name) === -1) {
-        var hostname = element.hostname
-        window.GOVUK.analytics.addLinkedTrackerDomain(code, name, hostname)
-        Modules.crossDomainLinkedTrackers.push(name)
-      }
-
-      if (trackEvent) {
-        element.addEventListener('click', function (e) {
-          var target = e.target
-          window.GOVUK.analytics.trackEvent('External Link Clicked', target.textContent, { trackerName: name })
-        })
-      }
-    }
-  }
-
-  Modules.CrossDomainTracking = CrossDomainTracking
-})(window.GOVUK.Modules)

data/app/assets/javascripts/govuk_publishing_components/analytics/custom-dimensions.js

@@ -1,133 +0,0 @@
-/* global GOVUK */
-
-(function () {
-  'use strict'
-  window.GOVUK = window.GOVUK || {}
-  var CustomDimensions = function () { }
-
-  CustomDimensions.getAndExtendDefaultTrackingOptions = function (extraOptions) {
-    var trackingOptions = this.customDimensions()
-    return GOVUK.extendObject(trackingOptions, extraOptions)
-  }
-
-  CustomDimensions.customDimensions = function () {
-    var dimensions = GOVUK.extendObject(
-      {},
-      customDimensionsFromBrowser(),
-      customDimensionsFromMetaTags(),
-      customDimensionsFromDom(),
-      abTestCustomDimensions()
-    )
-
-    for (var key in dimensions) {
-      dimensions[key] = new GOVUK.Analytics.PIISafe(String(dimensions[key]))
-    }
-    return dimensions
-  }
-
-  function customDimensionsFromBrowser () {
-    var customDimensions = {
-      dimension15: window.httpStatusCode || 200,
-      dimension16: GOVUK.cookie('TLSversion') || 'unknown',
-      dimension95: GOVUK.analytics.gaClientId
-    }
-
-    if (window.devicePixelRatio) {
-      customDimensions.dimension11 = window.devicePixelRatio
-    } else {
-      customDimensions.dimension11 = window.screen.deviceXDPI / window.screen.logicalXDPI
-    }
-
-    return customDimensions
-  }
-
-  function customDimensionsFromMetaTags () {
-    var dimensionMappings = {
-      section: { dimension: 1 },
-      format: { dimension: 2 },
-      themes: { dimension: 3, defaultValue: 'other' },
-      'content-id': { dimension: 4, defaultValue: '00000000-0000-0000-0000-000000000000' },
-      'search-result-count': { dimension: 5 },
-      'publishing-government': { dimension: 6 },
-      'political-status': { dimension: 7 },
-      'analytics:organisations': { dimension: 9 },
-      'analytics:world-locations': { dimension: 10 },
-      withdrawn: { dimension: 12, defaultValue: 'not withdrawn' },
-      'schema-name': { dimension: 17 },
-      'rendering-application': { dimension: 20 },
-      'search-autocomplete-status': { dimension: 21 },
-      'navigation-legacy': { dimension: 30, defaultValue: 'none' },
-      'navigation-list-type': { dimension: 31, defaultValue: 'none' },
-      'navigation-page-type': { dimension: 32, defaultValue: 'none' },
-      'taxon-slug': { dimension: 56, defaultValue: 'other' },
-      'taxon-id': { dimension: 57, defaultValue: 'other' },
-      'taxon-slugs': { dimension: 58, defaultValue: 'other' },
-      'taxon-ids': { dimension: 59, defaultValue: 'other' },
-      'content-has-history': { dimension: 39, defaultValue: 'false' },
-      'publishing-app': { dimension: 89 },
-      'brexit-audience': { dimension: 112 },
-      'brexit-superbreadcrumb': { dimension: 111 },
-      stepnavs: { dimension: 96 },
-      'relevant-result-shown': { dimension: 83 },
-      'spelling-suggestion': { dimension: 81 }
-    }
-
-    var metas = document.querySelectorAll("meta[name^='govuk']")
-    var customDimensions = {}
-    var tags = {}
-
-    for (var i = 0; i < metas.length; i++) {
-      var meta = metas[i]
-      var metaKey = meta.getAttribute('name').split('govuk:')[1]
-      var dimension = dimensionMappings[metaKey]
-      if (dimension) {
-        tags[metaKey] = meta.getAttribute('content')
-      }
-    }
-
-    for (var key in dimensionMappings) {
-      var value = tags[key] || dimensionMappings[key].defaultValue
-      if (typeof value !== 'undefined') {
-        customDimensions['dimension' + dimensionMappings[key].dimension] = value
-      }
-    }
-
-    return customDimensions
-  }
-
-  function customDimensionsFromDom () {
-    var mainLang = document.getElementById('content')
-    if (mainLang) {
-      mainLang = mainLang.getAttribute('lang')
-    }
-    var globalBar = document.querySelector('[data-module="global-bar"]') || false
-    if (globalBar) {
-      globalBar = globalBar.style.display !== 'none'
-    }
-    return {
-      dimension26: GOVUK.PageContent.getNumberOfSections(),
-      dimension27: GOVUK.PageContent.getNumberOfLinks(),
-      dimension23: mainLang || 'unknown',
-      dimension38: globalBar && 'Global Banner viewed'
-    }
-  }
-
-  function abTestCustomDimensions () {
-    var abMetas = document.querySelectorAll("meta[name^='govuk:ab-test']")
-    var customDimensions = {}
-
-    for (var i = 0; i < abMetas.length; i++) {
-      var meta = abMetas[i]
-      var dimension = parseInt(meta.getAttribute('data-analytics-dimension'))
-      var testNameAndBucket = meta.getAttribute('content')
-
-      if (dimension) {
-        customDimensions['dimension' + dimension] = testNameAndBucket
-      }
-    }
-
-    return customDimensions
-  }
-
-  GOVUK.CustomDimensions = CustomDimensions
-})()

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

@@ -1,46 +0,0 @@
-;(function (global) {
-  'use strict'
-
-  var GOVUK = global.GOVUK || {}
-
-  GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {}
-  GOVUK.analyticsPlugins.downloadLinkTracker = function (options) {
-    options = options || {}
-    var downloadLinkSelector = options.selector
-    var selectors = downloadLinkSelector.split(',')
-
-    if (downloadLinkSelector) {
-      document.querySelector('body').addEventListener('click', function (event) {
-        var element = event.target
-        if (element.tagName !== 'A') {
-          element = element.closest('a')
-        }
-
-        if (!element) {
-          return
-        }
-
-        for (var i = 0; i < selectors.length; i++) {
-          if (element.matches(selectors[i].trim())) {
-            trackDownload(element)
-            break
-          }
-        }
-      })
-    }
-
-    function trackDownload (element) {
-      var href = element.getAttribute('href')
-      var evtOptions = { transport: 'beacon' }
-      var linkText = element.textContent.trim()
-
-      if (linkText) {
-        evtOptions.label = linkText
-      }
-
-      GOVUK.analytics.trackEvent('Download Link Clicked', href, evtOptions)
-    }
-  }
-
-  global.GOVUK = GOVUK
-})(window)

data/app/assets/javascripts/govuk_publishing_components/analytics/ecommerce.js

@@ -1,101 +0,0 @@
-// https://developers.google.com/analytics/devguides/collection/analyticsjs/enhanced-ecommerce
-/* global GOVUK, ga */
-
-(function () {
-  'use strict'
-  window.GOVUK = window.GOVUK || {}
-
-  var DEFAULT_LIST_TITLE = 'Site search results'
-  var DEFAULT_TRACK_CLICK_LABEL = 'Results'
-
-  var Ecommerce = function (config) {
-    this.init = function (element) {
-      // Limiting to 100 characters to avoid noise from extra longs search queries
-      // and to stop the size of the payload going over 8k limit.
-      var searchQuery = GOVUK.analytics.stripPII(element.getAttribute('data-search-query')).substring(0, 100).toLowerCase()
-      var ecommerceRows = element.querySelectorAll('[data-ecommerce-row]')
-      var startPosition = parseInt(element.getAttribute('data-ecommerce-start-index'), 10)
-      var listTitle = element.getAttribute('data-list-title') || DEFAULT_LIST_TITLE
-      var variant = element.getAttribute('data-ecommerce-variant') || undefined
-      var trackClickLabel = element.getAttribute('data-track-click-label') || DEFAULT_TRACK_CLICK_LABEL
-
-      for (var i = 0; i < ecommerceRows.length; i++) {
-        var ecommerceRow = ecommerceRows[i]
-        var listSubheading = ecommerceRow.getAttribute('data-ecommerce-subheading') || undefined
-        var contentId = ecommerceRow.getAttribute('data-ecommerce-content-id') || undefined
-        var path = ecommerceRow.getAttribute('data-ecommerce-path')
-
-        var indexOverride = ecommerceRow.getAttribute('data-ecommerce-index')
-        var index = indexOverride ? parseInt(indexOverride, 10) - 1 : i
-
-        addImpression(contentId, path, index + startPosition, searchQuery, listTitle, listSubheading, variant)
-        trackProductOnClick(ecommerceRow, contentId, path, index + startPosition, searchQuery, listTitle, listSubheading, variant, trackClickLabel)
-      }
-    }
-
-    function constructData (contentId, path, position, listTitle, listSubheading, searchQuery, variant) {
-      var data = {
-        position: position,
-        list: listTitle,
-        dimension71: searchQuery
-      }
-
-      if (listSubheading !== undefined) {
-        data.dimension94 = listSubheading
-      }
-
-      if (contentId !== undefined) {
-        data.id = contentId
-      }
-
-      if (path !== undefined) {
-        data.name = path
-      }
-
-      if (variant !== undefined) {
-        data.variant = variant
-      }
-
-      return data
-    }
-
-    function addImpression (contentId, path, position, searchQuery, listTitle, listSubheading, variant) {
-      if (contentId || path) {
-        var impressionData = constructData(contentId, path, position, listTitle, listSubheading, searchQuery, variant)
-        ga('ec:addImpression', impressionData)
-      }
-    }
-
-    function trackProductOnClick (row, contentId, path, position, searchQuery, listTitle, listSubheading, variant, trackClickLabel) {
-      row.addEventListener('click', function () {
-        if (contentId || path) {
-          var clickData = constructData(contentId, path, position, listTitle, listSubheading, searchQuery, variant)
-          ga('ec:addProduct', clickData)
-        }
-
-        ga('ec:setAction', 'click', { list: listTitle })
-        GOVUK.analytics.trackEvent('UX', 'click',
-          GOVUK.CustomDimensions.getAndExtendDefaultTrackingOptions({ label: trackClickLabel })
-        )
-      })
-    }
-  }
-
-  Ecommerce.ecLoaded = false
-  Ecommerce.start = function (elements) {
-    if (!window.ga) { return }
-    elements = elements || document.querySelectorAll('[data-analytics-ecommerce]')
-    if (elements.length > 0) {
-      if (!Ecommerce.ecLoaded) {
-        ga('require', 'ec')
-        Ecommerce.ecLoaded = true
-      }
-      for (var i = 0; i < elements.length; i++) {
-        var ecommerce = new Ecommerce()
-        ecommerce.init(elements[i])
-      }
-    }
-  }
-
-  GOVUK.Ecommerce = Ecommerce
-})()

data/app/assets/javascripts/govuk_publishing_components/analytics/error-tracking.js

@@ -1,51 +0,0 @@
-// Extension to track errors using google analytics as a data store.
-;(function (global) {
-  'use strict'
-
-  var GOVUK = global.GOVUK || {}
-
-  GOVUK.analyticsPlugins = GOVUK.analyticsPlugins || {}
-
-  GOVUK.analyticsPlugins.error = function (options) {
-    options = options || {}
-    var filenameMustMatch = options.filenameMustMatch
-
-    var trackJavaScriptError = function (e) {
-      var errorFilename = e.filename
-      var errorSource = errorFilename + ': ' + e.lineno
-
-      if (shouldTrackThisError(errorFilename)) {
-        GOVUK.analytics.trackEvent('JavaScript Error', e.message, {
-          label: errorSource,
-          value: 1,
-          nonInteraction: true
-        })
-      }
-    }
-
-    function shouldTrackThisError (errorFilename) {
-      // Errors in page should always be tracked
-      // If there's no filename filter, everything is tracked
-      if (!errorFilename || !filenameMustMatch) {
-        return true
-      }
-
-      // If there's a filter and the error matches it, track it
-      if (filenameMustMatch.test(errorFilename)) {
-        return true
-      }
-
-      return false
-    }
-
-    if (global.addEventListener) {
-      global.addEventListener('error', trackJavaScriptError, false)
-    } else if (global.attachEvent) {
-      global.attachEvent('onerror', trackJavaScriptError)
-    } else {
-      global.onerror = trackJavaScriptError
-    }
-  }
-
-  global.GOVUK = GOVUK
-})(window)