govuk_publishing_components 35.3.0 → 35.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f87c9fa99d845d53392c5a02a8c4330f7a9557b94290a55cc18b5f169862215
-  data.tar.gz: ee6d97596ccbc7cfc9704f95dd3b1940e6b60254fc3fe7f6c51d5d6c16d1ead4
+  metadata.gz: 66ace2c61b08a0641bc1234bf1e1b34e3e2e184ad07f554bde39c60280e58dd5
+  data.tar.gz: fb3dbf387e8e668bf81b2b13c8c73a5152d3d4c2e570f7b2743e96f424b70680
 SHA512:
-  metadata.gz: 635eaae4b3ce872688184197dd240be9751f6d9286680f324a876cea3d00a9bfa0b6037b5817fbf58a66d319510dcbca747ff5c7bc69e5d76a7c33cb345963cb
-  data.tar.gz: 595feac64b2542ef4ff5cb669e7e12462cea78d250cb0d44f01312de9297379d0e2c9f4d8bff0ab75a59a3b523fd6d801df93518f4c407c600b87695c17c1ea8
+  metadata.gz: da81d3abeeb7d15ea0c74d1f428df7a9d7856ce078a50e63c8e66da7e244dea937f6600a457592c5ebafc1615dd623a8cc81e578e2a8eae4de97e7fa8fb7b779
+  data.tar.gz: c2dcc61e03d0999871fca19f559833717892cb67ab16ed198eb8266fe06fe0d58a6465d65eae4e62c3aa84865732216ffeb8e224b2cb9f84fb8a2ae5ef089491

data/app/assets/javascripts/govuk_publishing_components/components/step-by-step-nav.js

@@ -84,7 +84,7 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
 
     // if GA4 is enabled, set attributes on 'show all sections' for tracking using ga4-event-tracker
     if (this.$module.isGa4Enabled) {
-      var showAllAttributesGa4 = { event_name: 'select_content', type: 'step by step', index: 0, index_total: this.$module.totalSteps }
+      var showAllAttributesGa4 = { event_name: 'select_content', type: 'step by step', index: 0, index_section_count: this.$module.totalSteps }
       this.$module.showOrHideAllButton.setAttribute('data-ga4-event', JSON.stringify(showAllAttributesGa4))
     }
   }

data/app/assets/stylesheets/govuk_publishing_components/components/helpers/_brand-colours.scss

@@ -87,3 +87,12 @@
     border-color: govuk-colour("black");
   }
 }
+
+// new colour for DSIT for use until govuk-frontend#3523 has been released
+
+.brand--department-for-science-innovation-and-technology {
+  &.brand__border-color,
+  .brand__border-color {
+    border-color: #045f71;
+  }
+}

data/app/controllers/govuk_publishing_components/audit_controller.rb

@@ -17,7 +17,6 @@ module GovukPublishingComponents
         licence-finder
         release
         search-admin
-        service-manual-frontend
         signon
         smart-answers
         static

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

@@ -42,7 +42,9 @@
                 tabindex: "-1",
                 "aria-hidden": true,
                 data: data_attributes do %>
-      <% if attachment.document? %>
+      <% if attachment.thumbnail_url %>
+        <% image_tag(attachment.thumbnail_url, alt: "") %>
+      <% elsif attachment.document? %>
         <%= render "govuk_publishing_components/components/attachment/thumbnail_document" %>
       <% elsif attachment.spreadsheet? %>
         <%= render "govuk_publishing_components/components/attachment/thumbnail_spreadsheet" %>

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

@@ -5,6 +5,9 @@
   request.query_parameters[:ga4_tracking] = ga4_tracking
   navigation = GovukPublishingComponents::Presenters::ContextualNavigation.new(content_item, request)
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
+  show_ukraine_cta = navigation.show_ukraine_cta?
+  ga4_tracking_counts = OpenStruct.new(index_section_count: 0)
+  ga4_tracking_counts.index_section_count = 1 if show_ukraine_cta
 %>
 
 <div class="gem-c-contextual-sidebar">
@@ -18,7 +21,7 @@
     <%= render 'govuk_publishing_components/components/step_by_step_nav', navigation.step_nav_helper.sidebar %>
   <% else %>
     <%# Rendering related navigation sidebar because no step by step list %>
-    <%= render 'govuk_publishing_components/components/related_navigation', content_item: content_item, context: :sidebar, ga4_tracking: ga4_tracking %>
+    <%= render 'govuk_publishing_components/components/related_navigation', content_item: content_item, context: :sidebar, ga4_tracking: ga4_tracking, ga4_tracking_counts: ga4_tracking_counts %>
   <% end %>
 
   <% if navigation.content_tagged_to_other_step_by_steps? %>
