govuk_publishing_components 35.0.0 → 35.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90043704d7994696d49541ef766ca866648e3594be347483450194425d229dc7
-  data.tar.gz: 43f81d610ba1484584043399cd9b69219aaa010f00241dcb11fbffc24d6ea2de
+  metadata.gz: da29b78f56ceabe774802deed6b8570f0459ba1414b60d0a46b1c891facb5b25
+  data.tar.gz: 2b431b2babeb7dc74281f27b13f23525b658d8cace7727ed08658945d0669763
 SHA512:
-  metadata.gz: a656046225d2491310ba439b342b639844dbdcdfcf908ace0d26a2db995c2aa4813a9273298591a595b2224a018167f17a3aea2ae67555b472f2ac75f7f26e5e
-  data.tar.gz: 6f1110a0611153a5d1d494f7afc38523efb1db88949757756b11acfad77306408d12794be83753aed7bc618f10a30c6463e0719e8a7f4f24a67328a071d147c2
+  metadata.gz: 74a753d9e83276ae6c71bf0ce682a8cfd269195adda6ca9d04188d729f19da63103de4a31285902a5195b87762921a905adb91acf5674a19e1b0e90a9b3c5f6d
+  data.tar.gz: 17a2048555b604f03a55ab8756c9a33a8b1324b8c2db8944868264d06526e1e01fd2ced69b3fb06746be8252e32aaeb0d7b2a28ae005b0ccd082986f5b408d4a

data/app/assets/javascripts/govuk_publishing_components/analytics/page-content.js

@@ -17,8 +17,6 @@
         // if there are no accordion sections on the browse level 2 page
         // then it is a default page with one or two lists
         return document.querySelectorAll('[data-track-count="accordionSection"]').length || document.querySelectorAll('main .govuk-list').length
-      case isCostOfLivingHub():
-        return document.querySelectorAll('[data-track-count="accordionSection"]').length
       case isNewBrowsePage():
         return document.querySelectorAll('[data-track-count="cardList"]').length
       case isMainstreamBrowsePage():
@@ -53,7 +51,6 @@
       case isDocumentCollectionPage():
         return document.querySelectorAll('.document-collection .group-document-list li a').length
       case isNewBrowsePageLevelTwo():
-      case isCostOfLivingHub():
         return document.querySelectorAll('[data-track-count="contentLink"]').length
       case isNewBrowsePage():
         return document.querySelectorAll('[data-track-count="cardLink"]').length
@@ -111,11 +108,6 @@
       getMetaAttribute(metaNavigationTypeSelector) === 'browse level 2'
   }
 
-  function isCostOfLivingHub () {
-    return getMetaAttribute(metaApplicationSelector) === 'collections' &&
-      getMetaAttribute(metaNavigationTypeSelector) === 'cost of living hub'
-  }
-
   function isNewBrowsePage () {
     return getMetaAttribute(metaApplicationSelector) === 'collections' &&
       (getMetaAttribute(metaNavigationTypeSelector) === 'browse level 0' ||

data/app/assets/stylesheets/govuk_publishing_components/components/_layout-super-navigation-header.scss

@@ -705,7 +705,7 @@ $after-button-padding-left: govuk-spacing(4);
   }
 
   @include govuk-media-query($from: "desktop") {
-    @include columns($items: 17, $columns: 2, $selector: "li", $flow: column);
+    @include columns($items: 16, $columns: 2, $selector: "li", $flow: column);
   }
 }
 

data/app/assets/stylesheets/govuk_publishing_components/components/helpers/_markdown-typography.scss

@@ -148,7 +148,7 @@
 
   code {
     padding: 0 5px;
-    color: govuk-colour("red");
+    color: #d13118;
     background-color: govuk-colour("light-grey");
   }
 }

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

@@ -9,12 +9,14 @@
   if items.empty? && !title
     raise ArgumentError, "The error_summary component needs at least one item or a title in order to render."
   end
+
+  component_helper = GovukPublishingComponents::Presenters::ComponentWrapperHelper.new(local_assigns)
+  component_helper.set_id(id)
+  component_helper.add_class("gem-c-error-summary govuk-error-summary")
+  component_helper.add_data_attribute({ module: "govuk-error-summary" })
 %>
-<%= tag.div(
-  class: "gem-c-error-summary govuk-error-summary",
-  data: { module: "govuk-error-summary" }.merge(data_attributes),
-  id: id,
-) do %>
+
+<%= tag.div(**component_helper.all_attributes) do %>
   <%= tag.div(
     role: "alert",
   ) do %>

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

@@ -6,15 +6,16 @@
   with_border ||= false
   classes = %w(gem-c-layout-footer govuk-footer)
   classes << "gem-c-layout-footer--border" if with_border
+  layout_footer_helper = GovukPublishingComponents::Presenters::LayoutFooterHelper.new(navigation, meta)
 %>
