govuk_publishing_components 20.4.0 → 20.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be9c34e0c68a4a32acc65f384dd54ac57e84773a5fc4099bdd9c12d20eedbbdd
-  data.tar.gz: e6fcf672363a3b0feee426acc8135e65948802b9dc983d9c8b2eb44a8624b228
+  metadata.gz: edb735f60baaa578cdab6eb211bc872cd96ad7ee67c70f4905ae8ece490e389b
+  data.tar.gz: a6e7d541c2e4808d5e300045ed049f8796dc3841c5054929750532df473e2dbc
 SHA512:
-  metadata.gz: b56ee33a9621f7e751f113b61505dcadc0590a284374b3af27d33ba0a6d5aea313ed012a64ae156edef9297e7f0a54265da6ce79543ab712b8b3d7bcae4841f2
-  data.tar.gz: 90b2345ffb9bf05079648ef713fbcac8a18899d7cdc361d58c0b4fcad852a91d8d75bfd44c0bf09e19e5f8c3fab454fbf2c26392668e6cad9579e670baa360f7
+  metadata.gz: 305ad429e9948e5d059379290532eb4f2bda6aaea82d1b06305151f897e16730ea94b6dfacb4d410c4c1f5e64ef5bcf53f0fce300fb1aeb7e691cede9a22b21a
+  data.tar.gz: a9cbbecf9101e75b8f04342f65b2a1f16a4f84c6f6b35bc3371d8f0902af99c98446fe574f49cc42c38afd8f5012e8b414c87afad603244237c7acb55cd8240c

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

@@ -10,6 +10,16 @@
   box-shadow: 0 20px 15px -10px govuk-colour("white");
 }
 
+.gem-c-contents-list--font-size-19 .gem-c-contents-list__title,
+.gem-c-contents-list--font-size-19 .gem-c-contents-list__list {
+  @include govuk-font($size: 19, $line-height: 1.5);
+}
+
+.gem-c-contents-list--font-size-24 .gem-c-contents-list__title,
+.gem-c-contents-list--font-size-24 .gem-c-contents-list__list {
+  @include govuk-font($size: 24, $line-height: 1.5);
+}
+
 .gem-c-contents-list__title {
   @include govuk-text-colour;
   @include govuk-font($size: 16, $weight: regular, $line-height: 1.5);

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

@@ -1,47 +1,35 @@
-<%
-  cl_helper = GovukPublishingComponents::Presenters::ContentsListHelper.new
+<%-
+  cl_helper = GovukPublishingComponents::Presenters::ContentsListHelper.new(local_assigns)
+  aria_label ||= nil
   format_numbers ||= false
-  underline_links ||= false
-  contents ||= []
-  aria_label ||= ''
-  nested = !!contents.find { |c| c[:items] && c[:items].any? }
-  parent_list_item_modifier = if nested
-                                'parent'
-                              elsif format_numbers
-                                'numbered'
-                              else
-                                'dashed'
-                              end
+  hide_title ||= false
+
   brand ||= false
   brand_helper = GovukPublishingComponents::AppHelpers::BrandHelper.new(brand)
-  hide_title ||= false
-%>
-<% if contents.any? %>
-  <nav
-    role="navigation"
-    class="gem-c-contents-list <%= 'gem-c-contents-list--no-underline' unless underline_links %> <%= brand_helper.brand_class %>"
-    data-module="track-click"
-    <% if aria_label.present? %>
-      aria-label="<%= aria_label %>"
-    <% end %>
-  >
+
+  classes = cl_helper.classes
+  classes << brand_helper.brand_class
+-%>
+<% if cl_helper.contents.any? %>
+  <%= content_tag(
+    :nav,
+    class: classes,
+    "aria-label": aria_label,
+    role: "navigation",
+    data: {
+      module: "track-click"
+    }
+  ) do %>
     <% unless hide_title %>
       <h2 class="gem-c-contents-list__title"><%= t("components.contents_list.contents") %></h2>
     <% end %>
 
     <ol class="gem-c-contents-list__list">
       <% contents.each.with_index(1) do |contents_item, position| %>
-        <%
-          active_class = "gem-c-contents-list__list-item--active" if contents_item[:active]
-          aria_current = "aria-current = true" if contents_item[:active]
-        %>
-        <li
-          class="gem-c-contents-list__list-item gem-c-contents-list__list-item--<%= parent_list_item_modifier %> <%= active_class %>"
-          <%= aria_current %>
-        >
+        <li class="<%= cl_helper.list_item_classes(contents_item, false) %>" <%= "aria-current=true" if contents_item[:active] %>>
           <% link_text = format_numbers ? cl_helper.wrap_numbers_with_spans(contents_item[:text]) : contents_item[:text] %>
           <%= link_to_if !contents_item[:active], link_text, contents_item[:href],
-            class: "gem-c-contents-list__link #{brand_helper.color_class}",
+            class: "gem-c-contents-list__link govuk-link #{brand_helper.color_class}",
             data: {
               track_category: 'contentsClicked',
               track_action: "content_item #{position}",
@@ -51,19 +39,13 @@
               }
             }
           %>