@@ -31,7 +34,7 @@
     } %>
   <% end %>
 
-  <% if navigation.show_ukraine_cta? %>
-    <%= render 'govuk_publishing_components/components/contextual_sidebar/ukraine_cta', content_item: content_item, ga4_tracking: ga4_tracking %>
+  <% if show_ukraine_cta %>
+    <%= render 'govuk_publishing_components/components/contextual_sidebar/ukraine_cta', content_item: content_item, ga4_tracking: ga4_tracking, ga4_tracking_counts: ga4_tracking_counts %>
   <% end %>
 </div>

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

@@ -35,6 +35,7 @@
             <div class="<%= width_class %> govuk-!-display-none-print">
               <h2 class="govuk-footer__heading govuk-heading-m"><%= section[:title] %></h2>
                 <ul class="<%= list_classes.join(' ') %>">
+                  <% index_total = section[:items].length %>
                   <% section[:items].each_with_index do |item, index| %>
                     <% if item[:href] && item[:text] %>
                       <li class="govuk-footer__list-item">
@@ -48,7 +49,7 @@
                           attributes[:rel] = "noopener" if attributes[:target] == "_blank" && !attributes[:rel]
 
                           unless attributes[:data][:ga4_link]
-                            attributes[:data][:ga4_link] = layout_footer_helper.generate_ga4_link_attribute(index, ga4_section_index, section[:title])
+                            attributes[:data][:ga4_link] = layout_footer_helper.generate_ga4_link_attribute(index, ga4_section_index, section[:title], index_total)
                           end
                         %>
                         <%= link_to item[:text], item[:href], attributes %>
@@ -68,6 +69,7 @@
         <% if meta.any? %>
           <h2 class="govuk-visually-hidden"><%= t("components.layout_footer.support_links") %></h2>
           <ul class="govuk-footer__inline-list govuk-!-display-none-print" data-module="gem-track-click" data-track-links-only>
+            <% index_total = meta[:items].length %>
             <% meta[:items].each_with_index do |item, index| %>
               <li class="govuk-footer__inline-list-item">
                 <%
@@ -78,7 +80,7 @@
                   attributes[:rel] = "noopener" if attributes[:target] == "_blank" && !attributes[:rel]
 
                   unless attributes[:data][:ga4_link]
-                    attributes[:data][:ga4_link] = layout_footer_helper.generate_ga4_link_attribute(index, navigation.length, "Support links")
+                    attributes[:data][:ga4_link] = layout_footer_helper.generate_ga4_link_attribute(index, navigation.length, "Support links", index_total)
                   end
                 %>
                 <%= link_to item[:text], item[:href], attributes %>
@@ -111,7 +113,7 @@
               "index_section_count": layout_footer_helper.ga4_index_section_count.to_s,
             },
             "text": "Open Government Licence v3.0",
-            "index_total": layout_footer_helper.ga4_index_total.to_s,
+            "index_total": "1",
             "type": "footer",
           }.to_json %>"
         >
@@ -136,7 +138,7 @@
             "index_section_count": layout_footer_helper.ga4_index_section_count.to_s,
           },
           "text": "© Crown copyright",
-          "index_total": layout_footer_helper.ga4_index_total.to_s,
+          "index_total": "1",
           "type": "footer",
         }.to_json %>"
       >

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

@@ -16,12 +16,6 @@
   show_search_menu_text = t("components.layout_super_navigation_header.menu_toggle_label.show", :label => "search")
   hide_navigation_menu_text = t("components.layout_super_navigation_header.menu_toggle_label.hide", :label => "navigation")
   show_navigation_menu_text = t("components.layout_super_navigation_header.menu_toggle_label.show", :label => "navigation")
-
-  navigation_links_length = 1 # GOVUK Logo makes this start from 1
-  navigation_links_columns.each do | column |
-    navigation_links_length = navigation_links_length + column[:menu_contents].length
-  end
-  navigation_links_length = navigation_links_length + popular_links.length
 %>
 <header role="banner" class="gem-c-layout-super-navigation-header" data-module="gem-track-click ga4-event-tracker ga4-link-tracker" data-track-links-only data-ga4-expandable>
   <div class="gem-c-layout-super-navigation-header__container govuk-clearfix">
@@ -46,7 +40,7 @@
             "index": {
               "index_section": 0,
             },
-            "index_total": navigation_links_length
+            "index_total": 1
           }.to_json %>"
         >
           <span class="govuk-header__logotype">