-<%= tag.footer class: classes, role: "contentinfo" do %>
+<%= tag.footer class: classes, role: "contentinfo", 'data-module': "ga4-link-tracker" do %>
   <div class="govuk-width-container">
     <% if navigation.any? %>
       <div class="govuk-footer__navigation" data-module="gem-track-click" data-track-links-only>
-        <% navigation.each do |item| %>
-          <% if item[:items] %>
+        <% navigation.each_with_index do |section, ga4_section_index| %>
+          <% if section[:items] %>
             <%
-              case item[:columns]
+              case section[:columns]
               when 2
                 width_class = "govuk-grid-column-two-thirds"
               when 3
@@ -26,25 +27,29 @@
               # If the list has multiple columns and there is only one link.
               # This is to prevent a long link wrapping in a column, which
               # leaves an obvious blank space to the right.
-              single_item_list = (( item[:columns] == 2 || item[:columns] == 3 ) && item[:items].length == 1 )
+              single_item_list = (( section[:columns] == 2 || section[:columns] == 3 ) && section[:items].length == 1 )
 
               list_classes = %w[govuk-footer__list]
-              list_classes << "govuk-footer__list--columns-#{item[:columns]}" if item[:columns] unless single_item_list
+              list_classes << "govuk-footer__list--columns-#{section[:columns]}" if section[:columns] unless single_item_list
             %>
             <div class="<%= width_class %> govuk-!-display-none-print">
-              <h2 class="govuk-footer__heading govuk-heading-m"><%= item[:title] %></h2>
+              <h2 class="govuk-footer__heading govuk-heading-m"><%= section[:title] %></h2>
                 <ul class="<%= list_classes.join(' ') %>">
-                  <% item[:items].each do |item| %>
+                  <% section[:items].each_with_index do |item, index| %>
                     <% if item[:href] && item[:text] %>
                       <li class="govuk-footer__list-item">
                         <%
                           attributes = {
                             class: "govuk-footer__link",
                             data: {
-                              "track-category": "footerClicked"
+                              "track-category": "footerClicked",
                             }
                           }.merge(item.fetch(:attributes, {}))
                           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])
+                          end
                         %>
                         <%= link_to item[:text], item[:href], attributes %>
                       </li>
@@ -63,11 +68,18 @@
         <% 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>
-            <% meta[:items].each do |item| %>
+            <% meta[:items].each_with_index do |item, index| %>
               <li class="govuk-footer__inline-list-item">
                 <%
-                  attributes = { class: "govuk-footer__link" }.merge(item.fetch(:attributes, {}))
+                  attributes = {
+                    class: "govuk-footer__link",
+                  }.merge(item.fetch(:attributes, {}))
+                  attributes[:data] ||= {}
                   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")
+                  end
                 %>
                 <%= link_to item[:text], item[:href], attributes %>
               </li>
@@ -89,6 +101,19 @@
           data-track-label="https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/"
           data-track-options='{"dimension29": "Open Government Licence v3.0"}'
           data-track-links-only
+          data-ga4-track-links-only
+          data-ga4-link="<%= {
+            "event_name": "navigation",
+            "section": "Licence",
+            "index": {
+              "index_section": layout_footer_helper.ga4_ogl_link_index_section.to_s,
+              "index_link": "1",
+              "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,
+            "type": "footer",
+          }.to_json %>"
         >
           <%= t("components.layout_footer.licence_html") %>
         </span>
@@ -102,6 +127,18 @@
         data-track-label="https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/"
         data-track-options='{"dimension29": "© Crown copyright"}'
         data-track-links-only
+        data-ga4-link="<%= {
+          "event_name": "navigation",
+          "section": "Copyright",
+          "index": {
+            "index_section": layout_footer_helper.ga4_copyright_link_index_section.to_s,
+            "index_link": "1",
+            "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,
+          "type": "footer",
+        }.to_json %>"
       >
         <%= t("components.layout_footer.copyright_html") %>
       </div>

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

@@ -7,6 +7,7 @@ shared_accessibility_criteria:
   - link
 accessibility_excluded_rules:
   - skip-link # This component is creating references to to sections on the page that do not exist in examples
+uses_component_wrapper_helper: true
 examples:
   default:
     data:
@@ -26,18 +27,6 @@ examples:
       - text: Descriptive link to the question with an error 2
         href: '#example-error-2'
       - text: Description of error without link
-  with_data_attributes:
-    description: |
-      The example shown applies a tracking attribute specifically for use by Google Tag Manager in [Content Publisher](https://github.com/alphagov/content-publisher).
-      
-      Other data attributes can also be applied as required. 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).
-    data:
-      title: Message to alert the user to a problem goes here
-      description: Optional description of the errors and how to correct them
-      data_attributes:
-        tracking: GTM-123AB
-      items:
-      - text: Descriptive link to the question with an error 1
   with_custom_target_on_links:
     data:
       title: Message to alert the user to a problem goes here

data/config/locales/en.yml

@@ -102,8 +102,6 @@ en:
           href: "/browse/childcare-parenting"
         - text: Citizenship and living in the UK
           href: "/browse/citizenship"
