govuk_publishing_components 12.20.0 → 12.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c05f837046ce0eb8bf88112196573cb3f6544730383a490092288461186e0234
-  data.tar.gz: 1d661175ec5a8b7a5767e469fdb0ed829fbb1221e5c81dd4b149185adf6ac2e9
+  metadata.gz: f322f0df4f65c7b30d2292ca9f0c4fa2fcc4804cb5a3235c7f493c583463c83b
+  data.tar.gz: 998e34fc7a7595e85538de162b9fc325a2ff5de05821706acf7ddff678ed2d95
 SHA512:
-  metadata.gz: '03228cae2a8df77b43367af87028b1997c02053dbe65fe8fe3db6756c9d55dfa9d239282d6ee73571722ccd487187f4db5b1535482d4663a76caf3689ad3a529'
-  data.tar.gz: 5c67eff894869af5ebade7dcd9cd0eb5403fd0e5a1c8e8f968f10748cf50102cee3093a467f67891d66561e0dac3a0a8694fc5aec0354169a8a24115d12c5833
+  metadata.gz: 499e15846e14aeb7cb49d37b8eec17b6d2890867ec9efa0dd5ea35fc653e52fdd511ec81d413f64af3426c91dc0e8697dd4ece833cd89b25ff74ea5e7d251802
+  data.tar.gz: ab21c7e408f906b84d8867714a912dac1457352ce9c4440093ef0cb5202cc97b4627bd97277003247fa4a71a2c5eeaf13e4a459f9166ca60236fcf98381962c4

data/app/assets/stylesheets/govuk_publishing_components/components/_image-card.scss

@@ -81,13 +81,13 @@
 }
 
 .gem-c-image-card__description {
-  @include govuk-font($size: 16, $line-height: 1.5);
+  @include govuk-font($size: 16);
   padding-top: $gutter-one-quarter;
   word-wrap: break-word;
 }
 
 .gem-c-image-card__list {
-  @include govuk-font($size: 16, $line-height: 1.5);
+  @include govuk-font($size: 16);
   position: relative;
   z-index: 2;
   padding: $gutter-one-quarter 0 0 0;

data/app/assets/stylesheets/govuk_publishing_components/components/_related-navigation.scss

@@ -16,6 +16,14 @@
   padding-top: $gutter-half;
 }
 