+
           <% if contents_item[:items] && contents_item[:items].any? %>
             <ol class="gem-c-contents-list__nested-list">
               <% contents_item[:items].each.with_index(1) do |nested_contents_item, nested_position| %>
-              <%
-                active_class = "gem-c-contents-list__list-item--active" if nested_contents_item[:active]
-                aria_current = "aria-current = true" if nested_contents_item[:active]
-              %>
-                <li
-                  class="gem-c-contents-list__list-item gem-c-contents-list__list-item--dashed <%= active_class %>"
-                  <%= aria_current %>
-                >
+                <li class="<%= cl_helper.list_item_classes(nested_contents_item, true) %>" <%= "aria-current=true" if nested_contents_item[:active] %>>
                   <%= link_to_if !nested_contents_item[:active], nested_contents_item[:text], nested_contents_item[:href],
-                    class: "gem-c-contents-list__link #{brand_helper.color_class}",
+                    class: "gem-c-contents-list__link govuk-link #{brand_helper.color_class}",
                     data: {
                       track_category: 'contentsClicked',
                       track_action: "nested_content_item #{position}:#{nested_position}",
@@ -76,9 +58,9 @@
                 </li>
               <% end %>
             </ol>
-          <% end %>
+            <% end %>
         </li>
       <% end %>
     </ol>
-  </nav>
+  <% end %>
 <% end %>

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

@@ -1,10 +1,15 @@
 <%
   text ||= ""
   inverse ||= false
+  shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new(local_assigns)
+
+  custom_margin_bottom_class =  shared_helper.get_margin_bottom if [*0..9].include?(local_assigns[:margin_bottom])
+
+  classes = %w(gem-c-lead-paragraph)
+  classes << "gem-c-lead-paragraph--inverse" if inverse
+  classes << custom_margin_bottom_class if local_assigns[:margin_bottom]
 %>
 
 <% if text.present? %>
-  <p class="gem-c-lead-paragraph <% if inverse %>gem-c-lead-paragraph--inverse<% end %>">
-    <%= text %>
-  </p>
+  <%= content_tag :p, text, class: classes %>
 <% end %>

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

@@ -215,3 +215,14 @@ examples:
             text: Guidance and regulation
           - href: "#third-thing"
             text: Consultations
+  with_different_font_size:
+    description: Choose a different font size. Valid options are 24 (24px) and 19 (19px), with the component defaulting to 16px.
+    data:
+      font_size: 24
+      contents:
+        - href: "#first-thing"
+          text: Community best practice
+        - href: "#second-thing"
+          text: Guidance and regulation
+        - href: "#third-thing"
+          text: Consultations

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

@@ -20,3 +20,8 @@ examples:
       inverse: true
     context:
       dark_background: true
+  custom_margin_bottom:
+    description: The component accepts a number for margin bottom from 0 to 9 (0px to 60px) using the [GOV.UK Frontend spacing scale](https://design-system.service.gov.uk/styles/spacing/#the-responsive-spacing-scale). It defaults to having a margin bottom of 45px.
+    data:
+      text: This is some example text for a lead paragraph
+      margin_bottom: 6

data/lib/govuk_publishing_components/presenters/contents_list_helper.rb

@@ -5,6 +5,28 @@ module GovukPublishingComponents
     class ContentsListHelper
       include ActionView::Helpers::SanitizeHelper
 
+      attr_reader :classes, :contents
+
+      def initialize(options)
+        @contents = options[:contents] || []
+        @nested = !!@contents.find { |c| c[:items] && c[:items].any? }
+        @format_numbers = options[:format_numbers]
+        @font_size = options[:font_size]
+
+        @classes = %w(gem-c-contents-list)
+        @classes << " gem-c-contents-list--no-underline" unless options[:underline_links]
+        @classes << " gem-c-contents-list--font-size-#{@font_size}" if [24, 19].include? @font_size
+      end
+
+      def list_item_classes(list_item, nested)
+        list_item_classes = "gem-c-contents-list__list-item"
+        list_item_classes << " gem-c-contents-list__list-item--#{parent_modifier}" unless nested
+        list_item_classes << " gem-c-contents-list__list-item--dashed" if nested
+        list_item_classes << " gem-c-contents-list__list-item--active" if list_item[:active]
+
+        list_item_classes
+      end
+
       def wrap_numbers_with_spans(content_item_link)
         content_item_text = strip_tags(content_item_link) #just the text of the link
 
@@ -22,6 +44,18 @@ module GovukPublishingComponents
           content_item_link
         end
       end
+
+    private
+
+      def parent_modifier
+        if @nested
+          'parent'
+        elsif @format_numbers
+          'numbered'
+        else
+          'dashed'
+        end
+      end
     end
   end
 end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '20.4.0'.freeze
+  VERSION = '20.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 20.4.0
+  version: 20.5.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-10 00:00:00.000000000 Z
+date: 2019-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters