govuk_publishing_components 35.13.2 → 35.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d89a426d686fe0891582f8851ff7b27c57a457b838dccd81aa07a4868a9a9975
-  data.tar.gz: b267048c6e6bd91689fcedbad4e16835de62ff50aee68e94684ec4533ad7c5ab
+  metadata.gz: cbe4c3f60d3220a9d2b715392ba0bdd2f6bce4f92153fff876e8a0b608361161
+  data.tar.gz: 94bd59d7a23b8e3cec4882814d7fb0140f81f0bd53bc23f0e475700ba8c489f8
 SHA512:
-  metadata.gz: 9dcd81b321da508d0475825320afa9674bfbac1bf1ef73f5ce32ccd66d0f5225e08b569a9819ca34672c13e919e154e02570b51109613e53d9bc79945a0f3482
-  data.tar.gz: 24bf0744fc140a4644c5b12d0de816869298a1927a25e3b1e126d0644b4bae78cd6ae5409d194e48465429e049517440321d39b12edd1ee783e717f54446659f
+  metadata.gz: 47f46ab14ccabebf2a3a3c0da9bc03f9b8207d1e54b6a0c4eb8830eb87b5ce200dd606fd2de50c3804d61f222518c560b046ff77b0de87e635a84a653d77d758
+  data.tar.gz: c51c0a0407bfa84b24ba4d5dfb281f9c31657f1b18e5afe687198c401dbb0f05dc795d7c27ecdf9fbbfe8413cc82a18f28016d77f3d4248351780e0731a61e55

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

@@ -169,10 +169,10 @@ window.GOVUK.analyticsGa4 = window.GOVUK.analyticsGa4 || {};
       removeCrossDomainParams: function (href) {
         if (href.indexOf('_ga') !== -1 || href.indexOf('_gl') !== -1) {
           // _ga & _gl are values needed for cross domain tracking, but we don't want them included in our click tracking.
-          href = href.replaceAll(/_g[al]=([^&]*)/g, '')
+          href = href.replace(/_g[al]=([^&]*)/g, '')
 
           // The following code cleans up inconsistencies such as gov.uk/&&, gov.uk/?&hello=world, gov.uk/?, and gov.uk/&.
-          href = href.replaceAll(/(&&)+/g, '&')
+          href = href.replace(/(&&)+/g, '&')
           href = href.replace('?&', '?')
           if (this.stringEndsWith(href, '?') || this.stringEndsWith(href, '&')) {
             href = href.substring(0, href.length - 1)

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

@@ -53,7 +53,9 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
             /* The existence of a referrer parameter indicates that the page has been dynamically updated via an AJAX request
             and therefore we can use it to set the dynamic property appropriately. This value is used by PA's to differentiate
             between fresh page loads and dynamic page updates. */
-            dynamic: referrer ? 'true' : 'false'
+            dynamic: referrer ? 'true' : 'false',
+            emergency_banner: document.querySelector('[data-ga4-emergency-banner]') ? 'true' : undefined,
+            phase_banner: this.getElementAttribute('data-ga4-phase-banner') || undefined
           }
         }
         window.GOVUK.analyticsGa4.core.sendData(data)
@@ -91,6 +93,13 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
       }
     },
 
