govuk_publishing_components 37.9.0 → 37.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 620e260c7be413ed137d8e74b40dc48c19319aec32a0a7d19cc595ac63f88ace
-  data.tar.gz: aa8cc4913d9db8852e43c7eb3e47f43716b749c640ba31b4004ad60f78c88ea2
+  metadata.gz: c5dd2b5e600cf344b23c52992b273a3af2ea102506584e06dfb001aa810e0491
+  data.tar.gz: 459ba0f50e42851c6ea04b0490aba7714cb221fb6b97e735cb48f4548f1e8237
 SHA512:
-  metadata.gz: de3cdf70234ce290d51b5132f6cde36fc6c43f5c2281fc5f094a468ee5b496bbc49325e4633ff01836bcafa4c6e4ac30af496e40034c50dd2e6da27b847ed2f1
-  data.tar.gz: 56b4d106d440fbc30dd4ad64108cc9f3dbdba4c65a23a37df3147e80e8703ccc3e91349cfe65d7ee484068abe0ee07366ea8a1abc742798f19c68d5877c02513
+  metadata.gz: 0dd79b5496db1fe55d085e18476983bcaf5abefa630e44544acfe795f40c68c3529556a8dcb02d8f0b25695bb4c0db223fb0e0038cfc6cdc1389db5fe48c86a2
+  data.tar.gz: e54878f904583f718889acc341ea00f8a7281f82783bb8141e358c29068c63c67f3c96dbd04820c5d09562cfe2aa31cb6b3008f3897ef7e113cefd792675ae62

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

@@ -72,7 +72,22 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
       if (!href) {
         return
       }
+
       var data = {}
+      var extraAttributes = element.getAttribute('data-ga4-attributes')
+      if (extraAttributes) {
+        try {
+          extraAttributes = JSON.parse(extraAttributes)
+          // make sure the data object remains an object - JSON.parse can return a string
+          for (var attrname in extraAttributes) {
+            data[attrname] = extraAttributes[attrname]
+          }
+        } catch (e) {
+          // fall back to the empty data object if something goes wrong
+          console.error('GA4 configuration error: ' + e.message, window.location)
+        }
+      }
+
       var mailToLink = false
       if (window.GOVUK.analyticsGa4.core.trackFunctions.isMailToLink(href)) {
         data.event_name = 'navigation'
@@ -85,7 +100,7 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
         data.external = window.GOVUK.analyticsGa4.core.trackFunctions.isExternalLink(href) ? 'true' : 'false'
       } else if (window.GOVUK.analyticsGa4.core.trackFunctions.isExternalLink(href)) {
         data.event_name = 'navigation'
-        data.type = 'generic link'
+        data.type = data.type || 'generic link'
         data.external = 'true'
       }
 

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

@@ -1,5 +1,6 @@
 <%
   add_gem_component_stylesheet("button")
+  disable_ga4 ||= false
 
   # button_helper.css_classes generates "gem-c-button"
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)

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

@@ -5,11 +5,13 @@
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
   items ||= []
 
-  classes = %w[gem-c-document-list]
-  classes << "gem-c-document-list--no-underline" if local_assigns[:remove_underline]
-  classes << "gem-c-document-list--no-top-border" if local_assigns[:remove_top_border]
-  classes << "gem-c-document-list--no-top-border-first-child" if local_assigns[:remove_top_border_from_first_child]
-  classes << shared_helper.get_margin_bottom
+  component_helper = GovukPublishingComponents::Presenters::ComponentWrapperHelper.new(local_assigns)
+  component_helper.add_class("gem-c-document-list")
+  component_helper.add_class("gem-c-document-list--no-underline") if local_assigns[:remove_underline]
+  component_helper.add_class("gem-c-document-list--no-top-border") if local_assigns[:remove_top_border]
+  component_helper.add_class("gem-c-document-list--no-top-border-first-child") if local_assigns[:remove_top_border_from_first_child]
+  component_helper.add_class(shared_helper.get_margin_bottom)
+
 
   title_with_context_class = " gem-c-document-list__item-title--context"
 
@@ -19,18 +21,18 @@
   disable_ga4 ||= false
   unless disable_ga4
     ga4_extra_data ||= {}
-    ga4_ul_attributes = {
+    component_helper.add_data_attribute({
       module: "ga4-link-tracker",
       ga4_track_links_only: "",
       ga4_link: {
         "event_name": "navigation",
         "type": "document list",
       }.merge(ga4_extra_data)
-    }
+    })
   end
 %>
 <% if items.any? %>
-  <%= tag.ul(class: classes.join(" "), data: ga4_ul_attributes) do %>
+  <%= tag.ul(**component_helper.all_attributes) do %>
     <% items.each do |item| %>
       <% highlight_class = " gem-c-document-list__item--highlight" if item[:highlight] %>
       <li class="gem-c-document-list__item <%= brand_helper.brand_class %> <%= highlight_class %>">

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

@@ -44,6 +44,14 @@ examples:
       href: '#'
       start: true
       rel: external
+  start_now_button_without_ga4_attributes:
+    description: By default the start now button version of this component includes a `data-ga4-attributes` attribute that is used by the specialist (external) link tracker to uniquely identify start now buttons. This attribute can be removed using the `disable_ga4` option.
+    data:
+      text: Start now
+      disable_ga4: true
+      href: '#'
+      start: true
+      rel: external
   secondary_button:
     data:
       text: Secondary button

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

@@ -15,6 +15,7 @@ accessibility_criteria: |
   * inform the user how many items are in the list
 shared_accessibility_criteria:
   - link
+uses_component_wrapper_helper: true
 examples:
   default:
     data:

data/lib/govuk_publishing_components/presenters/button_helper.rb

@@ -28,6 +28,7 @@ module GovukPublishingComponents
                   :aria_describedby
 
       def initialize(local_assigns)
+        @disable_ga4 = local_assigns[:disable_ga4]
         @href = local_assigns[:href]
         @text = local_assigns[:text]
         @title = local_assigns[:title]
@@ -45,6 +46,7 @@ module GovukPublishingComponents
         @target = local_assigns[:target]
         @type = local_assigns[:type]
         @start = local_assigns[:start]
+        @data_attributes[:ga4_attributes] = ga4_attribute if start
         @secondary = local_assigns[:secondary]
         @secondary_quiet = local_assigns[:secondary_quiet]
         @secondary_solid = local_assigns[:secondary_solid]
@@ -129,6 +131,10 @@ module GovukPublishingComponents
 
         [*0..9].include?(margin) ? "govuk-!-margin-bottom-#{margin}" : legacy_class
       end
+
+      def ga4_attribute
+        { type: "start button" }.to_json unless @disable_ga4
+      end
     end
   end
 end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "37.9.0".freeze
+  VERSION = "37.9.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 37.9.0
+  version: 37.9.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-20 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config