govuk_publishing_components 35.12.0 → 35.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d923b79189269417363dd2c12781e9ee9644a03bf2c514b21e24d71efe0c07c7
-  data.tar.gz: ce1f69cdb8ef0eaf3fcf836e359311e8b38a0f401bb931a3e8bfc27c1b568f56
+  metadata.gz: 1337364c8c59cc2f98de9c4919d17bbb17356257fcc90eb90f25e15db301a0ae
+  data.tar.gz: 70b99e1a524455dc905f457addfb78aa46f0a4fa7be0a69c64a5e34952228be3
 SHA512:
-  metadata.gz: bffc7c115facd8c323182b04f089ecae6b5b2a6991ebed42aea17fc748b1a95bcbf1093f75e238291819bb9d821152b7f4ef3f2b95f0a4b2b1b14021ccbb5a14
-  data.tar.gz: 03c818b7b4f9731f3075020ad5273256a30c3cdef0862f92892edea1dd6cd19e0e65ea781d8c9bb7fb2c87403c5478503442453c68ff80a2deea73ba820e3721
+  metadata.gz: 9a85f01e30436be8cb8f2131f851353e28a8cbad3c0269758789991491ad5ed232ae1e2e9d782e2fa8349c4863c38faadb254a788abb416e3b4ba35f32d196d7
+  data.tar.gz: 103018230befe8fca5796df4f9d2ebff20f255584253d37d5e3aa2c9cd997b7a17a6fdb719932c758f31647a84fb1c85329fc33082bf68ac1ca99fa48fcd7b36

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

@@ -21,6 +21,7 @@ window.GOVUK.analyticsGa4.analyticsModules = window.GOVUK.analyticsGa4.analytics
             title: this.getTitle(),
             status_code: this.getStatusCode(),
 
+            ab_test: this.getMetaContent('ab-test'),
             document_type: this.getMetaContent('format'),
             publishing_app: this.getMetaContent('publishing-app'),
             rendering_app: this.getMetaContent('rendering-app'),

data/app/assets/javascripts/govuk_publishing_components/analytics-ga4/ga4-scroll-tracker.js

