govuk_publishing_components 21.55.1 → 21.56.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34577f5058eb49bcbf88cbbdc4a50dc11ad7f87ee10706f1cb15bbcd7a08988e
-  data.tar.gz: 97ae0ad84975a91c8b2f560b4b80a095fbc75b7f6fd552bb6fcb92d9d8bbd9dc
+  metadata.gz: 3ae35a18ee87f9f8bdbc0b7f05b1874d04f3bcfbebed8eb0fd21dfb178bf1118
+  data.tar.gz: e83b74f0187e3db2687dea59f3dc1f482b3400a7fe24f95d1ba5cb9b1377a94e
 SHA512:
-  metadata.gz: 39186c5eb0a7a811aade0cfb0be8b483102473b19ac4f85035d384b01812909a54fda71dade7d9491d6c92968d118594b455682b49d5e3a894ebc6b835579120
-  data.tar.gz: 74b21c40ad38212747054d025dfcbca802a44465f9e833606c79e31a1c1fcbbdea880237eb9405361664129b8953ac6abc85498e66a72066cce6ade2f7ed005b
+  metadata.gz: 485ae5bca952be5d4bd237148436f7c165cf91aadafdc433cf1dec9a899cbcff4f78c9e9ede0509ffc79511902fcdeeff699ed73e918f2cbcbf08182e8d8da42
+  data.tar.gz: fde1485cf2b9b1849993aa71fee949f39c3f4d08c996c1d9a61de520f3c44d0c25d3fd047d176032fd0c4e7c4862a0b4fe00b926b43e5898424c3e459355ada3

data/app/assets/javascripts/govuk_publishing_components/lib/govspeak/youtube-link-enhancement.js

