govuk_publishing_components 37.4.0 → 37.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81dc4d3b658e38f0d167a46180539b5f0f1178f33635d9d9472f3884d8d33355
-  data.tar.gz: 597a4200b06d9c332799947eda6edd505efc78b86e4c892d93ca0a86842fea05
+  metadata.gz: 9ae79b74c7f168d201da93dd67100925c6e89c34ea187b924fd9a4b93abc6b28
+  data.tar.gz: a0386e47e87e26590be08d1671be29add20066d965d1998b370ab26dd21d629e
 SHA512:
-  metadata.gz: 8705485b6efeafbf3ff6803e9199268281c11ba853fbfb5fa3819a13500f41aa3848aeea462ed221dc1df59c3c1657a15a03c01b04d13431c6debd773fc3d2d9
-  data.tar.gz: e5486f71d07feba017108aaf9da158a00f9b5f3110f8f7c123fbcf17bd3d7c48ba70e8eb5e675bdb830d34acd77bfc287cb0c4a9517d63a2621e16f430012f2a
+  metadata.gz: fb9f0fe2fce0cfbce193404c2e0f8a1e7842fdb4d011e96c698c00a999c59d71518b94463ce1ae8369fbc60e72ba0f53d5c590cb947aba2d8d4eb8052d36752b
+  data.tar.gz: a3cd14147b0f1d842f8d8688f6d3dfdc0adbea71588406b3b80b0b97240452fcdf3a9c5a3c366bd59836d6cef5811d8af1410ed6d8cfbe592ad442315d13df81

data/app/assets/javascripts/govuk_publishing_components/vendor/lux/lux-reporter.js

@@ -32,7 +32,8 @@
     var remainingUtValues = utValues.slice(config.maxBeaconUTEntries);
     // Trim UT entries until they fit within the maximum URL length, ensuring at least one UT entry
     // is included.
