govuk_publishing_components 45.1.0 → 45.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bff6c1c6b02b27106e803cfae58feb291444e1157e05259f5a7e3b07e0082ae4
-  data.tar.gz: 80fe842fe3616350503e8f3e7942269c372ba16e61e0c8909d209efd2c7c23ec
+  metadata.gz: f938838d6305407995b5a36bad862a8fe5d802bbbef0ac614a79d85c9588b48e
+  data.tar.gz: 3e1b2395dade924fd5a57441818beeb2b809bfa6c260c694c1e5611c5c0eaaf1
 SHA512:
-  metadata.gz: be3440ce93b1a0dbe5a8ea7ceae09424b4ce044ba06ed07399a0c9a52d22f175a9a3c6d11a7a3bdd99cff0a0e7248abd4a9f0ec35f540b00104d57e86785b6d4
-  data.tar.gz: 1476b5c3312c889880cf1fe1197ce0fc728ebb508367abfaea29eba841b3a5b8a00734efb7654f0cfc4027a1afa7425fc483c62e40ba6c2fbc77a6ca2b9804be
+  metadata.gz: 8dd6560730fd2aaf23ad8bad8d2fa6b16576a9d1f2d4cfaf2182cee0b53531171796d494e25b1f7c614558ffc003bbd4c1de5882203ebda1526c5d763c2e1cb0
+  data.tar.gz: b0d5aab888e3ac4e3de918e3685fbe092e7adb5c77e7f220b8457e9f289109fdbee67bce72502d3411b2fe00b588f4b4972ac2ff63a29bb6d3d9f759f4ade86c

data/app/models/govuk_publishing_components/component_wrapper_helper_options.rb

@@ -13,6 +13,7 @@ This component uses the component wrapper helper. It accepts the following optio
 - `open` - accepts an open attribute value (true or false)
 - `hidden` - accepts an empty string, 'hidden', or 'until-found'
 - `tabindex` - accepts an integer. The integer can also be passed as a string.
+- `dir` - accepts 'rtl', 'ltr', or 'auto'.
       "
     end
   end

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

@@ -2,9 +2,6 @@
   add_gem_component_stylesheet("error-message")
 
   id ||= "error-message-#{SecureRandom.hex(4)}"
-  classes ||= ''
-  css_classes = %w( gem-c-error-message govuk-error-message )
-  css_classes << classes if classes
   items ||= []
   right_to_left ||= false
 
@@ -12,7 +9,12 @@
     errors = items.map { |item| capture { item[:text] } }
     text = raw(errors.join("<br />"))
   end
+
+  component_helper = GovukPublishingComponents::Presenters::ComponentWrapperHelper.new(local_assigns)
+  component_helper.set_id(id)
+  component_helper.add_class("gem-c-error-message govuk-error-message")
+  component_helper.set_dir("rtl") if right_to_left
 %>
-<%= tag.p id: id, class: css_classes, dir: right_to_left ? "rtl" : nil do %>
+<%= tag.p(**component_helper.all_attributes) do %>
   <span class="govuk-visually-hidden">Error:</span> <%= text %>
 <% end %>

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

@@ -11,12 +11,15 @@
   path_without_pii = utf_encode(request.fullpath.gsub(email_regex, '[email]'))
 
   disable_ga4 ||= false
-  data_module = "feedback"
-  data_module << " ga4-event-tracker" unless disable_ga4
+
+  component_helper = GovukPublishingComponents::Presenters::ComponentWrapperHelper.new(local_assigns)
+  component_helper.add_class("gem-c-feedback govuk-!-display-none-print")
+  component_helper.add_data_attribute({ module: "feedback" })
+  component_helper.add_data_attribute({ module: "ga4-event-tracker" }) unless disable_ga4
 %>
 
-<div class="gem-c-feedback govuk-!-display-none-print" data-module="<%= data_module %>">
+<%= tag.div(**component_helper.all_attributes) do %>
   <%= render "govuk_publishing_components/components/feedback/yes_no_banner", disable_ga4: %>
   <%= render "govuk_publishing_components/components/feedback/problem_form", url_without_pii: url_without_pii, disable_ga4: %>
   <%= render "govuk_publishing_components/components/feedback/survey_signup_form", path_without_pii: path_without_pii, disable_ga4: %>
-</div>
+<% end %>

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

@@ -1,6 +1,7 @@
 <%
   add_gem_component_stylesheet("layout-for-public")
 
+  for_static ||= false
   emergency_banner ||= nil
   full_width ||= false
   blue_bar ||= local_assigns.include?(:blue_bar) ? local_assigns[:blue_bar] : !full_width
@@ -160,13 +161,15 @@
       <% end %>
     <% elsif custom_layout %>
       <%= yield %>
-    <% else %>
+    <% elsif for_static %>
       <div id="wrapper" class="<%= "govuk-width-container" unless full_width %>">
         <%= yield :before_content %>
         <main class="govuk-main-wrapper" id="content">
           <%= yield %>
         </main>
       </div>
+    <% else %>
+      <%= yield %>
     <% end %>
 
     <% unless omit_feedback_form %>

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

@@ -37,9 +37,11 @@
   hint_id = "hint-#{SecureRandom.hex(4)}" if hint
   error_id = "error-#{SecureRandom.hex(4)}"
 
