govuk_publishing_components 37.1.0 → 37.2.0

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

@@ -7,6 +7,7 @@
   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)
+  absolute_links_helper = GovukPublishingComponents::Presenters::AbsoluteLinksHelper.new()
 %>
 <%= tag.footer class: classes, role: "contentinfo", 'data-module': "ga4-link-tracker" do %>
   <div class="govuk-width-container">
@@ -51,6 +52,8 @@
                           unless attributes[:data][:ga4_link]
                             attributes[:data][:ga4_link] = layout_footer_helper.generate_ga4_link_attribute(index, ga4_section_index, section[:title], index_total)
                           end
+
+                          item[:href] = absolute_links_helper.make_url_absolute(item[:href])
                         %>
                         <%= link_to item[:text], item[:href], attributes %>
                       </li>
@@ -82,6 +85,8 @@
                   unless attributes[:data][:ga4_link]
                     attributes[:data][:ga4_link] = layout_footer_helper.generate_ga4_link_attribute(index, navigation.length, "Support links", index_total)
                   end
+
+                  item[:href] = absolute_links_helper.make_url_absolute(item[:href])
                 %>
                 <%= link_to item[:text], item[:href], attributes %>
               </li>

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

@@ -70,6 +70,8 @@
 
   popular_links_heading_classes = %w(govuk-heading-m)
   popular_links_heading_classes << "gem-c-layout-super-navigation-header__popular-links-heading--large-navbar" if large_navbar