-    while ((url + "&UT=" + beaconUtValues.join(",")).length > config.maxBeaconUrlLength && beaconUtValues.length > 1) {
+    while ((url + "&UT=" + beaconUtValues.join(",")).length > config.maxBeaconUrlLength &&
+    beaconUtValues.length > 1) {
       remainingUtValues.unshift(beaconUtValues.pop());
     }
     return [beaconUtValues, remainingUtValues];
@@ -546,10 +547,10 @@
     // -------------------------------------------------------------------------
     /// End
     // -------------------------------------------------------------------------
-    var SCRIPT_VERSION = "312";
+    var SCRIPT_VERSION = "313";
     var logger = new Logger();
     var globalConfig = fromObject(LUX);
-    logger.logEvent(LogEvent.EvaluationStart, [SCRIPT_VERSION]);
+    logger.logEvent(LogEvent.EvaluationStart, [SCRIPT_VERSION, globalConfig]);
     // Variable aliases that allow the minifier to reduce file size.
     var document = window.document;
     var addEventListener = window.addEventListener;
@@ -650,7 +651,7 @@
     var gSessionTimeout = 30 * 60; // number of seconds after which we consider a session to have "timed out" (used for calculating bouncerate)
     var gSyncId = createSyncId(); // if we send multiple beacons, use this to sync them (eg, LUX & IX) (also called "luxid")
     var gUid = refreshUniqueId(gSyncId); // cookie for this session ("Unique ID")
-    var gCustomerDataTimeout; // setTimeout timer for sending a Customer Data beacon after onload
+    var gCustomDataTimeout; // setTimeout timer for sending a Custom data beacon after onload
     var gMaxMeasureTimeout; // setTimeout timer for sending the beacon after a maximum measurement time
     var pageRestoreTime; // ms since navigationStart representing when the page was restored from the bfcache
     /**
@@ -1186,16 +1187,16 @@
       }
       if (gbLuxSent) {
         // This is special: We want to allow customers to call LUX.addData()
-        // _after_ window.onload. So we have to send a Customer Data beacon that
-        // includes the new customer data.
+        // _after_ window.onload. So we have to send a Custom data beacon that
+        // includes the new custom data.
         // Do setTimeout so that if there are multiple back-to-back addData calls
         // we get them all in one beacon.
-        if (gCustomerDataTimeout) {
+        if (gCustomDataTimeout) {
           // Cancel the timer for any previous beacons so that if they have not
           // yet been sent we can combine all the data in a new beacon.
-          clearTimeout(gCustomerDataTimeout);
+          clearTimeout(gCustomDataTimeout);
         }
-        gCustomerDataTimeout = setTimeout(_sendCustomerData, 100);
+        gCustomDataTimeout = setTimeout(_sendCustomData, 100);
       }
     }
     // _sample()
@@ -1211,7 +1212,8 @@
     * Re-initialize lux.js to start a new "page". This is typically called within a SPA at the
     * beginning of a page transition, but is also called internally when the BF cache is restored.
     */
-    function _init(startTime) {
+    function _init(startTime, clearFlags) {
+      if (clearFlags === void 0) { clearFlags = true; }
       // Some customers (incorrectly) call LUX.init on the very first page load of a SPA. This would
       // cause some first-page-only data (like paint metrics) to be lost. To prevent this, we silently
       // bail from this function when we detect an unnecessary LUX.init call.
@@ -1245,8 +1247,10 @@
       nErrors = 0;
       gFirstInputDelay = undefined;
       // Clear flags then set the flag that init was called (ie, this is a SPA).
-      gFlags = 0;
-      gFlags = addFlag(gFlags, Flags.InitCalled);
+      if (clearFlags) {
+        gFlags = 0;
+        gFlags = addFlag(gFlags, Flags.InitCalled);
+      }
       // Reset the maximum measure timeout
       createMaxMeasureTimeout();
     }
@@ -1653,9 +1657,9 @@
       if (gFlags) {
         queryParams.push("fl=" + gFlags);
       }
-      var customerData = valuesToString(customData);
-      if (customerData) {
-        queryParams.push("CD=" + customerData);
+      var customDataValues = valuesToString(customData);
+      if (customDataValues) {
+        queryParams.push("CD=" + customDataValues);
         clearUpdateCustomData();
       }
       return globalConfig.beaconUrl + "?" + queryParams.join("&");
@@ -1720,7 +1724,7 @@
           LUX.addData(conversion, BOOLEAN_TRUE);
         });
       }
-      // We want ALL beacons to have ALL the data used for query filters (geo, pagelabel, browser, & customerdata).
+      // We want ALL beacons to have ALL the data used for query filters (geo, pagelabel, browser, & custom data).
       // So we create a base URL that has all the necessary information:
       var baseUrl = _getBeaconUrl(getAllCustomData());
       var is = inlineTagSize("script");
@@ -1819,9 +1823,9 @@
         gbIxSent = 1;
       }
     }