+    getElementAttribute: function (attributeName) {
+      var el = document.querySelector('[' + attributeName + ']')
+      if (el) {
+        return el.getAttribute(attributeName)
+      }
+    },
+
     getLanguage: function () {
       var content = document.getElementById('content')
       if (content) {

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

@@ -11,6 +11,7 @@
 
   container_class_names = %w[gem-c-attachment govuk-!-display-none-print]
   container_class_names << shared_helper.get_margin_bottom if local_assigns.key?(:margin_bottom)
+  ga4_link = { 'event_name': 'navigation', 'type': 'attachment' }
 
   case attachment.type
   when "file"
@@ -38,6 +39,9 @@
         class: "gem-c-attachment__attribute",
       )
     end
+
+    ga4_link[:event_name] = 'file_download'
+
   when "html"
     attributes << tag.span(
       "HTML",
@@ -51,7 +55,7 @@
   end
 
 %>
-<%= tag.section class: class_names(container_class_names), data: { module: "ga4-link-tracker", ga4_track_links_only: "", ga4_link: { 'event_name': 'navigation', 'type': 'attachment' } } do %>
+<%= tag.section class: class_names(container_class_names), data: { module: "ga4-link-tracker", ga4_track_links_only: "", ga4_link: ga4_link } do %>
   <%= tag.div class: "gem-c-attachment__thumbnail" do %>
     <%= link_to attachment.url,
                 class: "govuk-link",

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

@@ -7,6 +7,7 @@
   link_text ||= "More information"
   campaign_class ||= nil
   homepage ||= false
+  ga4_tracking ||= false
 
   emergency_banner_helper = GovukPublishingComponents::Presenters::EmergencyBannerHelper.new()
 
@@ -28,9 +29,25 @@
   description_classes = %w[gem-c-emergency-banner__description]
   description_classes << "gem-c-emergency-banner__description--homepage" if homepage
 
+
+  data_attributes = {
+    "nosnippet": true,
+  }
+
+  if ga4_tracking
+    data_attributes[:ga4_emergency_banner] = ""
+    data_attributes[:module] = "ga4-link-tracker"
+    data_attributes[:ga4_track_links_only] = ""
+    data_attributes[:ga4_set_indexes] = ""
+    data_attributes[:ga4_link] = {
+      event_name: "navigation",
+      type: "emergency banner",
+      section: heading,
+    }.to_json
+  end
 %>
 
-<%= content_tag('section', class: banner_classes, "aria-labelledby": "emergency-banner-heading", "data-nosnippet": true ) do %>
+<%= content_tag('section', class: banner_classes, "aria-labelledby": "emergency-banner-heading", data: data_attributes) do %>
   <div class="govuk-width-container">
     <div class="govuk-grid-row">
       <div class="govuk-grid-column-two-thirds">

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

@@ -5,6 +5,7 @@ app_name ||= nil
 phase ||= nil
 message ||= nil
 inverse ||= false
+ga4_tracking ||= false
 
 unless message.present?
   if phase == "beta"
@@ -16,9 +17,24 @@ end
 
 container_css_classes = %w(gem-c-phase-banner govuk-phase-banner)
 container_css_classes << "gem-c-phase-banner--inverse" if inverse
+
+data_attributes = {}
+
+if ga4_tracking
+  data_attributes[:ga4_phase_banner] = phase
+  data_attributes[:module] = "ga4-link-tracker"
+  data_attributes[:ga4_track_links_only] = ""
+  data_attributes[:ga4_set_indexes] = ""
+  data_attributes[:ga4_link] = {
+    event_name: "navigation",
+    type: "phase banner",
+    section: Nokogiri::HTML(message).text,
+  }.to_json
+end
+
 %>
 
-<%= tag.div class: container_css_classes do %>
+<%= tag.div class: container_css_classes, data: data_attributes do %>
   <%= tag.p class: "govuk-phase-banner__content" do %>
     <%= tag.strong app_name, class: "govuk-phase-banner__content__app-name" if app_name %>
     <%= tag.strong phase, class: "govuk-tag govuk-phase-banner__content__tag" if phase %>

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

@@ -45,3 +45,13 @@ examples:
       short_description: "1491 to 1547"
       link: "https://www.gov.uk/"
       homepage: true
+  with_ga4_tracking:
+    description: |
+      Enables GA4 tracking on the banner. This includes link tracking on the component itself, and allows pageviews to record the presence of the banner on page load.
+    data:
+      campaign_class: "notable-death"
+      heading: "His Royal Highness Henry VIII"
+      short_description: "1491 to 1547"
+      link: "https://www.gov.uk/"
+      homepage: true
+      ga4_tracking: true

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

@@ -32,3 +32,11 @@ examples:
       app_name: Skittles Maker
       phase: beta
       inverse: true
+  with_ga4_tracking:
+    description: |
+      Enables GA4 tracking on the banner. This includes link tracking on the component itself, and allows pageviews to record the presence of the banner on page load.
+    data:
+      app_name: Skittles Maker
+      phase: beta
+      inverse: true
+      ga4_tracking: true

data/app/views/layouts/govuk_publishing_components/application.html.erb

@@ -6,7 +6,7 @@
   <% else %>
     <%= render "govuk_publishing_components/components/layout_header", {
       environment: GovukPublishingComponents::AppHelpers::Environment.current_acceptance_environment,
-      product_name: GovukPublishingComponents::Config.component_guide_title,
+      product_name: "#{GovukPublishingComponents::Config.component_guide_title} #{GovukPublishingComponents::VERSION}",
       href: component_guide_path
     } %>
     <div class="govuk-width-container app-width-container--wide">

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "35.13.2".freeze
+  VERSION = "35.14.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 35.13.2
+  version: 35.14.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config