@@ -199,14 +199,14 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
   Ga4ScrollTracker.Percentage.prototype.getTrackingNodes = function (trackedNodes) {
     var body = document.body
     var html = document.documentElement
-    var pageHeight = Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight)
+    // remove 20px from the calculated page height to allow for a possible horizontal scrollbar
+    var pageHeight = Math.max(body.scrollHeight, body.offsetHeight, html.clientHeight, html.scrollHeight, html.offsetHeight) - 20
 
     var percentDetails = []
 
     for (var i = 0; i < this.config.percentages.length; i++) {
       var percent = this.config.percentages[i]
-      // subtract 1 pixel to solve a bug where 100% can't be reached in some cases
-      var pos = ((pageHeight / 100) * percent) - 1
+      var pos = ((pageHeight / 100) * percent)
       var alreadySeen = false
       if (trackedNodes.length) {
         alreadySeen = trackedNodes[i].alreadySeen

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

@@ -25,7 +25,9 @@
 
 .gem-c-document-list--no-underline {
   .gem-c-document-list__item-title {
-    text-decoration: none;
+    .govuk-link {
+      text-decoration: none;
+    }
   }
 }
 

data/app/assets/stylesheets/govuk_publishing_components/components/_search.scss

@@ -110,6 +110,10 @@ $large-input-size: 50px;
   border: 0;
   cursor: pointer;
   border-radius: 0;
+  // render a border in high contrast mode
+  outline: $govuk-border-width-form-element solid transparent;
+  // Ensure outline appears outside of the element
+  outline-offset: 0;
   position: relative;
   padding: 0;
   width: $input-size;
@@ -124,8 +128,6 @@ $large-input-size: 50px;
   &:focus {
     z-index: 2;
     outline: $govuk-focus-width solid $govuk-focus-colour;
-    // Ensure outline appears outside of the element
-    outline-offset: 0;
     // Double the border by adding its width again. Use `box-shadow` for this // instead of changing `border-width` - this is for consistency with
     // Also, `outline` cannot be utilised
     // here as it is already used for the yellow focus state.
@@ -161,6 +163,10 @@ $large-input-size: 50px;
 
   .gem-c-search__input {
     border-width: 0;
+    // Render a border in high contrast mode
+    outline: $govuk-border-width-form-element solid transparent;
+    // Ensure outline appears outside of the element
+    outline-offset: 0;
 
     // no need for black outline as there is enough contrast
     // with the blue background

data/app/controllers/govuk_publishing_components/audit_controller.rb

@@ -14,7 +14,6 @@ module GovukPublishingComponents
         government-frontend
         govspeak-preview
         info-frontend
-        licence-finder
         release
         search-admin
         signon
@@ -49,7 +48,9 @@ module GovukPublishingComponents
 
       application_dirs.each do |application|
         application_path = [path, application].join("/")
-        app = AuditApplications.new(application_path, application)
+        dir = application
+        dir = Rails.application.class.module_parent_name.underscore.dasherize unless ENV["MAIN_COMPONENT_GUIDE"]
+        app = AuditApplications.new(application_path, application, dir)
         applications_found += 1 if app.data[:application_found]
         results << app.data
       end

data/app/models/govuk_publishing_components/audit_applications.rb

@@ -2,7 +2,7 @@ module GovukPublishingComponents
   class AuditApplications
     attr_reader :data
 
-    def initialize(path, name)
+    def initialize(path, name, dir)
       @path = path
       application_found = application_exists(path)
       components_found = []
@@ -59,6 +59,7 @@ module GovukPublishingComponents
         # applications might not have all of these things for all components
         options = {
           application_name: name,
+          application_dir: dir,
           templates_path: "app/views/components",
           stylesheets_path: "app/assets/stylesheets/components",
           javascripts_path: "app/assets/javascripts/components/",
@@ -72,6 +73,7 @@ module GovukPublishingComponents
 
       @data = {
         name: name,
+        dir: dir,
         application_found: application_found,
         components_found: components_found,
         gem_style_references: @gem_style_references.flatten.uniq.sort,

data/app/models/govuk_publishing_components/audit_comparer.rb

@@ -12,7 +12,6 @@ module GovukPublishingComponents
           frontend
           government-frontend
           info-frontend
-          licence-finder
           service-manual-frontend
           smart-answers
           whitehall
@@ -93,6 +92,7 @@ module GovukPublishingComponents
 
           data << {
             name: result[:name],
+            dir: result[:dir],
             application_found: result[:application_found],
             uses_static: application_uses_static,
             summary: summary,

data/app/models/govuk_publishing_components/audit_components.rb

@@ -13,6 +13,7 @@ module GovukPublishingComponents
       @helpers_path = options[:helpers_path] || "lib/govuk_publishing_components/presenters"
 
       @application_name = options[:application_name] || "govuk_publishing_components"
+      @application_dir = options[:application_dir] || "govuk_publishing_components"
       @all_templates = Dir["#{path}/#{@templates_path}/*.erb"].sort
       @templates_full_path = "#{path}/#{@templates_path}/"
 
@@ -57,7 +58,7 @@ module GovukPublishingComponents
       component_templates.each do |component|
         component_detail = {}
         component_detail[:name] = component
-        component_detail[:application] = @application_name
+        component_detail[:application] = @application_dir
         component_detail[:link] = get_component_link(component) unless @auditing_an_application
         file_details = [
           {
@@ -214,7 +215,7 @@ module GovukPublishingComponents
 
     def get_asset_link(a_thing, component)
       url = "https://github.com/alphagov"
-      repo = @application_name
+      repo = @application_dir
       blob = "blob/main"
       link = nil
       link = "#{url}/#{repo}/#{blob}/#{@templates_path}/_#{component.gsub(' ', '_')}.html.erb" if a_thing == "template"

data/app/models/govuk_publishing_components/component_wrapper_helper_options.rb

@@ -9,6 +9,7 @@ This component uses the component wrapper helper. It accepts the following optio
 - `aria` - accepts a hash of aria attributes
 - `classes` - accepts a space separated string of classes, these should not be used for styling and must be prefixed with `js-`
 - `role` - accepts a space separated string of roles
+- `lang` - accepts a language attribute value
       "
     end
   end

data/app/views/govuk_publishing_components/audit/_applications.html.erb

@@ -34,7 +34,7 @@
 
     <% accordion_content = capture do %>
       <% if application[:application_found] %>
-        <% github_link = 'https://github.com/alphagov/' + application[:name] + '/blob/main/' %>
+        <% github_link = 'https://github.com/alphagov/' + application[:dir] + '/blob/main/' %>
 
         <% if @other_applications %>
           <% if application[:uses_individual_asset_model] %>

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

@@ -8,7 +8,9 @@
 %>
 
 <% start_button_text = capture do %>
-  <%= button.text %>
+  <span>
+    <%= button.text %>
+  </span>
   <svg class="govuk-button__start-icon govuk-!-display-none-print" xmlns="http://www.w3.org/2000/svg" width="17.5" height="19" viewBox="0 0 33 40" focusable="false" aria-hidden="true">
     <path fill="currentColor" d="M0 0h13l20 20-20 20H0l20-20z" />
   </svg>

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

@@ -29,35 +29,37 @@
           <p class='gem-c-document-list__highlight-text'><%= item[:highlight_text] %></p>
         <% end %>
 
-        <%=
-          item_classes = "gem-c-document-list__item-title #{brand_helper.color_class} #{title_with_context_class if item[:link][:context]}"
+        <%= content_tag :div, class: "gem-c-document-list__item-title" do -%>
+          <%=
+            item_classes = "#{brand_helper.color_class} #{title_with_context_class if item[:link][:context]}"
 
-          if item[:link][:path]
-            rel = [
-              "external",
-              "nofollow",
-              "noopener",
-              "noreferrer",
-              "opener",
-            ].include?(item[:link][:rel]) ? item[:link][:rel] : nil
+            if item[:link][:path]
+              rel = [
+                "external",
+                "nofollow",
+                "noopener",
+                "noreferrer",
+                "opener",
+              ].include?(item[:link][:rel]) ? item[:link][:rel] : nil
 
-            link_to(
-              item[:link][:text],
-              item[:link][:path],
-              data: item[:link][:data_attributes],
-              class: "#{item_classes} govuk-link",
-              lang: item[:link][:locale].presence,
-              rel: rel,
-            )
-          else
-            content_tag(
-              "span",
-              item[:link][:text],
-              data: item[:link][:data_attributes],
-              class: item_classes,
-            )
-          end
-        %>
+              link_to(
+                item[:link][:text],
+                item[:link][:path],
+                data: item[:link][:data_attributes],
+                class: "#{item_classes} govuk-link",
+                lang: item[:link][:locale].presence,
+                rel: rel,
+              )
+            else
+              content_tag(
+                "span",
+                item[:link][:text],
+                data: item[:link][:data_attributes],
+                class: item_classes,
+              )
+            end
+          %>
+        <% end %>
 
         <% if item[:link][:context] %>
           <span class="gem-c-document-list__item-context"><%= item[:link][:context] %></span>

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

@@ -7,15 +7,18 @@
   brand_helper = GovukPublishingComponents::AppHelpers::BrandHelper.new(brand)
   heading_helper = GovukPublishingComponents::Presenters::HeadingHelper.new(local_assigns)
   shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
+  component_helper = GovukPublishingComponents::Presenters::ComponentWrapperHelper.new(local_assigns)
 
   classes = %w(gem-c-heading)
   classes << heading_helper.classes
   classes << brand_helper.brand_class
   classes << brand_helper.border_color_class
   classes << shared_helper.get_margin_bottom if [*0..9].include?(local_assigns[:margin_bottom])
+
+  component_helper.add_class(classes.join(" "))
+  component_helper.set_id(heading_helper.id)
+  element = shared_helper.get_heading_level
 %>
-<%= content_tag(shared_helper.get_heading_level, text,
-  class: classes,
-  id: heading_helper.id,
-  lang: lang
-) %>
+<%= content_tag(element, component_helper.all_attributes) do %>
+  <%= text %>
+<% end %>

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

@@ -15,6 +15,7 @@ accessibility_criteria: |
   - be part of a correct heading structure for a page
   - be semantically represented as a heading
   - convey the heading level
+uses_component_wrapper_helper: true  
 examples:
   default:
     data:
@@ -31,10 +32,6 @@ examples:
     data:
       text: 'One big heading'
       font_size: "xl"
-  with_id_attribute:
-    data:
-      text: 'Detail of outcome'
-      id: 'detail_of_outcome'
   right_to_left:
     data:
       text: 'مستندات'

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

@@ -9,6 +9,7 @@ body: |
   When the button is clicked, the `base_path` is submitted to an endpoint which proceeds to check the user's authentication status and whether they are already subscribed to the page or not. Depending on these factors, they will be routed accordingly.
 accessibility_criteria: |
   - The bell icon must be presentational and ignored by screen readers.
+uses_component_wrapper_helper: true  
 examples:
   default:
     description: By default this component prompts the user to subscribe to email notifications to this page.
@@ -19,12 +20,6 @@ examples:
     data:
       base_path: '/current-page-path'
       already_subscribed: true
-  with_data_attributes:
-    description: The component accepts data attributes (for example, for analytics)
-    data:
-      base_path: '/current-page-path'
-      data_attributes:
-        test_attribute: "testing"
   with_ga4_tracking:
     description: To add GA4 tracking, pass a `ga4_data_attributes` object with the necessary properties to the component. For example:-
     data:

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

@@ -17,7 +17,7 @@ accessibility_criteria: |
     * be usable with touch
     * be usable with voice commands
     * have visible text
-
+uses_component_wrapper_helper: true
 examples:
   default:
     data:

data/lib/govuk_publishing_components/config.rb

@@ -9,6 +9,9 @@ module GovukPublishingComponents
     mattr_accessor :component_guide_title
     self.component_guide_title = "Component Guide"
 
+    mattr_accessor :application_dir
+    self.application_dir = ""
+
     mattr_accessor :application_stylesheet
     self.application_stylesheet = "application"
 

data/lib/govuk_publishing_components/presenters/component_wrapper_helper.rb

@@ -9,6 +9,7 @@ module GovukPublishingComponents
         check_classes_are_valid(@options[:classes]) if @options.include?(:classes)
         check_aria_is_valid(@options[:aria]) if @options.include?(:aria)
         check_role_is_valid(@options[:role]) if @options.include?(:role)
+        check_lang_is_valid(@options[:lang]) if @options.include?(:lang)
       end
 
       def all_attributes
@@ -19,6 +20,7 @@ module GovukPublishingComponents
         attributes[:aria] = @options[:aria] unless @options[:aria].blank?
         attributes[:class] = @options[:classes] unless @options[:classes].blank?
         attributes[:role] = @options[:role] unless @options[:role].blank?
+        attributes[:lang] = @options[:lang] unless @options[:lang].blank?
 
         attributes
       end
@@ -48,6 +50,11 @@ module GovukPublishingComponents
         extend_string(:role, role)
       end
 
+      def set_lang(lang)
+        check_lang_is_valid(lang)
+        @options[:lang] = lang
+      end
+
     private
 
       def check_id_is_valid(id)
@@ -69,7 +76,7 @@ module GovukPublishingComponents
         return if classes.blank?
 
         class_array = classes.split(" ")
-        unless class_array.all? { |c| c.start_with?("js-", "gem-c-", "govuk-", "brand--") }
+        unless class_array.all? { |c| c.start_with?("js-", "gem-c-", "govuk-", "brand--", "brand__") }
           raise(ArgumentError, "Classes (#{classes}) must be prefixed with `js-`")
         end
       end
@@ -98,6 +105,15 @@ module GovukPublishingComponents
         end
       end
 
+      def check_lang_is_valid(lang)
+        return if lang.blank?
+
+        langs = %w[ab aa af ak sq am ar an hy as av ae ay az bm ba eu be bn bh bi bs br bg my ca ch ce ny zh zh-Hans zh-Hant cv kw co cr hr cs da dv nl dz en eo et ee fo fj fi fr ff gl gd gv ka de el kl gn gu ht ha he hz hi ho hu is io ig id in ia ie iu ik ga it ja jv kl kn kr ks kk km ki rw rn ky kv kg ko ku kj lo la lv li ln lt lu lg lb gv mk mg ms ml mt mi mr mh mo mn na nv ng nd ne no nb nn ii oc oj cu or om os pi ps fa pl pt pa qu rm ro ru se sm sg sa sr sh st tn sn ii sd si ss sk sl so nr es su sw ss sv tl ty tg ta tt te th bo ti to ts tr tk tw ug uk ur uz ve vi vo wa cy wo fy xh yi ji yo za zu]
+        unless langs.include? lang
+          raise(ArgumentError, "lang attribute (#{lang}) is not recognised")
+        end
+      end
+
       def extend_string(option, string)
         ((@options[option] ||= "") << " #{string}").strip!
       end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "35.12.0".freeze
+  VERSION = "35.13.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 35.12.0
+  version: 35.13.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2023-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config