-    // Beacon back customer data that is recorded _after_ the main beacon was sent
-    // (i.e., customer data after window.onload).
-    function _sendCustomerData() {
+    // Beacon back custom data that is recorded _after_ the main beacon was sent
+    // (i.e., custom data after window.onload).
+    function _sendCustomData() {
       var customerid = getCustomerId();
       if (!customerid ||
         !gSyncId ||
@@ -1830,8 +1834,8 @@
       ) {
         return;
       }
-      var sCustomerData = valuesToString(getUpdatedCustomData());
-      if (sCustomerData) {
+      var customDataValues = valuesToString(getUpdatedCustomData());
+      if (customDataValues) {
         var beaconUrl = _getBeaconUrl(getUpdatedCustomData());
         logger.logEvent(LogEvent.CustomDataBeaconSent, [beaconUrl]);
         _sendBeacon(beaconUrl);
@@ -2122,7 +2126,7 @@
             if (gbLuxSent) {
               // If the beacon was already sent for this page, we start a new page view and mark the
               // load time as the time it took to restore the page.
-              _init(pageRestoreTime);
+              _init(pageRestoreTime, false);
               _markLoadTime();
             }
             // Flag the current page as a bfcache restore

data/app/assets/stylesheets/govuk_publishing_components/components/_document-list.scss

@@ -92,11 +92,6 @@
   }
 }
 
-.gem-c-document-list__multi-list {
-  width: 100%;
-  margin-right: 25px;
-}
-
 .gem-c-document-list__item--highlight {
   border: 1px solid govuk-colour("mid-grey", $legacy: "grey-2");
   padding: govuk-spacing(6);

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

@@ -11,20 +11,29 @@
   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
 
-  within_multitype_list ||= false
-  within_multitype_list_class = " gem-c-document-list__multi-list" if within_multitype_list
   title_with_context_class = " gem-c-document-list__item-title--context"
 
   brand ||= false
   brand_helper = GovukPublishingComponents::AppHelpers::BrandHelper.new(brand)
+
+  disable_ga4 ||= false
+  unless disable_ga4
+    ga4_extra_data ||= {}
+    ga4_ul_attributes = {
+      module: "ga4-link-tracker",
+      ga4_track_links_only: "",
+      ga4_link: {
+        "event_name": "navigation",
+        "type": "document list",
+      }.merge(ga4_extra_data)
+    }
+  end
 %>
 <% if items.any? %>
-  <% unless within_multitype_list %>
-    <ul class="<%= classes.join(" ") %>">
-  <% end %>
+  <%= tag.ul(class: classes.join(" "), data: ga4_ul_attributes) do %>
     <% items.each do |item| %>
       <% highlight_class = " gem-c-document-list__item--highlight" if item[:highlight] %>
-      <li class="gem-c-document-list__item<%= within_multitype_list_class %> <%= brand_helper.brand_class %> <%= highlight_class %>">
+      <li class="gem-c-document-list__item <%= brand_helper.brand_class %> <%= highlight_class %>">
         <% if item[:highlight] && item[:highlight_text] %>
           <p class='gem-c-document-list__highlight-text'><%= item[:highlight_text] %></p>
         <% end %>
@@ -127,7 +136,5 @@
         <% end %>
       </li>
     <% end %>
-  <% unless within_multitype_list %>
-    </ul>
   <% end %>
 <% end %>

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

@@ -31,7 +31,6 @@
     event_name: "navigation",
     type: "content history",
     section: "Top",
-    action: "opened"
   }.to_json unless disable_ga4
 %>
 <%= content_tag :div, class: classes, data: { module: "gem-toggle metadata" } do %>

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

@@ -25,9 +25,28 @@
   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" do %>
+  <%= tag.section class: css_classes, aria: aria_attributes, lang: lang, role: "region", data: section_data_attributes 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 %>
@@ -37,8 +56,9 @@
       <%= tag.p description_text, class: "gem-c-notice__description" if description_text %>
 
       <%= description if description %>
-
-      <%= render 'govuk_publishing_components/components/govspeak', content: description_govspeak if description_govspeak %>
+      <% if govspeak_data_attributes %>
+        <%= render 'govuk_publishing_components/components/govspeak', govspeak_data_attributes %>
+      <% end %>
     <% end %>
   <% end %>
 <% end %>

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

@@ -5,7 +5,7 @@
   title ||= false
   track_as_sharing ||= false
   track_as_follow ||= false
-  ga4_data ||= {}
+  ga4_extra_data ||= {}
   stacked ||= false
   columns ||= false
 
@@ -58,7 +58,7 @@
                 'index_link': index + 1,
                 'index_total': links.length,
                 'text': link[:icon],
-              }.merge(ga4_data)
+              }.merge(ga4_extra_data)
             end
             if track_as_follow
               ga4_link_data = {
@@ -66,7 +66,7 @@
                 'type': 'follow us',
                 'index_link': index + 1,
                 'index_total': links.length,
-              }.merge(ga4_data)
+              }.merge(ga4_extra_data)
             end
           %>
           <%

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