+
+  absolute_links_helper = GovukPublishingComponents::Presenters::AbsoluteLinksHelper.new()
 %>
 <%= content_tag("header",
   {
@@ -311,9 +313,10 @@
                         link_classes = %w[govuk-link gem-c-layout-super-navigation-header__navigation-second-item-link]
                         link_classes << "gem-c-layout-super-navigation-header__navigation-second-item-link--with-description" if has_description
                         tracking_label = column[:label].downcase.gsub(/\s+/, "")
+                        link_href = absolute_links_helper.make_url_absolute(item[:href])
                       %>
                       <li class="gem-c-layout-super-navigation-header__dropdown-list-item">
-                        <%= link_to item[:label], item[:href], {
+                        <%= link_to item[:label], link_href, {
                           class: link_classes,
                           data: {
                             track_action: "#{tracking_label}Link",
@@ -360,7 +363,7 @@
                 data-ga4-form='{ "event_name": "search", "type": "header menu bar", "section": "Search GOV.UK", "action": "search", "url": "/search/all" }'
                 data-ga4-form-include-text
                 data-ga4-form-no-answer-undefined
-                action="/search"
+                action="<%= absolute_links_helper.make_url_absolute('/search') %>"
                 method="get"
                 role="search"
                 aria-label="Site-wide"
@@ -394,7 +397,8 @@
                 <% 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], {
+                    <% link_href = absolute_links_helper.make_url_absolute(popular_link[:href]) %>
+                    <%= link_to popular_link[:label], link_href, {
                       class: [
                         "govuk-link",
                         "gem-c-layout-super-navigation-header__popular-link",

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

@@ -65,11 +65,7 @@
                     class="gem-c-metadata__definition-link govuk-!-display-none-print js-see-all-updates-link"
                     data-track-category="content-history"
                     data-track-action="see-all-updates-link-clicked"
-                    data-track-label="history"
-                    <% unless disable_ga4 %>
-                      data-module="ga4-link-tracker"
-                      data-ga4-link="<%= ga4_object %>"
-                    <% end%>>
+                    data-track-label="history">
             <%= t("components.metadata.see_all_updates") %>
           </a>
         <% end %>

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

@@ -61,6 +61,27 @@ examples:
         tracking: GTM-123AB
       block: |
         We need to know your nationality so we can work out which elections you’re entitled to vote in. If you can’t provide your nationality, you’ll have to send copies of identity documents through the post.
+  with_ga4_tracking:
+    description: |
+      GA4 tracking is mostly handled internally by the component, apart from the required attribute `index_section_count`. This records the number of details components on the page and must be passed by the hosting application. Other GA4 attributes can also be passed if required, including to override attributes set by the component (for some reason this doesn't work in the component guide but works in applications).
+
+      The tracking automatically includes `index_section` as the index of the component on the page compared with other instances of the component that are also being tracked, e.g. the first details component on a page will be `index_section` 1, the second `index_section` 2, etc.
+
+      Link tracking for the contents of the details component is not included due to varying tracking requirements. If you need to track links in the component, wrap it in the application with the [GA4 link tracker](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics-ga4/ga4-link-tracker.md).
+    data:
+      title: What did the ground say to the train?
+      ga4_attributes: {
+        index_section_count: 6,
+        type: "not the default"
+      }
+      block: |
+        Between you and me, I've been tracked.
+  disable_ga4_tracking:
+    description: Disables GA4 tracking on the component. Tracking is enabled by default.
+    data:
+      title: No tracking here
+      disable_ga4: true
+      block: Or here, but thanks for looking.
   open:
     data:
       title: Help with nationality

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

@@ -12,6 +12,7 @@ accessibility_criteria: |
   - include alt text for images when present
   - not have duplicate links for the image and the text
   - if the contents of the component are in a different language than the rest of the document, include an appropriate `lang` attribute to correctly identify the language used in the component
+uses_component_wrapper_helper: true
 shared_accessibility_criteria:
   - link
 embed: |
@@ -276,6 +277,23 @@ examples:
           }
         }
       ]
+  with_ga4_tracking:
+    description: The component does not include an option for GA4 tracking, but data attributes to enable the [GA4 link tracker](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics-ga4/ga4-link-tracker.md) can be passed as shown.
+    data:
+      href: "/not-a-page"
+      image_src: "https://assets.publishing.service.gov.uk/government/uploads/system/uploads/feature/image/62756/s300_courts-of-justice.JPG"
+      image_alt: "some meaningful alt text please"
+      heading_text: "News headline"
+      data_attributes:
+        module: "ga4-link-tracker"
+        ga4_link:
+          event_name: "navigation"
+          type: "homepage"
+          index_section: 1
+          index_link: 1
+          index_section_count: 1
+          index_total: 1
+          section: "homepage"
   with_metadata:
     description: Can be used for links to people pages to indicate payment type
     data:
@@ -293,17 +311,6 @@ examples:
         }
       ]
       extra_details_no_indent: true
-  with_lang:
-    description: |
-      Pass through an appropriate `lang` to set a HTML lang attribute for the component.
-
-      The `lang` attribute **must** be set to a [valid BCP47 string](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang#Language_tag_syntax). A valid code can be the two or three letter language code - for example, English is `en` or `eng`, Korean is `ko` or `kor` - but if in doubt please check.
-    data:
-      href: "/not-a-page"
-      image_src: "https://assets.publishing.service.gov.uk/government/uploads/system/uploads/feature/image/62756/s300_courts-of-justice.JPG"
-      image_alt: "some meaningful alt text please"
-      heading_text: Yr hyn rydym ni'n ei wneud
-      lang: cy
   with_sizes_attribute:
     description: |
       `sizes` is an attribute that makes use of html's native responsive images functionality.

data/app/views/govuk_publishing_components/components/feedback/_problem_form.html.erb

@@ -1,4 +1,8 @@
-<form action="/contact/govuk/problem_reports"
+<%
+ absolute_links_helper = GovukPublishingComponents::Presenters::AbsoluteLinksHelper.new()
+%>
+
+<form action="<%= absolute_links_helper.make_url_absolute('/contact/govuk/problem_reports') %>"
   id="something-is-wrong"
   class="gem-c-feedback__form js-feedback-form"
   data-track-category="Onsite Feedback"

data/app/views/govuk_publishing_components/components/feedback/_survey_signup_form.html.erb

@@ -1,4 +1,8 @@
-<form action="/contact/govuk/email-survey-signup"
+<%
+ absolute_links_helper = GovukPublishingComponents::Presenters::AbsoluteLinksHelper.new()
+%>
+
+<form action="<%= absolute_links_helper.make_url_absolute('/contact/govuk/email-survey-signup') %>"
   id="page-is-not-useful"
   class="gem-c-feedback__form gem-c-feedback__form--email gem-c-feedback__js-show js-feedback-form"
   data-track-category="yesNoFeedbackForm"

data/lib/govuk_publishing_components/presenters/absolute_links_helper.rb

@@ -0,0 +1,20 @@
+module GovukPublishingComponents
+  module Presenters
+    class AbsoluteLinksHelper
+      def make_url_absolute(href)
+        # If the URL is already absolute do nothing
+        unless href.start_with?("/")
+          return href
+        end
+
+        host = ENV["VIRTUAL_HOST"] || Plek.new.website_root
+
+        unless host.start_with?("http://", "https://", "//")
+          host = "//#{host}" # '//' preserves the current protocol, we shouldn't force https as that would break dev environments
+        end
+
+        "#{host}#{href}"
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "37.1.0".freeze
+  VERSION = "37.2.0".freeze
 end

data/lib/govuk_publishing_components.rb

@@ -7,6 +7,7 @@ require "govuk_publishing_components/engine"
 require "govuk_publishing_components/version"
 require "govuk_publishing_components/presenters/shared_helper"
 require "govuk_publishing_components/presenters/component_wrapper_helper"
+require "govuk_publishing_components/presenters/absolute_links_helper"
 require "govuk_publishing_components/presenters/accordion_helper"
 require "govuk_publishing_components/presenters/attachment_helper"
 require "govuk_publishing_components/presenters/big_number_helper"