@@ -225,6 +219,7 @@
                   <%= column[:label] %>
                 </h3>
                 <ul class="gem-c-layout-super-navigation-header__navigation-second-items gem-c-layout-super-navigation-header__navigation-second-items--<%= column[:label].downcase.sub(" ", "-") %>">
+                  <% index_total = column[:menu_contents].length %>
                   <% column[:menu_contents].each_with_index do | item, index | %>
                       <%
                         has_description = item[:description].present?
@@ -249,7 +244,7 @@
                                 "index_link": index + 1,
                                 "index_section_count": 4,
                               },
-                              "index_total": navigation_links_length,
+                              "index_total": index_total,
                               "section": column[:label],
                             }
                           }
@@ -302,6 +297,7 @@
             <div class="govuk-grid-column-full">
               <h3 class="govuk-heading-m"><%= popular_links_heading %></h3>
               <ul class="govuk-list">
+                <% index_total = popular_links.length %>
                 <% popular_links.each_with_index do | popular_link, index | %>
                   <li class="gem-c-layout-super-navigation-header__popular-item">
                     <%= link_to popular_link[:label], popular_link[:href], {
@@ -323,7 +319,7 @@
                             "index_link": index + 1,
                             "index_section_count": 4,
                           },
-                          "index_total": navigation_links_length,
+                          "index_total": index_total,
                           "section": popular_links_heading,
                         }
                       }

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

@@ -5,12 +5,11 @@
   data = {}
   data[:module] = "gem-track-click"
   data[:module] << " ga4-link-tracker" if ga4_tracking
-%>
+  ga4_tracking_counts ||= OpenStruct.new(index_section_count: 0)
+  ga4_tracking_counts.index_section_count += related_nav_helper.index_section_count
 
-<%
   add_gem_component_stylesheet("related-navigation")
 %>
-
 <% if related_nav_helper.related_navigation? %>
   <% random = SecureRandom.hex(4) %>
   <%= tag.div(class: "gem-c-related-navigation", data: data) do %>
@@ -30,7 +29,6 @@
     <% end %>
 
     <% section_index = 0 %>
-
     <% related_nav_helper.related_navigation.each do |section_title, links| %>
       <% next unless links.any? %>
 
@@ -42,6 +40,7 @@
         section_title: section_title,
         links: links,
         section_index: section_index,
+        section_count: ga4_tracking_counts.index_section_count,
         random: random,
         ga4_tracking: ga4_tracking %>
     <% end %>

data/app/views/govuk_publishing_components/components/contextual_sidebar/_ukraine_cta.html.erb

@@ -8,13 +8,19 @@
 <%= tag.div class: "gem-c-contextual-sidebar__cta gem-c-contextual-sidebar__cta--ukraine", data: { module: data_module } do %>
   <%= tag.h2 title, class: "gem-c-contextual-sidebar__heading govuk-heading-s" %>
   <%= tag.ul class: "gem-c-contextual-sidebar__list" do %>
+    <% index_total = t("components.related_navigation.ukraine.links").length %>
     <% t("components.related_navigation.ukraine.links").each_with_index do |link, index| %>
       <%= tag.li class: "gem-c-contextual-sidebar__text govuk-body" do %>
         <%
           ga4_attributes = {
             event_name: "navigation",
             type: "related content",
-            index: "1.#{index + 1}",
+            index: {
+              index_section: "#{ga4_tracking_counts.index_section_count}",
+              index_link: "#{index + 1}",
+              index_section_count: "#{ga4_tracking_counts.index_section_count}",
+            },
+            index_total: "#{index_total}",
             section: title,
           } if ga4_tracking
         %>

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

@@ -168,3 +168,12 @@ examples:
         filename: department-for-transport-information-asset-register.csv
         content_type: text/csv
         file_size: 20000
+  with_custom_thumbnail:
+    data:
+      attachment:
+        title: "Department for Transport, temporary snow ploughs: guidance note"
+        url: https://assets.publishing.service.gov.uk/government/uploads/system/uploads/attachment_data/file/259634/temporary-snow-ploughs.pdf
+        filename: temporary-snow-ploughs.pdf
+        content_type: application/pdf
+        file_size: 20000
+        thumbnail_url: "https://assets.publishing.service.gov.uk/government/uploads/system/uploads/attachment_data/file/791567/thumbnail_the_government_financial_reporting_review_web.pdf.png"

data/app/views/govuk_publishing_components/components/related_navigation/_section.html.erb

@@ -24,17 +24,23 @@
   <% end %>
 
   <ul class="gem-c-related-navigation__link-list">