@@ -73,7 +73,7 @@ examples:
           public_updated_at: 2016-09-05 16:48:27
           document_type: 'Statutory guidance'
   with_data_attributes_on_links:
-    description: Note that the component does not include built in tracking. If this is required consider using the [track click script](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics/track-click.md).
+    description: Note that the component does not include built in Universal Analytics tracking. If this is required consider using the [track click script](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics/track-click.md).
     data:
       items:
       - link:
@@ -356,3 +356,26 @@ examples:
           path: 'https://www.actionfraud.police.uk/contact-us'
           rel: 'external'
           description: "Contact Action Fraud to report fraud and cyber crime, or to tell them you've been the victim of a scam."
+  with_extra_ga4_data:
+    description: |
+      Allows you to add extra GA4 link tracker attributes, or overwrite the existing ones on the links. 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:
+      ga4_extra_data:
+        hello: 'world'
+      items:
+      - link:
+          text: 'Test link'
+          path: 'https://www.gov.uk'
+          description: "GOV.UK link"
+  without_ga4_tracking:
+    description: |
+      Disables GA4 tracking. Tracking is enabled by default. 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
+      items:
+      - link:
+          text: 'Test link'
+          path: 'https://www.gov.uk'
+          description: "GOV.UK link"

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

@@ -65,3 +65,13 @@ 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/share_links.yml

@@ -111,10 +111,10 @@ examples:
       Where the component is used to allow users to share content on social media, tracking can be added that uses [Social Interactions](https://developers.google.com/analytics/devguides/collection/analyticsjs/social-interactions) in UA.
       If this option is not included, it is assumed the component is simply linking to social media pages and the extra options are omitted from the tracking call in UA.
       In GA4, when this is set to true, a JSON is added to a data-attribute called data-ga4-link, which is detected by ga4-link-tracker.js and pushed to the dataLayer.
-      Most of the tracking values are added by default, but if you need to add more GA4 values or override defaults, you can pass a ga4_data object.
+      Most of the tracking values are added by default, but if you need to add more GA4 values or override defaults, you can pass a ga4_extra_data object.
     data:
       track_as_sharing: true
-      ga4_data: {
+      ga4_extra_data: {
         optional_extra_values: "go here"
       }
       links: [
@@ -133,10 +133,10 @@ examples:
     description: |
       Where the component is used to allow users to follow us on social media, tracking can be added.
       When this is set to true, a JSON is added to a data-attribute called data-ga4-link, which is detected by ga4-link-tracker.js and pushed to the dataLayer.
-      Most of the tracking values are added by default, but if you need to add more GA4 values or override defaults, you can pass a ga4_data object.
+      Most of the tracking values are added by default, but if you need to add more GA4 values or override defaults, you can pass a ga4_extra_data object.
     data:
       track_as_follow: true
-      ga4_data: {
+      ga4_extra_data: {
         optional_extra_values: "go here"
       }
       links: [

data/lib/govuk_publishing_components/presenters/breadcrumb_selector.rb

@@ -45,7 +45,7 @@ module GovukPublishingComponents
             step_by_step: false,
             breadcrumbs: navigation.taxon_breadcrumbs,
           }
-        elsif navigation.content_tagged_to_mainstream_browse_pages?
+        elsif navigation.content_parent_is_mainstream_browse?
           {
             step_by_step: false,
             breadcrumbs: navigation.breadcrumbs,

data/lib/govuk_publishing_components/presenters/contextual_navigation.rb

@@ -68,6 +68,10 @@ module GovukPublishingComponents
         content_item.dig("links", "mainstream_browse_pages").present?
       end
 
+      def content_parent_is_mainstream_browse?
+        content_item.dig("links", "parent").present? && content_item.dig("links", "parent", 0, "document_type") == "mainstream_browse_page"
+      end
+
       def content_has_curated_related_items?
         content_item.dig("links", "ordered_related_items").present? && content_item.dig("links", "parent").present?
       end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "37.4.0".freeze
+  VERSION = "37.5.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 37.4.0
+  version: 37.5.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config