-        - text: Cost of living support
-          href: "/cost-of-living"
         - text: Crime, justice and the law
           href: "/browse/justice"
         - text: Disabled people
@@ -185,8 +183,6 @@ en:
           href: "/browse/childcare-parenting"
         - label: Citizenship and living in the UK
           href: "/browse/citizenship"
-        - label: Cost of living support
-          href: "/cost-of-living"
         - label: Crime, justice and the law
           href: "/browse/justice"
         - label: Disabled people
@@ -234,8 +230,8 @@ en:
       navigation_search_heading: Search and popular pages
       navigation_search_subheading: Search
       popular_links:
-      - label: Check benefits and financial support you can get
-        href: "/check-benefits-financial-support"
+      - label: Get support with the cost of living
+        href: "/cost-of-living"
       - label: Find out about the Energy Bills Support Scheme
         href: "/guidance/getting-the-energy-bills-support-scheme-discount"
       - label: Find a job

data/lib/govuk_publishing_components/presenters/layout_footer_helper.rb

@@ -0,0 +1,47 @@
+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
+
+      def initialize(footer_navigation_section, footer_meta_section)
+        @ga4_index_total = 0
+        @ga4_index_section_count = 0
+        @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
+        @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
+      end
+
+      def generate_ga4_link_attribute(index_link, index_section, section)
+        {
+          "event_name": "navigation",
+          "type": "footer",
+          "index": {
+            "index_link": (index_link + 1).to_s,
+            "index_section": (index_section + 1).to_s,
+            "index_section_count": @ga4_index_section_count.to_s,
+          },
+          "index-total": @ga4_index_total.to_s,
+          "section": section,
+        }
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "35.0.0".freeze
+  VERSION = "35.1.1".freeze
 end

data/lib/govuk_publishing_components.rb

@@ -16,6 +16,7 @@ require "govuk_publishing_components/presenters/button_helper"
 require "govuk_publishing_components/presenters/contextual_navigation"
 require "govuk_publishing_components/presenters/devolved_nations_helper"
 require "govuk_publishing_components/presenters/emergency_banner_helper"
+require "govuk_publishing_components/presenters/layout_footer_helper"
 require "govuk_publishing_components/presenters/related_navigation_helper"
 require "govuk_publishing_components/presenters/step_by_step_nav_helper"
 require "govuk_publishing_components/presenters/page_with_step_by_step_navigation"
@@ -43,8 +44,6 @@ require "govuk_publishing_components/app_helpers/brand_helper"
 require "govuk_publishing_components/app_helpers/environment"
 require "govuk_publishing_components/app_helpers/asset_helper"
 
-require "govuk_publishing_components/railtie" if defined?(Rails::Railtie)
-
 # Add i18n paths and views for usage outside of a Rails app
 I18n.load_path.unshift(
   *Dir.glob(File.expand_path("config/locales/*.yml", GovukPublishingComponents::Config.gem_directory)),
@@ -56,6 +55,10 @@ ActiveSupport.on_load(:action_controller) do
   )
 end
 
+ActiveSupport.on_load(:action_view) do
+  include GovukPublishingComponents::AppHelpers::AssetHelper
+end
+
 module GovukPublishingComponents
   def self.render(component, options = {})
     I18n.with_locale(options.fetch(:locale, "en")) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 35.0.0
+  version: 35.1.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -934,6 +934,7 @@ files:
 - lib/govuk_publishing_components/presenters/heading_helper.rb
 - lib/govuk_publishing_components/presenters/image_card_helper.rb
 - lib/govuk_publishing_components/presenters/intervention_helper.rb
+- lib/govuk_publishing_components/presenters/layout_footer_helper.rb
 - lib/govuk_publishing_components/presenters/machine_readable/article_schema.rb
 - lib/govuk_publishing_components/presenters/machine_readable/creative_work_schema.rb
 - lib/govuk_publishing_components/presenters/machine_readable/dataset_schema.rb
@@ -960,7 +961,6 @@ files:
 - lib/govuk_publishing_components/presenters/step_by_step_nav_helper.rb
 - lib/govuk_publishing_components/presenters/subscription_links_helper.rb
 - lib/govuk_publishing_components/presenters/translation_nav_helper.rb
-- lib/govuk_publishing_components/railtie.rb
 - lib/govuk_publishing_components/version.rb
 - node_modules/axe-core/LICENSE
 - node_modules/axe-core/README.md
@@ -1415,7 +1415,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.4.9
 signing_key: 
 specification_version: 4
 summary: A gem to document components in GOV.UK frontend applications

data/lib/govuk_publishing_components/railtie.rb

@@ -1,7 +0,0 @@
-module GovukPublishingComponents
-  class Railtie < Rails::Railtie
-    initializer "govuk_publishing_components.view_helpers" do
-      ActiveSupport.on_load(:action_view) { include GovukPublishingComponents::AppHelpers::AssetHelper }
-    end
-  end
-end