-    <% constructed_link_array = [] %>
-
-    <% section_link_limit = related_nav_helper.calculate_section_link_limit(links) %>
-
+    <% 
+      constructed_link_array = []
+      section_link_limit = related_nav_helper.calculate_section_link_limit(links)
+      index_total = links.length
+    %>
     <% links.each.with_index(1) do |link, index| %>
       <%
         link_class = "govuk-link #{related_nav_helper.section_css_class("govuk-link gem-c-related-navigation__section-link", section_title, link: link, link_is_inline: (index >= section_link_limit))}"
         ga4_attributes = {
           event_name: "navigation",
           type: "related content",
-          index: "#{section_index}.#{index}",
+          index: {
+            index_section: "#{section_index}",
+            index_link: "#{index}",
+            index_section_count: "#{section_count}",
+          },
+          index_total: "#{index_total}",
           section: ga4_heading_text,
         } if ga4_tracking
         link_element = link_to(

data/lib/govuk_publishing_components/presenters/attachment_helper.rb

@@ -12,6 +12,10 @@ module GovukPublishingComponents
         @attachment_data = attachment_data.with_indifferent_access
       end
 
+      def thumbnail_url
+        @attachment_data[:thumbnail_url]
+      end
+
       def title
         attachment_data.fetch(:title)
       end

data/lib/govuk_publishing_components/presenters/layout_footer_helper.rb

@@ -1,35 +1,25 @@
 module GovukPublishingComponents
   module Presenters
     class LayoutFooterHelper
-      attr_reader :ga4_index_total, :ga4_index_section_count, :ga4_ogl_link_index_section, :ga4_copyright_link_index_section
+      attr_reader :ga4_index_section_count, :ga4_ogl_link_index_section, :ga4_copyright_link_index_section
 
       def initialize(footer_navigation_section, footer_meta_section)
-        @ga4_index_total = 0
-        @ga4_index_section_count = 0
+        @ga4_index_section_count = footer_navigation_section.length
         @amount_of_meta_sections = 0
 
-        footer_navigation_section.each do |section|
-          @ga4_index_section_count += 1
-          if section[:items]
-            @ga4_index_total += section[:items].length
-          end
-        end
-
         if footer_meta_section.any?
           @amount_of_meta_sections = 1
           @ga4_index_section_count += 1
-          @ga4_index_total += footer_meta_section[:items].length
         end
 
-        # For our GOVUK footer links, we need to add 2 to the index_total and index_section_count. This is due to the "Open Government License" and "Crown Copyright" links being defined separately to the rest of our footer links.
-        @ga4_index_total += 2
+        # For our GOVUK footer links, we need to add 2 to the index_section_count. This is due to the "Open Government License" and "Crown Copyright" links being defined separately to the rest of our footer links.
         @ga4_index_section_count += 2
 
         @ga4_ogl_link_index_section = footer_navigation_section.length + @amount_of_meta_sections + 1
-        @ga4_copyright_link_index_section = footer_navigation_section.length + @amount_of_meta_sections + 2
+        @ga4_copyright_link_index_section = @ga4_ogl_link_index_section + 1
       end
 
-      def generate_ga4_link_attribute(index_link, index_section, section)
+      def generate_ga4_link_attribute(index_link, index_section, section, index_total)
         {
           "event_name": "navigation",
           "type": "footer",
@@ -38,7 +28,7 @@ module GovukPublishingComponents
             "index_section": (index_section + 1).to_s,
             "index_section_count": @ga4_index_section_count.to_s,
           },
-          "index-total": @ga4_index_total.to_s,
+          "index_total": index_total.to_s,
           "section": section,
         }
       end

data/lib/govuk_publishing_components/presenters/related_navigation_helper.rb

@@ -16,12 +16,16 @@ module GovukPublishingComponents
         "UK Mission to the European Union" => "uk-mission-to-the-eu",
       }.freeze
 
+      attr_reader :related_navigation, :index_section_count
+
       def initialize(options = {})
         @content_item = options.fetch(:content_item) { raise ArgumentError, "missing argument: content_item" }
         @context = options.fetch(:context, nil)
+        @related_navigation = related_navigation_contents
+        @index_section_count = section_count
       end
 
-      def related_navigation
+      def related_navigation_contents
         case @context.try(:to_sym)
         when :sidebar
           {
@@ -53,6 +57,10 @@ module GovukPublishingComponents
         end
       end
 
+      def section_count
+        @related_navigation.select { |_, links| links.any? }.length
+      end
+
       def construct_section_text(section, underscores_to_spaces)
         unless section == "related_items"
           defaults = [I18n.t("components.related_navigation.#{section}")]

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "35.3.0".freeze
+  VERSION = "35.3.2".freeze
 end

metadata

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