govuk_publishing_components 37.9.0 → 37.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 620e260c7be413ed137d8e74b40dc48c19319aec32a0a7d19cc595ac63f88ace
-  data.tar.gz: aa8cc4913d9db8852e43c7eb3e47f43716b749c640ba31b4004ad60f78c88ea2
+  metadata.gz: 88e7235efad66b3b4e58b76104ee17ffd0df45709e3a0ead2d21b3349af45514
+  data.tar.gz: 70a11adff6bea43df88c5b10bf9d0ab0934510d8a57ec7f621c50e0006e689a6
 SHA512:
-  metadata.gz: de3cdf70234ce290d51b5132f6cde36fc6c43f5c2281fc5f094a468ee5b496bbc49325e4633ff01836bcafa4c6e4ac30af496e40034c50dd2e6da27b847ed2f1
-  data.tar.gz: 56b4d106d440fbc30dd4ad64108cc9f3dbdba4c65a23a37df3147e80e8703ccc3e91349cfe65d7ee484068abe0ee07366ea8a1abc742798f19c68d5877c02513
+  metadata.gz: 750feab9da7c02d5fd72d55e9b40a027d02000656a987316974a282dc4357832a3600670826b9a80dac4c64a087f18acc97eacab3573879e3ba46148f5b5bf08
+  data.tar.gz: db8c5538ef83cb50bcf37e11e6e5693a8995da9a2deda172dfc9591eb10a1d77c5ed54b65ecf62fab5d4233146a201556f1eb9280a37a9be693e30a94ca44297

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

@@ -62,7 +62,8 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
             intervention: this.getBannerPresence('[data-ga4-intervention-banner]'),
             query_string: this.getQueryString(),
             search_term: this.getSearchTerm(),
-            spelling_suggestion: this.getMetaContent('spelling-suggestion')
+            spelling_suggestion: this.getMetaContent('spelling-suggestion'),
+            discovery_engine_attribution_token: this.getMetaContent('discovery-engine-attribution-token')
           }
         }
         window.GOVUK.analyticsGa4.core.sendData(data)

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/assets/javascripts/govuk_publishing_components/components/layout-super-navigation-header.js

@@ -134,8 +134,8 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
     var $navMenuLinks = this.$navMenu.querySelectorAll('li a')
     var $firstNavLink = $navMenuLinks[0]
     var $lastNavLink = $navMenuLinks[$navMenuLinks.length - 1]