-  form_group_css_classes = %w(govuk-form-group)
-  form_group_css_classes << "govuk-form-group--error" if has_error
-  form_group_css_classes << shared_helper.get_margin_bottom
+  component_helper = GovukPublishingComponents::Presenters::ComponentWrapperHelper.new(local_assigns)
+  component_helper.add_class("govuk-form-group")
+  component_helper.add_class("govuk-form-group--error") if has_error
+  component_helper.add_class(shared_helper.get_margin_bottom)
+  component_helper.set_id(id)
 
   radio_classes = %w(govuk-radios)
   radio_classes << "govuk-radios--small" if small
@@ -54,7 +56,7 @@
   # check if any item is set as being conditional
   has_conditional = items.any? { |item| item.is_a?(Hash) && item[:conditional] }
 %>
-<%= tag.div id: id, class: form_group_css_classes do %>
+<%= tag.div(**component_helper.all_attributes) do %>
   <%= tag.fieldset class: "govuk-fieldset", "aria-describedby": aria do %>
     <% if heading.present? %>
       <%= tag.legend class: legend_classes do %>

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

@@ -10,6 +10,7 @@ accessibility_criteria: |
   - be associated with an input. The `error_message_id` must match the `aria-describedby` property on the input your label is associated with. Note that if `id` is not passed to the component an id will be generated automatically.
 
   If error message is within a label it will be announced in its entirety by screen readers. By associating error messages with inputs using `aria-describedby`, then screen readers will read the label, describe the type of input (eg radio) and then read additional text. It means users of screen readers can scan and skip options as easy as people making choices with sight.
+uses_component_wrapper_helper: true
 examples:
   default:
     data:

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

@@ -4,6 +4,7 @@ body: |
   This component is designed to sit at the bottom of pages on GOV.UK to allow users to submit feedback on that page.
 
   This component uses JavaScript for expanding and collapsing and also for submitting form responses. This code is not compatible with Internet Explorer, so IE11 and down do not use JavaScript to submit the forms, instead falling back to a normal form submission.
+uses_component_wrapper_helper: true
 accessibility_criteria: |
   The form must:
 

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

@@ -17,9 +17,19 @@ examples:
       title: 'Example layout'
       block: |
         <h1>Page content goes here</h1>
+  with_static_wrapper:
+    description: |
+      By default, the layout does not include the `div#wrapper` element, nor the `main` element within that.
+      This behaviour is peculiar to the one app that currently uses this layout - static. Static now sets the `for_static: true` flag,
+      which causes the wrapper to be included. Other apps in the future will not set that flag, but provide their own wrapper and main elements.
+    data:
+      for_static: true
+      block: |
+        <h1>Page content goes here</h1>
   full_width:
-    description: By default, the layout applies the `govuk-width-container` class to the main element. We can remove this class by setting `full_width` to `true`
+    description: By default, the layout applies the `govuk-width-container` class to the main element. We can remove this class by setting `full_width` to `true`. Note this also requires the for_static flag, since that is needed for the main element.
     data:
+      for_static: true
       full_width: true
       block: |
         <h1>Page content goes here</h1>
@@ -30,6 +40,7 @@ examples:
   blue_bar_background:
     description: For use when a page has a heading component with a background colour.
     data:
+      for_static: true
       full_width: true
       blue_bar: true
       blue_bar_background_colour: "no"

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

@@ -4,6 +4,7 @@ body: |
   You can also use 'or' as an item to break up radios.
 
   If JavaScript is disabled a conditionally revealed content expands fully. All of the functionality (including aria attributes) are added using JavaScript.
+uses_component_wrapper_helper: true
 accessibility_criteria: |
   Radio buttons should
 

data/lib/govuk_publishing_components/presenters/component_wrapper_helper.rb

@@ -13,6 +13,7 @@ module GovukPublishingComponents
         check_open_is_valid(@options[:open]) if @options.include?(:open)
         check_hidden_is_valid(@options[:hidden]) if @options.include?(:hidden)
         check_tabindex_is_valid(@options[:tabindex]) if @options.include?(:tabindex)
+        check_dir_is_valid(@options[:dir]) if @options.include?(:dir)
       end
 
       def all_attributes
@@ -27,6 +28,7 @@ module GovukPublishingComponents
         attributes[:open] = @options[:open] unless @options[:open].blank?
         attributes[:hidden] = @options[:hidden] unless @options[:hidden].nil?
         attributes[:tabindex] = @options[:tabindex] unless @options[:tabindex].blank?
+        attributes[:dir] = @options[:dir] unless @options[:dir].blank?
 
         attributes
       end
@@ -76,6 +78,11 @@ module GovukPublishingComponents
         @options[:tabindex] = tabindex_attribute
       end
 
+      def set_dir(dir_attribute)
+        check_dir_is_valid(dir_attribute)
+        @options[:dir] = dir_attribute
+      end
+
     private
 
       def check_id_is_valid(id)
@@ -163,6 +170,15 @@ module GovukPublishingComponents
         end
       end
 
+      def check_dir_is_valid(dir_attribute)
+        return if dir_attribute.nil?
+
+        options = %w[ltr rtl auto]
+        unless options.include? dir_attribute
+          raise(ArgumentError, "dir attribute (#{dir_attribute}) 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 = "45.1.0".freeze
+  VERSION = "45.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 45.1.0
+  version: 45.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-07 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chartkick