@@ -109,6 +109,8 @@
             event.target.f.title = videoTitle + ' (video)'
           },
           onStateChange: function (event) {
+            var eventData = event.data
+            var eventTarget = event.target
             var states = {
               "-1": "VideoUnstarted",
               "0": "VideoEnded",
@@ -117,14 +119,13 @@
               "3": "VideoBuffering",
               "5": "VideoCued"
             }
-
-            if (states[event.data] && options.tracking && options.tracking.hasTracking
+            if (states[eventData] && options.tracking && options.tracking.hasTracking
                 && window.GOVUK.analytics && window.GOVUK.analytics.trackEvent)
             {
               var tracking = {
                 category: options.tracking.category,
-                action: states[event.data],
-                label: { transport: 'beacon', label: event.target.getVideoUrl() }
+                action: states[eventData],
+                label: { transport: 'beacon', label: eventTarget.getVideoData && eventTarget.getVideoData().title }
               }
 
               window.GOVUK.analytics.trackEvent(tracking.category, tracking.action, tracking.label)

data/app/assets/stylesheets/govuk_publishing_components/component_support.scss

@@ -8,6 +8,7 @@
 
 @import "govuk_publishing_components/components/helpers/variables";
 @import "govuk_publishing_components/components/helpers/brand-colours";
+@import "govuk_publishing_components/components/helpers/link";
 @import "govuk_publishing_components/components/mixins/govuk-template-link-focus-override";
 @import "govuk_publishing_components/components/mixins/media-down";
 @import "govuk_publishing_components/components/mixins/margins";

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

@@ -1,8 +1,6 @@
 .gem-c-feedback {
   background: govuk-colour("white");
-  margin: govuk-spacing(6) auto 0 auto;
-  max-width: $govuk-page-width;
-  position: relative;
+  margin-top: govuk-spacing(6);
 
   @include govuk-media-query($from: tablet) {
     margin-top: govuk-spacing(9);
@@ -182,7 +180,6 @@
 }
 
 .gem-c-feedback__form {
-  margin: govuk-spacing(3) govuk-spacing(2) 0 govuk-spacing(2);
   padding: govuk-spacing(3) 0;
   border-top: govuk-spacing(2) solid govuk-colour("blue");
 

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

@@ -1,7 +1,6 @@
 @import "govuk/components/summary-list/summary-list";
 
 .gem-c-summary-list {
-  position: relative;
   border-bottom: 1px solid $govuk-border-colour;
 
   @include govuk-font(19);
@@ -14,12 +13,26 @@
   &:nth-last-of-type(1) {
     border-bottom: 0;
   }
+
+  .govuk-summary-list {
+    clear: both;
+  }
 }
 
-.gem-c-summary-list__edit-section-link {
-  position: absolute;
-  top: 0;
-  right: 0;
+.gem-c-summary-list__group-title {
+  @include govuk-media-query($from: tablet) {
+    display: inline-block;
+    margin-right: govuk-spacing(3);
+  }
+}
+
+.gem-c-summary-list__group-actions-list {
+  margin-bottom: govuk-spacing(3);
+
+  @include govuk-media-query($from: tablet) {
+    float: right;
+    width: auto;
+  }
 }
 
 .gem-c-summary__block {

data/app/assets/stylesheets/govuk_publishing_components/components/helpers/_link.scss

@@ -0,0 +1,17 @@
+.gem-link--destructive {
+  @include govuk-font(19);
+
+  &:link {
+    color: $govuk-error-colour;
+  }
+
+  &:visited,
+  &:hover,
+  &:active {
+    color: darken($govuk-error-colour, 5%);
+  }
+
+  &:focus {
+    color: $govuk-focus-text-colour;
+  }
+}

data/app/controllers/govuk_publishing_components/component_guide_controller.rb

@@ -2,6 +2,8 @@ module GovukPublishingComponents
   class ComponentGuideController < GovukPublishingComponents::ApplicationController
     append_view_path File.join(Rails.root, "app", "views", GovukPublishingComponents::Config.component_directory_name)
 
+    MATCH_COMPONENTS = /(?<=govuk_publishing_components\/components\/)[\/a-zA-Z_-]+(?=['"])/.freeze
+
     def index
       @application_path = Rails.root
       @component_gem_path = Gem.loaded_specs["govuk_publishing_components"].full_gem_path
@@ -86,24 +88,30 @@ module GovukPublishingComponents
 
       files.each do |file|
         data = File.read(file)
-        matches << data.scan(/(govuk_publishing_components\/components\/[a-z_-]+)/)
+        matches << data.scan(MATCH_COMPONENTS)
       end
 
-      matches.flatten.uniq.map(&:to_s).sort.map { |m| m.gsub("govuk_publishing_components/components/", "") }
+      matches.flatten.uniq.map(&:to_s).sort
     end
 
-    def find_all_partials_in(components)
-      components_to_search = components
-      partials_found = true
+    def find_all_partials_in(templates)
+      components = [templates]
+
+      templates.each do |template|
+        partials_found = true
+        components_to_search = [template]
+        components_found = []
 
-      while partials_found
-        extra_components = find_partials_in(components_to_search)
+        while partials_found
+          extra_components = find_partials_in(components_to_search)
 
-        if extra_components.any?
-          components << extra_components
-          components_to_search = extra_components
-        else
-          partials_found = false
+          if extra_components.any?
+            components_found << extra_components
+            components_to_search = extra_components
+          else
+            partials_found = false
+            components << components_found.uniq.sort if components_found.any?
+          end
         end
       end
 
@@ -113,8 +121,7 @@ module GovukPublishingComponents
     def find_partials_in(components)
       extra_components = []
       components.each do |component|
-        components_in_component = components_within_component(component)
-        extra_components << components_in_component
+        extra_components << components_within_component(component)
       end
 
       extra_components.flatten.uniq.sort
@@ -132,9 +139,12 @@ module GovukPublishingComponents
     def components_within_component(component)
       filename = @component_gem_path + "/app/views/govuk_publishing_components/components/#{component}.html.erb"
       filename = filename.sub(/.*\K\//, "/_") # files begin with _ but the method may have been passed 'filename' or 'dir/partial'
+
+      return [] unless File.file?(filename)
+
       data = File.read(filename)
-      match = data.scan(/(govuk_publishing_components\/components\/[\/a-z_-]+)/)
-      match.flatten.uniq.map(&:to_s).sort.map { |m| m.gsub("govuk_publishing_components/components/", "") }
+      match = data.scan(MATCH_COMPONENTS)
+      match.flatten.uniq.map(&:to_s).sort
     end
 
     def index_breadcrumb

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

@@ -1,16 +1,20 @@
 <% prioritise_taxon_breadcrumbs ||= false %>
-<% breadcrumb_selector = GovukPublishingComponents::Presenters::BreadcrumbSelector.call(content_item, request, prioritise_taxon_breadcrumbs) %>
+<% breadcrumb_selector = GovukPublishingComponents::Presenters::BreadcrumbSelector.new(content_item, request, prioritise_taxon_breadcrumbs) %>
 <% inverse ||= false %>
 <% collapse_on_mobile ||= true unless local_assigns[:collapse_on_mobile].eql?(false) %>
 
-<div class='gem-c-contextual-breadcrumbs'>
-  <% if breadcrumb_selector[:step_by_step] %>
-    <%= render 'govuk_publishing_components/components/step_by_step_nav_header',
-               breadcrumb_selector[:breadcrumbs] %>
-  <% elsif breadcrumb_selector[:breadcrumbs] %>
+<div class="gem-c-contextual-breadcrumbs">
+  <% if breadcrumb_selector.step_by_step %>
+    <%= render 'govuk_publishing_components/components/step_by_step_nav_header', breadcrumb_selector.breadcrumbs %>
+  <% elsif breadcrumb_selector.breadcrumbs %>
     <%= render 'govuk_publishing_components/components/breadcrumbs',
-               breadcrumbs: breadcrumb_selector[:breadcrumbs],
+               breadcrumbs: breadcrumb_selector.breadcrumbs,
                inverse: inverse,
                collapse_on_mobile: collapse_on_mobile %>
   <% end %>
+
+  <%= render(
+        'govuk_publishing_components/components/step_by_step_nav_header', breadcrumb_selector.priority_breadcrumbs
+      ) if breadcrumb_selector.priority_breadcrumbs
+  %>
 </div>

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

@@ -1,23 +1,42 @@
 <%
+  local_assigns[:heading_level] ||= 3
+  heading_size = 'm' unless ['s', 'm', 'l', 'xl'].include?(heading_size)
+  shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
+
   id ||= nil
   title ||= nil
   borderless ||= false
   edit ||= {}
+  delete ||= {}
   items ||= []
   block ||= yield
 %>
 <% if title || items.any? %>
   <%= tag.div class: "gem-c-summary-list #{"govuk-summary-list--no-border" if borderless}", id: id do %>
     <% if title %>
-      <%= tag.h3 title, class: "govuk-heading-m" %>
-      <% if edit.any? %>
-        <%= tag.ul class: "govuk-summary-list__actions-list" do %>
-          <%= tag.li class: "govuk-summary-list__actions-list-item" do %>
-            <%= link_to edit.fetch(:href),
-                      class: "govuk-link gem-c-summary-list__edit-section-link",
-                      title: "#{edit.fetch(:link_text, "Change")} #{title}",
-                      data: edit.fetch(:data_attributes, {}) do %>
-               <%= edit.fetch(:link_text, "Change") %> <%= tag.span title, class: "govuk-visually-hidden" %>
+      <%= content_tag(shared_helper.get_heading_level, title, class: "govuk-heading-#{heading_size} gem-c-summary-list__group-title") %>
+      <% if edit.any? || delete.any? %>
+        <%= tag.ul class: "govuk-summary-list__actions-list gem-c-summary-list__group-actions-list" do %>
+          <%- if edit.any? %>
+            <% edit_section_link_text = edit[:link_text] || t("components.summary_list.edit") %>
+            <%= tag.li class: "govuk-summary-list__actions-list-item" do -%>
+              <%= link_to edit.fetch(:href),
+                        class: "govuk-link",
+                        title: "#{edit_section_link_text} #{title}",
+                        data: edit.fetch(:data_attributes, {}) do %>
+                <%= edit_section_link_text %><%= tag.span " #{title}", class: "govuk-visually-hidden" -%>
+              <% end %>
+            <% end %>
+          <% end %>
+          <% if delete.any? %>
+            <% delete_section_link_text = delete[:link_text] || t("components.summary_list.delete") %>
+            <%= tag.li class: "govuk-summary-list__actions-list-item" do -%>
+              <%= link_to delete.fetch(:href),
+                        class: "govuk-link gem-link--destructive",
+                        title: "#{delete_section_link_text} #{title}",
+                        data: delete.fetch(:data_attributes, {}) do %>
+                <%= delete_section_link_text %><%= tag.span " #{title}", class: "govuk-visually-hidden" -%>
+              <% end %>
             <% end %>
           <% end %>
         <% end %>
@@ -37,22 +56,23 @@
                 <%= tag.ul class: "govuk-summary-list__actions-list" do %>
                   <% if item.fetch(:edit, {}).any? %>
                     <%= tag.li class: "govuk-summary-list__actions-list-item" do %>
-                      <% edit_link_text = item[:edit][:link_text] || "Change" %>
+                      <% edit_link_text = item[:edit][:link_text] || t("components.summary_list.edit") %>
                       <%= link_to item[:edit].fetch(:href),
                                   class: "govuk-link",
                                   title: "#{edit_link_text} #{item[:field]}",
                                   data: item[:edit].fetch(:data_attributes, {}) do %>
-                        <%= edit_link_text %><%= tag.span " #{item[:field]}", class: "govuk-visually-hidden" %><% end %>
+                        <%= edit_link_text %><%= tag.span " #{item[:field]}", class: "govuk-visually-hidden" -%>
+                      <% end %>
                     <% end %>
                   <% end %>
                   <% if item.fetch(:delete, {}).any? %>
                     <%= tag.li class: "govuk-summary-list__actions-list-item" do %>
-                      <% delete_link_text = item[:delete][:link_text] || "Delete" %>
+                      <% delete_link_text = item[:delete][:link_text] || t("components.summary_list.delete") %>
                       <%= link_to item[:delete].fetch(:href),
-                                  class: "govuk-link",
+                                  class: "govuk-link gem-link--destructive",
                                   title: "#{delete_link_text} #{item[:field]}",
                                   data: item[:delete].fetch(:data_attributes, {}) do %>
-                        <%= delete_link_text %><%= tag.span " #{item[:field]}", class: "govuk-visually-hidden" %>
+                        <%= delete_link_text %><%= tag.span " #{item[:field]}", class: "govuk-visually-hidden" -%>
                       <% end %>
                     <% end %>
                   <% end %>

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

@@ -1,5 +1,6 @@
 name: Summary list
 description: Use the summary list to summarise information, for example, a user’s responses at the end of a form.
+body:  This component extends the [Summary list component in the Design System](https://design-system.service.gov.uk/components/summary-list/) allowing the rendering of multiple groups of lists, and actions at the group level.
 accessibility_criteria: |
   Action links in the component must:
 
@@ -41,6 +42,32 @@ examples:
         data_attributes:
           gtm: "edit-title-summary-body"
 
+  with_delete_on_section:
+    data:
+      <<: *default-example-data
+      delete:
+        href: "delete-title-summary-body"
+        data_attributes:
+          gtm: "delete-title-summary-body"
+
+  with_edit_and_delete_on_section:
+    data:
+      <<: *default-example-data
+      edit:
+        href: "edit-title-summary-body"
+        data_attributes:
+          gtm: "edit-title-summary-body"
+      delete:
+        href: "delete-title-summary-body"
+        data_attributes:
+          gtm: "delete-title-summary-body"
+
+  with_custom_section_heading:
+    data:
+      <<: *default-example-data
+      heading_level: 2
+      heading_size: l
+
   with_custom_link_on_section:
     description: |
       Take care that the provided `link_text` still makes sense to screen readers when combined with the title.

data/config/locales/en.yml

@@ -71,3 +71,6 @@ en:
       email_signup_link_text: "Get email alerts"
       feed_link_text: "Subscribe to feed"
       subscriptions: "Subscriptions"
+    summary_list:
+      edit: "Change"
+      delete: "Delete"

data/lib/govuk_publishing_components.rb

@@ -12,9 +12,10 @@ require "govuk_publishing_components/presenters/contextual_navigation"
 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"
-require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_parent"
+require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_ancestors"
 require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_priority"
 require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_taxons"
+require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_topic"
 require "govuk_publishing_components/presenters/checkboxes_helper"
 require "govuk_publishing_components/presenters/select"
 require "govuk_publishing_components/presenters/meta_tags"

data/lib/govuk_publishing_components/presenters/breadcrumb_selector.rb

@@ -1,10 +1,6 @@
 module GovukPublishingComponents
   module Presenters
     class BreadcrumbSelector
-      def self.call(*args)
-        new(*args).output
-      end
-
       attr_reader :content_item, :request, :prioritise_taxon_breadcrumbs
 
       def initialize(content_item, request, prioritise_taxon_breadcrumbs)
@@ -13,66 +9,42 @@ module GovukPublishingComponents
         @prioritise_taxon_breadcrumbs = prioritise_taxon_breadcrumbs
       end
 
-      def content_item_navigation
-        @content_item_navigation ||= ContextualNavigation.new(content_item, request)
+      def breadcrumbs
+        best_match_option[:breadcrumbs]
       end
 
-      def parent_item_navigation
-        @parent_item_navigation ||= ContextualNavigation.new(parent_item, request)
+      def step_by_step
+        best_match_option[:step_by_step]
       end
 
-      def parent_item
-        @parent_item ||= Services.content_store.content_item(content_item_navigation.parent_api_path)
-      rescue GdsApi::ContentStore::ItemNotFound
-        # Do nothing
-      end
-
-      def parent_item_options
-        @parent_item_options ||= options(parent_item_navigation)
-      end
+      def priority_breadcrumbs
+        return parent_item_navigation.priority_breadcrumbs if content_item_navigation.html_publication_with_parent?
 
-      def content_item_options
-        @content_item_options ||= options(content_item_navigation)
+        content_item_navigation.priority_breadcrumbs
       end
 
-      def parent_breadcrumbs
-        breadcrumbs = [parent_item_options[:breadcrumbs]].flatten # to ensure breadcrumbs always an array
-        breadcrumbs.last[:is_page_parent] = false
-        breadcrumbs << {
-          title: parent_item["title"],
-          url: parent_item["base_path"],
-          is_page_parent: true,
-        }
-      end
+    private
 
-      def output
+      def best_match_option
         return content_item_options unless content_item_navigation.html_publication_with_parent?
-        return parent_item_options if parent_item_navigation.priority_breadcrumbs
-
-        step_by_step_header = parent_item_options[:step_by_step]
 
         {
-          step_by_step: step_by_step_header,
-          breadcrumbs: step_by_step_header ? parent_breadcrumbs.first : parent_breadcrumbs,
+          step_by_step: parent_is_step_by_step?,
+          breadcrumbs: parent_is_step_by_step? ? parent_breadcrumbs.first : parent_breadcrumbs,
         }
       end
 
       def options(navigation)
-        if navigation.priority_breadcrumbs
+        if navigation.content_tagged_to_a_finder?
           {
-            step_by_step: true,
-            breadcrumbs: navigation.priority_breadcrumbs,
+            step_by_step: false,
+            breadcrumbs: navigation.finder_breadcrumbs,
           }
         elsif navigation.content_tagged_to_current_step_by_step?
           {
             step_by_step: true,
             breadcrumbs: navigation.step_nav_helper.header,
           }
-        elsif navigation.content_tagged_to_a_finder?
-          {
-            step_by_step: false,
-            breadcrumbs: navigation.breadcrumbs,
-          }
         elsif navigation.content_is_tagged_to_a_live_taxon? && prioritise_taxon_breadcrumbs
           {
             step_by_step: false,
@@ -83,10 +55,10 @@ module GovukPublishingComponents
             step_by_step: false,
             breadcrumbs: navigation.breadcrumbs,
           }
-        elsif navigation.content_has_curated_related_items?
+        elsif navigation.content_has_a_topic?
           {
             step_by_step: false,
-            breadcrumbs: navigation.breadcrumbs,
+            breadcrumbs: navigation.topic_breadcrumbs,
           }
         elsif navigation.use_taxon_breadcrumbs?
           {
@@ -102,6 +74,42 @@ module GovukPublishingComponents
           {}
         end
       end
+
+      def content_item_navigation
+        @content_item_navigation ||= ContextualNavigation.new(content_item, request)
+      end
+
+      def parent_item_navigation
+        @parent_item_navigation ||= ContextualNavigation.new(parent_item, request)
+      end
+
+      def parent_item
+        @parent_item ||= Services.content_store.content_item(content_item_navigation.parent_api_path)
+      rescue GdsApi::ContentStore::ItemNotFound
+        # Do nothing
+      end
+
+      def parent_item_options
+        @parent_item_options ||= options(parent_item_navigation)
+      end
+
+      def content_item_options
+        @content_item_options ||= options(content_item_navigation)
+      end
+
+      def parent_breadcrumbs
+        breadcrumbs = [parent_item_options[:breadcrumbs]].flatten # to ensure breadcrumbs always an array
+        breadcrumbs.last[:is_page_parent] = false
+        breadcrumbs << {
+          title: parent_item["title"],
+          url: parent_item["base_path"],
+          is_page_parent: true,
+        }
+      end
+
+      def parent_is_step_by_step?
+        parent_item_options[:step_by_step]
+      end
     end
   end
 end