-    var $searchMenuLinks = this.$searchMenu.querySelectorAll('li a')
-    var $lastSearchLink = $searchMenuLinks[$searchMenuLinks.length - 1]
+    var $searchMenuTabbable = this.$searchMenu.querySelectorAll('li a, input, button')
+    var $lastSearchMenuTabbable = $searchMenuTabbable[$searchMenuTabbable.length - 1]
 
     if (event.keyCode === KEY_TAB) {
       if (!this.$navMenu.hasAttribute('hidden')) {
@@ -169,7 +169,7 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
             break
         }
       } else if (!this.$searchMenu.hasAttribute('hidden')) {
-        if (document.activeElement === $lastSearchLink) {
+        if (document.activeElement === $lastSearchMenuTabbable) {
           if (!event.shiftKey) {
             hide(this.$searchToggle, this.$searchMenu)
           }

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/_govspeak.html.erb

@@ -10,20 +10,9 @@
   classes << "disable-youtube" if disable_youtube_expansions
   classes << "gem-c-govspeak--inverse" if inverse
 
-  disable_ga4 ||= false
-
   data_modules = "govspeak"
-  data_modules << " ga4-link-tracker" unless disable_ga4
   data_attributes = { module: data_modules }
 
-  unless disable_ga4
-    data_attributes.merge!({
-      ga4_track_links_only: "",
-      ga4_limit_to_element_class: "call-to-action, info-notice, help-notice, advisory",
-      ga4_link: { "event_name": "navigation", "type": "callout" }.to_json,
-    })
-  end
-
 %>
 
 <%= tag.div(class: "gem-c-govspeak govuk-govspeak " + classes.join(" "), data: data_attributes) do %>

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

@@ -25,28 +25,15 @@
   aria_attributes[:labelledby] = banner_title_id if show_banner_title
 
   description_present = description.present? || description_text.present? || description_govspeak.present?
-  disable_ga4 ||= false
 
   if description_govspeak
     govspeak_data_attributes = {
       content: description_govspeak,
-      disable_ga4: true # Keep the govspeak component GA4 tracking disabled, otherwise tracking will be duplicated when tracking is enabled on this component.
-    }
-  end
-
-  unless disable_ga4
-    section_data_attributes = {
-      module: "ga4-link-tracker",
-      ga4_track_links_only: "",
-      ga4_link: {
-        event_name: "navigation",
-        type: "callout"
-      }.to_json
     }
   end
 %>
 <% if title || description_present %>
-  <%= tag.section class: css_classes, aria: aria_attributes, lang: lang, role: "region", data: section_data_attributes do %>
+  <%= tag.section class: css_classes, aria: aria_attributes, lang: lang, role: "region" do %>
     <%= tag.div class: "govuk-notification-banner__header" do %>
       <%= tag.h2 banner_title, class: "govuk-notification-banner__title", id: banner_title_id %>
     <% end if show_banner_title %>

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

@@ -14,18 +14,9 @@
   text_classes << "gem-c-warning-text__text--no-indent" if text_icon.empty?
   text_classes << "gem-c-warning-text__text--large" if large_font
   text_classes << "gem-c-warning-text__text--highlight" if highlight_text
-
-  disable_ga4 ||= false
-
-  ga4_data_attributes = {
-    "module": "ga4-link-tracker",
-    "ga4-track-links-only": "",
-    "ga4-link": { "event_name": "navigation", "type": "callout" }.to_json
-  } unless disable_ga4
-
 %>
 
-<%= tag.div id: id, class: "gem-c-warning-text govuk-warning-text", data: ga4_data_attributes do %>
+<%= tag.div id: id, class: "gem-c-warning-text govuk-warning-text" do %>
   <% unless text_icon.empty? %>
     <%= tag.span text_icon, class: "govuk-warning-text__icon", "aria-hidden": "true" %>
   <% end %>

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/app/views/govuk_publishing_components/components/docs/govspeak.yml

@@ -914,12 +914,3 @@ examples:
             <p>Deforested area. Credit: Blue Ventures-Garth Cripps</p>
           </figcaption>
         </figure>
-  without_ga4_tracking:
-    description: |
-      Disables GA4 tracking on the component. Tracking is enabled by default. This adds a data module and data-attributes with JSON data. See the [ga4-link-tracker documentation](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics-ga4/ga4-link-tracker.md) for more information.
-    data:
-      block: |
-        <p>
-          <a href='https://www.gov.uk'>Hello World</a>
-        </p>
-      disable_ga4: true

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

@@ -65,13 +65,3 @@ examples:
       description_govspeak: <p>This document is no longer current. We published a new version on 30 September 2015.</p>
       show_banner_title: true
       banner_title: "Information"
-  with_ga4_tracking_disabled:
-    description: |
-      Disables GA4 tracking on the component. Tracking on the component is enabled by default. Tracking on the nested govspeak component is always disabled to prevent duplication. When tracking is enabled on this component, a data module and data attributes are added to the parent element. See the [ga4-link-tracker documentation](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics-ga4/ga4-link-tracker.md) for more information.
-    data:
-      disable_ga4: true
-      title: 'This publication was withdrawn on 30 September 2015'
-      description_govspeak: <p>This document is no longer current. We published a new version on 30 September 2015.</p>
-      show_banner_title: true
-      banner_title: "Information"
-

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

@@ -33,10 +33,3 @@ examples:
     data:
       text: "This is a heading 3"
       heading_level: 3
-  without_ga4_tracking:
-    description: |
-      Disables GA4 tracking on warning text links. Tracking is enabled by default, which adds a data module and data attributes to the component. See the [ga4-link-tracker documentation](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics-ga4/ga4-link-tracker.md) for more information.
-    data:
-      disable_ga4: true
-      text: "This is a heading 3"
-      heading_level: 3

data/lib/govuk_publishing_components/presenters/breadcrumb_selector.rb

@@ -55,11 +55,6 @@ module GovukPublishingComponents
             step_by_step: false,
             breadcrumbs: navigation.breadcrumbs,
           }
-        elsif navigation.content_has_a_topic?
-          {
-            step_by_step: false,
-            breadcrumbs: navigation.topic_breadcrumbs,
-          }
         elsif navigation.use_taxon_breadcrumbs?
           {
             step_by_step: false,

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/presenters/contextual_navigation.rb

@@ -33,10 +33,6 @@ module GovukPublishingComponents
         @taxon_breadcrumbs ||= ContentBreadcrumbsBasedOnTaxons.call(content_item)
       end
 
-      def topic_breadcrumbs
-        @topic_breadcrumbs ||= ContentBreadcrumbsBasedOnTopic.call(content_item)
-      end
-
       def breadcrumbs
         breadcrumbs_based_on_ancestors
       end
@@ -88,10 +84,6 @@ module GovukPublishingComponents
         content_item["document_type"] == "html_publication"
       end
 
-      def content_has_a_topic?
-        content_item.dig("links", "topics").present?
-      end
-
       def content_tagged_to_current_step_by_step?
         # TODO: remove indirection here
         step_nav_helper.show_header?

data/lib/govuk_publishing_components/version.rb

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

data/lib/govuk_publishing_components.rb

@@ -24,7 +24,6 @@ require "govuk_publishing_components/presenters/page_with_step_by_step_navigatio
 require "govuk_publishing_components/presenters/public_layout_helper"
 require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_ancestors"
 require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_taxons"
-require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_topic"
 require "govuk_publishing_components/presenters/checkboxes_helper"
 require "govuk_publishing_components/presenters/select_helper"
 require "govuk_publishing_components/presenters/meta_tags"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 37.9.0
+  version: 37.10.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-20 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -957,7 +957,6 @@ files:
 - lib/govuk_publishing_components/presenters/component_wrapper_helper.rb
 - lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_ancestors.rb
 - lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_taxons.rb
-- lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_topic.rb
 - lib/govuk_publishing_components/presenters/content_item.rb
 - lib/govuk_publishing_components/presenters/contents_list_helper.rb
 - lib/govuk_publishing_components/presenters/contextual_navigation.rb
@@ -1640,7 +1639,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.7
 signing_key: 
 specification_version: 4
 summary: A gem to document components in GOV.UK frontend applications

data/lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_topic.rb

@@ -1,38 +0,0 @@
-module GovukPublishingComponents
-  module Presenters
-    class ContentBreadcrumbsBasedOnTopic
-      def self.call(content_item)
-        new(content_item).breadcrumbs
-      end
-
-      attr_reader :content_item
-
-      def initialize(content_item)
-        @content_item = content_item
-      end
-
-      def breadcrumbs
-        breadcrumbs = [{ title: "Home", url: "/" }]
-        return breadcrumbs unless topics.present?
-
-        breadcrumbs << topic_breadcrumb
-        breadcrumbs
-      end
-
-      def topic_breadcrumb
-        {
-          title: first_topic["title"],
-          url: first_topic["base_path"],
-        }
-      end
-
-      def first_topic
-        topics.first
-      end
-
-      def topics
-        @topics ||= content_item.dig("links", "topics")
-      end
-    end
-  end
-end