+.gem-c-related-navigation__sub-heading--footer {
+  @include bold-19;
+  border-top: none;
+  padding-top: 0;
+  margin-top: $gutter-half;
+  margin-bottom: $gutter-one-third;
+}
+
 .gem-c-related-navigation__main-heading  + .gem-c-related-navigation__sub-heading {
   border-top: none;
   padding-top: 0;

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

@@ -3,30 +3,30 @@
 
 <div class='gem-c-contextual-breadcrumbs'>
   <% if navigation.content_tagged_to_current_step_by_step? %>
-    <!-- Rendering step by step nav breadcrumbs because there's 1 step by step -->
+    <%# Rendering step by step nav breadcrumbs because there's 1 step by step %>
     <%= render 'govuk_publishing_components/components/step_by_step_nav_header',
       navigation.step_nav_helper.header %>
   <% elsif navigation.content_is_tagged_to_a_live_taxon? && prioritise_taxon_breadcrumbs %>
-    <!-- Rendering taxonomy breadcrumbs because the page is tagged to live taxons
-          and we want to prioritise them over all other breadcrumbs -->
+    <%# Rendering taxonomy breadcrumbs because the page is tagged to live taxons
+          and we want to prioritise them over all other breadcrumbs %>
     <%= render 'govuk_publishing_components/components/breadcrumbs',
                breadcrumbs: navigation.taxon_breadcrumbs[:breadcrumbs],
                collapse_on_mobile: true %>
   <% elsif navigation.content_tagged_to_mainstream_browse_pages? %>
-    <!-- Rendering parent-based breadcrumbs because the page is tagged to mainstream browse -->
+    <%# Rendering parent-based breadcrumbs because the page is tagged to mainstream browse %>
     <%= render 'govuk_publishing_components/components/breadcrumbs', breadcrumbs: navigation.breadcrumbs %>
   <% elsif navigation.content_has_curated_related_items? %>
-    <!-- Rendering parent-based breadcrumbs because the page has curated related links -->
+    <%# Rendering parent-based breadcrumbs because the page has curated related links %>
     <%= render 'govuk_publishing_components/components/breadcrumbs', breadcrumbs: navigation.breadcrumbs %>
   <% elsif navigation.content_is_tagged_to_a_live_taxon? %>
-    <!-- Rendering taxonomy breadcrumbs because the page is tagged to live taxons -->
+    <%# Rendering taxonomy breadcrumbs because the page is tagged to live taxons %>
     <%= render 'govuk_publishing_components/components/breadcrumbs',
       breadcrumbs: navigation.taxon_breadcrumbs[:breadcrumbs],
       collapse_on_mobile: true %>
   <% elsif navigation.breadcrumbs.any? %>
-    <!-- Rendering parent-based breadcrumbs because no browse, no related links, no live taxons -->
+    <%# Rendering parent-based breadcrumbs because no browse, no related links, no live taxons %>
     <%= render 'govuk_publishing_components/components/breadcrumbs', breadcrumbs: navigation.breadcrumbs %>
   <% else %>
-    <!-- Not rendering any breadcrumbs because there aren't any -->
+    <%# Not rendering any breadcrumbs because there aren't any %>
   <% end %>
 </div>

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

@@ -0,0 +1,10 @@
+<% navigation = GovukPublishingComponents::Presenters::ContextualNavigation.new(content_item, request) %>
+
+<% unless navigation.content_tagged_to_current_step_by_step? %>
+  <div class="gem-c-contextual-footer">
+    <%# Rendering related navigation because no step by step list %>
+    <%= render 'govuk_publishing_components/components/related_navigation',
+               content_item: content_item,
+               context: :footer %>
+  </div>
+<% end %>

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

@@ -2,29 +2,20 @@
 
 <div class="gem-c-contextual-sidebar">
   <% if navigation.content_tagged_to_a_reasonable_number_of_step_by_steps? %>
-    <!-- Rendering step by step related items because there are a few but not too many of them -->
+    <%# Rendering step by step related items because there are a few but not too many of them %>
     <%= render 'govuk_publishing_components/components/step_by_step_nav_related', links: navigation.step_nav_helper.related_links %>
   <% end %>
 
   <% if navigation.content_tagged_to_current_step_by_step? %>
-    <!-- Rendering step by step sidebar because there's 1 step by step list -->
+    <%# Rendering step by step sidebar because there's 1 step by step list %>
     <%= render 'govuk_publishing_components/components/step_by_step_nav', navigation.step_nav_helper.sidebar %>
-  <% elsif navigation.content_tagged_to_mainstream_browse_pages? %>
-    <!-- Rendering related navigation sidebar because the page is tagged to mainstream browse -->
-    <%= render 'govuk_publishing_components/components/related_navigation', content_item %>
-  <% elsif navigation.content_has_curated_related_items? %>
-    <!-- Rendering related navigation sidebar because the page has curated related links -->
-    <%= render 'govuk_publishing_components/components/related_navigation', content_item %>
-  <% elsif navigation.content_is_tagged_to_a_live_taxon? %>
-    <!-- Rendering taxonomy sidebar because the page is tagged to live taxons -->
-    <%= render 'govuk_publishing_components/components/taxonomy_navigation', navigation.taxonomy_sidebar %>
   <% else %>
-    <!-- Rendering related navigation sidebar because no browse, no related links, no live taxons -->
-    <%= render 'govuk_publishing_components/components/related_navigation', content_item %>
+    <%# Rendering related navigation sidebar because no step by step list %>
+    <%= render 'govuk_publishing_components/components/related_navigation', content_item: content_item, context: :sidebar %>
   <% end %>
 
   <% if navigation.content_tagged_to_other_step_by_steps? %>
-    <!-- Rendering step by step related items because there are a few but not too many of them -->
+    <%# Rendering step by step related items because there are a few but not too many of them %>
     <%= render 'govuk_publishing_components/components/step_by_step_nav_related', {
       pretitle: "Also part of", 
       links: navigation.step_nav_helper.also_part_of_step_nav,

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

@@ -18,9 +18,11 @@
                 <% item[:items].each do |item| %>
                   <% if item[:href] && item[:text] %>
                     <li class="govuk-footer__list-item">
-                      <a class="govuk-footer__link" href="<%= item[:href] %>">
-                        <%= item[:text] %>
-                      </a>
+                      <%
+                        attributes = { class: "govuk-footer__link" }.merge(item.fetch(:attributes, {}))
+                        attributes[:rel] = "noopener" if attributes[:target] == "_blank" && !attributes[:rel]
+                      %>
+                      <%= link_to item[:text], item[:href], attributes %>
                     </li>
                   <% end %>
                 <% end %>

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

@@ -1,13 +1,17 @@
 <% related_nav_helper = GovukPublishingComponents::Presenters::RelatedNavigationHelper.new(local_assigns) %>
 
-<% if related_nav_helper.anything_to_show? %>
+<% if related_nav_helper.related_navigation? %>
   <% random = SecureRandom.hex(4) %>
   <div class="gem-c-related-navigation">
-    <h2 id="related-nav-related_items-<%= random %>"
-        class="gem-c-related-navigation__main-heading"
-        data-track-count="sidebarRelatedItemSection" >
-      <%= t('components.related_navigation.related_content') %>
-    </h2>
+
+    <% if local_assigns[:context] != :footer %>
+      <h2 id="related-nav-related_items-<%= random %>"
+          class="gem-c-related-navigation__main-heading"
+          data-track-count="sidebarRelatedItemSection">
+        <%= t("components.related_#{local_assigns[:context]}_navigation.related_content",
+              default: t('components.related_navigation.related_content')) %>
+      </h2>
+    <% end %>
 
     <% section_index = 0 %>
 

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

@@ -10,10 +10,11 @@ body: |
   - Parent breadcrumb, which uses the `parent` link of the page with the [breadcrumbs component][breadcrumbs]
   - Taxon breadcrumb, which uses the `taxons` link of the page with the [breadcrumbs component][breadcrumbs]
 
-  It must always used [together with the contextual sidebar][sidebar].
+  It must always used [together with the contextual sidebar][sidebar] and [footer].
 
-  [preview]: https://govuk-publishing-components.herokuapp.com/contextual-navigation
+  [preview]: /contextual-navigation
   [header]: /component-guide/step_by_step_nav_header
+  [footer]: /component-guide/contextual_footer
   [sidebar]: /component-guide/contextual_sidebar
   [breadcrumbs]: https://govuk-publishing-components.herokuapp.com/component-guide/breadcrumbs
 accessibility_criteria: |

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

@@ -0,0 +1,71 @@
+name: Contextual footer
+description: Footer that shows different things depending on the page
+body: |
+  This is a component that calls other components. For more accurate
+  preview with real data, see the [contextual navigation preview][preview].
+
+  It will render the [related navigation component][related_navigation] in the context of a footer if the content item
+  is not part of a [step by step][step-by-step].
+
+  It must always be used [with the contextual breadcrumbs component][contextual_breadcrumbs].
+
+  [preview]: /contextual-navigation
+  [step-by-step]: /component-guide/step_by_step_nav
+  [related_navigation]: /component-guide/related_navigation
+  [contextual_breadcrumbs]: /component-guide/contextual_breadcrumbs
+accessibility_criteria: |
+  Components called by this component must be accessible
+examples:
+  default:
+    description: Displays contacts, external links, statistical datasets, topical events, topics and world locations.
+    data:
+      content_item:
+        title: "A content item"
+        links:
+          topics:
+          - title: Apprenticeships, 14 to 19 education and training for work
+            base_path: /browse/education/find-course
+            document_type: topic
+          - title: Finding a job
+            base_path: /browse/working/finding-job
+            document_type: topic
+          - title: Apprenticeships
+            base_path: /topic/further-education-skills/apprenticeships
+            document_type: topic
+          topical_events:
+          - title: UK-China High-Level People to People Dialogue 2017
+            base_path: /government/topical-events/uk-china-high-level-people-to-people-dialogue-2017
+            document_type: topical_event
+          related:
+          - title: Pest Control
+            base_path: /pest-control
+            document_type: contact
+          related_statistical_data_sets:
+          - title: International road fuel prices
+            base_path: /government/statistical-data-sets/comparisons-of-industrial-and-domestic-energy-prices-monthly-figures
+            document_type: statistical_data_set
+          - title: Weekly road fuel prices
+            base_path: /government/statistical-data-sets/oil-and-petroleum-products-weekly-statistics
+            document_type: statistical_data_set
+          world_locations:
+          - title: South Sudan
+            base_path: /world/south-sudan/news
+          - title: USA
+            base_path: /world/usa/news
+        details:
+          external_related_links:
+          - url: "http://media.slc.co.uk/sfe/1718/ft/sfe_terms_and_conditions_guide_1718_d.pdf"
+            title: "Student loans: terms and conditions 2017 to 2018 (PDF, 136KB)"
+          - title: The Student Room repaying your student loan
+            url: https://www.thestudentroom.co.uk/content.php?r=5967-Repaying-your-student-loan
+  with_step_by_step:
+    data:
+      content_item:
+        title: "A content item"
+        links:
+          part_of_step_navs:
+            - title: "Choosing a micropig or micropug: step by step"
+              base_path: "/micropigs-vs-micropugs"
+          ordered_related_items:
+            - title: "Find an apprenticeship"
+              base_path: "/apply-apprenticeship"

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

@@ -1,34 +1,43 @@
 name: Contextual sidebar
 description: Sidebar that shows different things depending on the page
 body: |
-  This is a complex component that calls other components. For more accurate
+  This is a component that calls other components. For more accurate
   preview with real data, see the [contextual navigation preview][preview].
 
-  There are 4 main variants of the component:
+  There are 2 variants of the component:
 
   - Step by step, which uses the [step by step nav][step-by-step]
-  - Taxonomy, which uses the new taxonomy in the [taxonomy-sidebar component][taxonomy-sidebar]
-  - Mainstream, which uses related links in the [related navigation component][related_navigation]
-  - Related navigation, which uses legacy taxonomies in the [related navigation component][related_navigation]
+  - Related navigation, which uses the [related navigation component][related_navigation] in the context of a sidebar
 
   It must always be used [with the contextual breadcrumbs component][contextual_breadcrumbs].
 
-  [preview]: https://govuk-publishing-components.herokuapp.com/contextual-navigation
+  [preview]: /contextual-navigation
   [step-by-step]: /component-guide/step_by_step_nav
   [related_navigation]: /component-guide/related_navigation
-  [taxonomy-sidebar]: https://govuk-publishing-components.herokuapp.com/component-guide/taxonomy_navigation
   [contextual_breadcrumbs]: /component-guide/contextual_breadcrumbs
 accessibility_criteria: |
   Components called by this component must be accessible
 examples:
   default:
+    description: Display collections, guides, quick links, ordered related items and related mainstream content.
     data:
       content_item:
         title: "A content item"
         links:
           ordered_related_items:
-            - title: "Find an apprenticeship"
-              base_path: "/apply-apprenticeship"
+          - title: Find an apprenticeship
+            base_path: /apply-apprenticeship
+          - title: Training and study at work
+            base_path: /training-study-work-your-rights
+          - title: Careers helpline for teenagers
+            base_path: /careers-helpline-for-teenagers
+          document_collections:
+          - title: Recruit an apprentice (formerly apprenticeship vacancies)
+            base_path: /government/collections/apprenticeship-vacancies
+            document_type: document_collection
+          - title: The future of jobs and skills
+            base_path: /government/collections/the-future-of-jobs-and-skills
+            document_type: document_collection
   with_step_by_step:
     data:
       content_item:

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

@@ -123,3 +123,20 @@ examples:
             text: Rhestr o Wasanaethau Cymraeg
           - href: '/government/organisations/government-digital-service'
             text: Government Digital Service
+
+  with_attributes_links:
+    data:
+      navigation:
+        - title: Test Links
+          columns: 1
+          items:
+            - href: 'https://www.gov.uk/government/collections/organisation'
+              text: Shows a page in a new window
+              attributes:
+                target: _blank
+                rel: noopener
+            - href: 'https://www.gov.uk/corporation-tax'
+              text: Shows page in the same window
+              attributes:
+                data:
+                  tracking: GTM-123AB

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

@@ -31,6 +31,59 @@ examples:
           - title: Apprenticeships
             base_path: /topic/further-education-skills/apprenticeships
             document_type: topic
+  with_mainstream_browse_pages:
+    data:
+      links:
+        mainstream_browse_pages:
+        - title: Driving licences
+          base_path: /browse/driving/driving-licences
+          document_type: mainstream_browse_page
+        - title: Driving tests and learning to drive or ride
+          base_path: /browse/driving/learning-to-drive
+          document_type: mainstream_browse_page
+  with_taxons:
+    data:
+      links:
+        taxons:
+        - title: Driving instruction and driving lessons
+          base_path: /transport/driving-instruction-and-driving-lessons
+          phase: live
+          document_type: taxon
+  with_curated_topics_and_mainstream_browse_pages:
+    description: Currated topics and mainstream browse pages are combined.
+    data:
+      links:
+        mainstream_browse_pages:
+        - title: Driving licences
+          base_path: /browse/driving/driving-licences
+          document_type: mainstream_browse_page
+        - title: Driving tests and learning to drive or ride
+          base_path: /browse/driving/learning-to-drive
+          document_type: mainstream_browse_page
+        topics:
+        - title: Cars
+          base_path: /topic/driving-tests-and-learning-to-drive/car
+          document_type: topic
+  with_curated_topics_and_mainstream_browse_pages_and_taxons:
+    description: Currated topics and mainstream browse pages take precedence over the sidewide topic taxonomy.
+    data:
+      links:
+        mainstream_browse_pages:
+        - title: Driving licences
+          base_path: /browse/driving/driving-licences
+          document_type: mainstream_browse_page
+        - title: Driving tests and learning to drive or ride
+          base_path: /browse/driving/learning-to-drive
+          document_type: mainstream_browse_page
+        taxons:
+        - title: Driving instruction and driving lessons
+          base_path: /transport/driving-instruction-and-driving-lessons
+          phase: live
+          document_type: taxon
+        topics:
+        - title: Cars
+          base_path: /topic/driving-tests-and-learning-to-drive/car
+          document_type: topic
   with_collections:
     data:
       links:

data/app/views/govuk_publishing_components/components/related_navigation/_section.html.erb

@@ -4,11 +4,16 @@
      data-module="gem-toggle">
 
   <% unless section_title === "related_items" %>
-    <h3 id="related-nav-<%= section_title %>-<%= random %>"
-      data-track-count="sidebarRelatedItemSection"
-      class="<%= related_nav_helper.section_css_class("gem-c-related-navigation__sub-heading", section_title) %>">
-      <%= related_nav_helper.construct_section_heading(section_title) %>
-    </h3>
+    <%=
+      heading_class = related_nav_helper.section_css_class("gem-c-related-navigation__sub-heading", section_title)
+      heading_data = { 'track-count' => related_nav_helper.section_data_track_count(:related_item_section) }
+      heading_id = "related-nav-#{section_title}-#{random}"
+      heading_level = related_nav_helper.section_heading_level
+
+      content_tag(heading_level, id: heading_id, class: heading_class, data: heading_data) do
+        related_nav_helper.construct_section_heading(section_title)
+      end
+    %>
   <% end %>
 
   <ul class="gem-c-related-navigation__link-list" data-module="track-click">

data/config/locales/en.yml

@@ -42,6 +42,11 @@ en:
       topics: "Explore the topic"
       topical_events: "Topical event"
       world_locations: "World locations"
+    related_footer_navigation:
+      collections: "Collections"
+      policies: "Policies"
+      statistical_data_sets: "Statistical data sets"
+      topical_events: "Topical events"
     step_by_step_nav:
       show: "Show"
       hide: "Hide"
@@ -53,9 +58,3 @@ en:
       email_signup_link_text: "Get email alerts"
       feed_link_text: "Subscribe to feed"
       subscriptions: "Subscriptions"
-    taxonomy_navigation:
-      collections: "Collection"
-      related_content: "Related content"
-      statistical_data_sets: "Statistical data set"
-      topical_events: "Topical event"
-      world_locations: "World locations"

data/lib/govuk_publishing_components.rb

@@ -11,8 +11,6 @@ require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_tax
 require "govuk_publishing_components/presenters/services"
 require "govuk_publishing_components/presenters/select"
 require "govuk_publishing_components/presenters/meta_tags"
-require "govuk_publishing_components/presenters/taxonomy_navigation"
-require "govuk_publishing_components/presenters/curated_taxonomy_sidebar_links"
 require "govuk_publishing_components/presenters/content_item"
 require "govuk_publishing_components/presenters/translation_nav_helper"
 require "govuk_publishing_components/presenters/subscription_links_helper"