govuk-components 1.1.9 → 2.0.0b4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58f95bba6b6806470b1963b8e9d62aa69eb0b09c98c0d6ec0e8416ac9412d14e
-  data.tar.gz: 053dab8628ad0849dd16c01649c6cef559b277612f0766d25061e691bcc574b5
+  metadata.gz: adc43cd112d0d674ac3780c1b8d82b73085994b4d94d4637b555309c35339f3f
+  data.tar.gz: c48babb1d6c848ce088a4677021dfdf6b85e99381de187856db129f3256026c1
 SHA512:
-  metadata.gz: 21f9795a2058a029949d179df03227f05c10cf7d41c2e0645566aff872886ec2c5293b1d91c7472a61c9496fad12174d15f2985568b06427942261db4912084d
-  data.tar.gz: 883d695f40a82e58ed96fd1ee78a9426fe62e5772cf10a182165f31fc6781b8ecccdd606388ee5725aad9f02077e2940f969c05271766ab9cf7e64b46aa79254
+  metadata.gz: c8d079f362768501769be70a9ab9e18664b995f32a36693b1b7f6be230c4394d61a006255703f467fd7d80b190976690f1268ca303914e1c6155bc9e2f56ab4b
+  data.tar.gz: ffee587ebba53cdde8399c898a34cf0def0d7d43327153300972afd6a0e6c4e08fdf64bfb3bda90b178152ab0f71f50daca9532f33542dc5654d80a259ca99c6

data/README.md

@@ -99,7 +99,11 @@ To setup the dummy app:
 `bin/rails db:migrate`
 `bin/rails s`
 
-After adding a new component update the examples page by cd-ing into the dummy app `cd spec/dummy` and running the rake task `bin/rake generate_examples_page`.
+After changing a component or adding a new one:
+
+* add or update the corresponding specs, and check they pass by running `bundle exec rspec`.
+
+* update the examples page by cd-ing into the dummy app `cd spec/dummy` and running the rake task `bin/rake generate_examples_page`.
 
 ## License
 

data/app/components/govuk_component/{accordion.html.erb → accordion_component.html.erb}

@@ -3,13 +3,13 @@
     <%= tag.div(id: section.id(suffix: 'section'), class: section.classes, **section.html_attributes) do %>
       <div class="govuk-accordion__section-header">
         <h2 class="govuk-accordion__section-heading">
-          <%= tag.span(section.title, id: section.id, class: "govuk-accordion__section-button", aria: { expanded: section.expanded? }) %>
+          <%= tag.span(section.title, id: section.id, class: "govuk-accordion__section-button", aria: { expanded: section.expanded?, controls: section.id(suffix: 'content') }) %>
         </h2>
         <% if section.summary.present? %>
           <%= tag.div(section.summary, id: section.id(suffix: 'summary'), class: %w(govuk-accordion__section-summary govuk-body)) %>
         <% end %>
       </div>
-      <%= tag.div(section.content, id: section.id(suffix: 'content'), class: %w(govuk-accordion__section-content), aria: { labelledby: section.id }) %>
+      <%= section %>
     <% end %>
   <% end %>
 <% end %>

data/app/components/govuk_component/{accordion.rb → accordion_component.rb}

@@ -1,10 +1,7 @@
-class GovukComponent::Accordion < GovukComponent::Base
-  include ViewComponent::Slotable
+class GovukComponent::AccordionComponent < GovukComponent::Base
+  renders_many :sections, "Section"
 
-  with_slot :section, collection: true, class_name: 'Section'
-  wrap_slot :section
-
-  attr_accessor :id
+  attr_reader :id
 
   def initialize(id: nil, classes: [], html_attributes: {})
     super(classes: classes, html_attributes: html_attributes)
@@ -18,31 +15,33 @@ private
     %w(govuk-accordion)
   end
 
-  class Section < GovukComponent::Slot
-    attr_accessor :title, :summary, :expanded
+  class Section < GovukComponent::Base
+    attr_reader :title, :summary, :expanded
 
     alias_method :expanded?, :expanded
 
     def initialize(title:, summary: nil, expanded: false, classes: [], html_attributes: {})
       super(classes: classes, html_attributes: html_attributes)
 
-      self.title   = title
-      self.summary = summary
-      self.expanded = expanded
+      @title    = title
+      @summary  = summary
+      @expanded = expanded
     end
 
     def id(suffix: nil)
       [title.parameterize, suffix].compact.join('-')
     end
 
-    def classes
-      super + (expanded? ? %w(govuk-accordion__section--expanded) : [])
+    def call
+      tag.div(content, id: id(suffix: 'content'), class: %w(govuk-accordion__section-content), aria: { labelledby: id })
     end
 
   private
 
     def default_classes
-      %w(govuk-accordion__section)
+      %w(govuk-accordion__section).tap do |classes|
+        classes.append("govuk-accordion__section--expanded") if expanded?
+      end
     end
   end
 end

data/app/components/govuk_component/{back_link.rb → back_link_component.rb}

@@ -1,5 +1,5 @@
-class GovukComponent::BackLink < GovukComponent::Base
-  attr_accessor :text, :href, :options
+class GovukComponent::BackLinkComponent < GovukComponent::Base
+  attr_reader :text, :href, :options
 
   def initialize(text:, href:, classes: nil, html_attributes: {})
     super(classes: classes, html_attributes: html_attributes)
@@ -8,6 +8,10 @@ class GovukComponent::BackLink < GovukComponent::Base
     @href = href
   end
 
+  def call
+    link_to(text, href, class: classes, **html_attributes)
+  end
+
 private
 
   def default_classes

data/app/components/govuk_component/base.rb

@@ -1,17 +1,19 @@
 class GovukComponent::Base < ViewComponent::Base
+  include Govuk::Components::Helpers::CssUtilities
+
   include GovukComponent::Traits::CustomClasses
   include GovukComponent::Traits::CustomHtmlAttributes
 
-  def initialize(classes: [], html_attributes: {})
+  attr_reader :html_attributes
+
+  def initialize(classes:, html_attributes:)
     @classes         = parse_classes(classes)
     @html_attributes = html_attributes
+
+    super
   end
 
-  # Redirect #add_name to #slot(:name) to make building components
-  # with slots feel more DSL-like
-  def self.wrap_slot(name)
-    define_method(%(add_#{name})) do |*args, **kwargs, &block|
-      slot(name, *args, **kwargs, &block)
-    end
+  def default_classes
+    []
   end
 end

data/app/components/govuk_component/{breadcrumbs.html.erb → breadcrumbs_component.html.erb}

@@ -1,17 +1,14 @@
 <%= tag.div(class: classes, **html_attributes) do %>
   <ol class="govuk-breadcrumbs__list">
-    <%- @breadcrumbs.each do |text, link| %>
+    <% @breadcrumbs.each do |text, link| %>
 
-      <%- if link.present? -%>
+      <% if link.present? %>
         <li class="govuk-breadcrumbs__list-item">
           <%= link_to(text, link, class: "govuk-breadcrumbs__link") %>
         </li>
       <% else %>
-        <li class="govuk-breadcrumbs__list-item" aria-current="page">
-          <%= text %>
-        </li>
+        <%= tag.li(text, class: "govuk-breadcrumbs__list-item", aria: { current: "page" }) %>
       <% end %>
-
     <% end %>
   </ol>
 <% end %>

data/app/components/govuk_component/{breadcrumbs.rb → breadcrumbs_component.rb}

@@ -1,5 +1,5 @@
-class GovukComponent::Breadcrumbs < GovukComponent::Base
-  attr_accessor :breadcrumbs
+class GovukComponent::BreadcrumbsComponent < GovukComponent::Base
+  attr_reader :breadcrumbs, :hide_in_print, :collapse_on_mobile
 
   def initialize(breadcrumbs:, hide_in_print: false, collapse_on_mobile: false, classes: [], html_attributes: {})
     super(classes: classes, html_attributes: html_attributes)
@@ -13,8 +13,8 @@ private
 
   def default_classes
     %w(govuk-breadcrumbs).tap do |classes|
-      classes << "govuk-!-display-none-print" if @hide_in_print
-      classes << "govuk-breadcrumbs--collapse-on-mobile" if @collapse_on_mobile
+      classes << "govuk-!-display-none-print" if hide_in_print
+      classes << "govuk-breadcrumbs--collapse-on-mobile" if collapse_on_mobile
     end
   end
 end

data/app/components/govuk_component/{cookie_banner.html.erb → cookie_banner_component.html.erb}

@@ -3,14 +3,10 @@
     <div class="govuk-grid-row">
       <div class="govuk-grid-column-two-thirds">
         <% if title.present? %>
-          <h2 class="govuk-cookie-banner__heading govuk-heading-m">
-            <%= title %>
-          </h2>
+          <%= tag.h2(title, class: %w(govuk-cookie-banner__heading govuk-heading-m)) %>
         <% end %>
 
-        <div class="govuk-cookie-banner__content">
-          <%= body %>
-        </div>
+        <%= tag.div(body, class: "govuk-cookie-banner__content") %>
       </div>
     </div>
 

data/app/components/govuk_component/{cookie_banner.rb → cookie_banner_component.rb}

@@ -1,4 +1,4 @@
-class GovukComponent::CookieBanner < GovukComponent::Base
+class GovukComponent::CookieBannerComponent < GovukComponent::Base
   renders_one :body
   renders_one :actions
 

data/app/components/govuk_component/details_component.rb

@@ -0,0 +1,40 @@
+class GovukComponent::DetailsComponent < GovukComponent::Base
+  attr_reader :summary_text, :text
+
+  renders_one :summary_html
+
+  def initialize(summary_text:, text: nil, classes: [], html_attributes: {})
+    super(classes: classes, html_attributes: html_attributes)
+
+    @summary_text = summary_text
+    @text         = text
+  end
+
+  def call
+    tag.details(class: classes, data: { module: "govuk-details" }, **html_attributes) do
+      safe_join([summary, description])
+    end
+  end
+
+private
+
+  def summary
+    tag.summary(class: "govuk-details__summary") do
+      tag.span(summary_content, class: "govuk-details__summary-text")
+    end
+  end
+
+  def summary_content
+    summary_html || summary_text
+  end
+
+  def description
+    tag.div(class: "govuk-details__text") do
+      content.presence || text
+    end
+  end
+
+  def default_classes
+    %w(govuk-details)
+  end
+end

data/app/components/govuk_component/{footer.html.erb → footer_component.html.erb}

@@ -2,7 +2,7 @@
   <div class="govuk-width-container ">
     <div class="govuk-footer__meta">
       <% if meta.present? %>
-        <%= meta.content %>
+        <%= meta %>
       <% else %>
         <div class="govuk-footer__meta-item govuk-footer__meta-item--grow">
           <% if meta_items.any? %>
@@ -28,13 +28,11 @@
           <% end %>
 
           <% if meta_content.present? %>
-            <%= meta_content.content %>
+            <%= meta_content %>
           <% end %>
         </div>
         <div class="govuk-footer__meta">
-          <div class="govuk-footer__meta-item">
-            <%= copyright %>
-          </div>
+          <%= tag.div(copyright, class: "govuk-footer__meta-item") %>
         </div>
       <% end %>
     </div>

data/app/components/govuk_component/{footer.rb → footer_component.rb}

@@ -1,13 +1,8 @@
-class GovukComponent::Footer < GovukComponent::Base
-  include ViewComponent::Slotable
+class GovukComponent::FooterComponent < GovukComponent::Base
+  renders_one :meta_content
+  renders_one :meta
 
-  with_slot :meta_content
-  wrap_slot :meta_content
-
-  with_slot :meta
-  wrap_slot :meta
-
-  attr_accessor :meta_items, :meta_items_title, :meta_licence, :copyright
+  attr_reader :meta_items, :meta_items_title, :meta_licence, :copyright
 
   def initialize(meta_items: {}, meta_items_title: "Support links", meta_licence: nil, classes: [], html_attributes: {}, copyright_text: default_copright_text, copyright_url: default_copyright_url)
     super(classes: classes, html_attributes: html_attributes)

data/app/components/govuk_component/header_component.html.erb

@@ -0,0 +1,49 @@
+<%= tag.header(class: classes, role: 'banner', data: { module: 'govuk-header' }, **html_attributes) do %>
+  <%= tag.div(class: container_classes) do %>
+    <div class="govuk-header__logo">
+      <%= link_to(homepage_url, class: %w(govuk-header__link govuk-header__link--homepage)) do %>
+        <span class="govuk-header__logotype">
+          <% if custom_logo.present? %>
+            <%= custom_logo %>
+          <% else %>
+            <% if crown %>
+              <svg aria-hidden="true" focusable="false" class="govuk-header__logotype-crown" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 132 97" height="30" width="36">
+                <path fill="currentColor" fill-rule="evenodd" d="M25 30.2c3.5 1.5 7.7-.2 9.1-3.7 1.5-3.6-.2-7.8-3.9-9.2-3.6-1.4-7.6.3-9.1 3.9-1.4 3.5.3 7.5 3.9 9zM9 39.5c3.6 1.5 7.8-.2 9.2-3.7 1.5-3.6-.2-7.8-3.9-9.1-3.6-1.5-7.6.2-9.1 3.8-1.4 3.5.3 7.5 3.8 9zM4.4 57.2c3.5 1.5 7.7-.2 9.1-3.8 1.5-3.6-.2-7.7-3.9-9.1-3.5-1.5-7.6.3-9.1 3.8-1.4 3.5.3 7.6 3.9 9.1zm38.3-21.4c3.5 1.5 7.7-.2 9.1-3.8 1.5-3.6-.2-7.7-3.9-9.1-3.6-1.5-7.6.3-9.1 3.8-1.3 3.6.4 7.7 3.9 9.1zm64.4-5.6c-3.6 1.5-7.8-.2-9.1-3.7-1.5-3.6.2-7.8 3.8-9.2 3.6-1.4 7.7.3 9.2 3.9 1.3 3.5-.4 7.5-3.9 9zm15.9 9.3c-3.6 1.5-7.7-.2-9.1-3.7-1.5-3.6.2-7.8 3.7-9.1 3.6-1.5 7.7.2 9.2 3.8 1.5 3.5-.3 7.5-3.8 9zm4.7 17.7c-3.6 1.5-7.8-.2-9.2-3.8-1.5-3.6.2-7.7 3.9-9.1 3.6-1.5 7.7.3 9.2 3.8 1.3 3.5-.4 7.6-3.9 9.1zM89.3 35.8c-3.6 1.5-7.8-.2-9.2-3.8-1.4-3.6.2-7.7 3.9-9.1 3.6-1.5 7.7.3 9.2 3.8 1.4 3.6-.3 7.7-3.9 9.1zM69.7 17.7l8.9 4.7V9.3l-8.9 2.8c-.2-.3-.5-.6-.9-.9L72.4 0H59.6l3.5 11.2c-.3.3-.6.5-.9.9l-8.8-2.8v13.1l8.8-4.7c.3.3.6.7.9.9l-5 15.4v.1c-.2.8-.4 1.6-.4 2.4 0 4.1 3.1 7.5 7 8.1h.2c.3 0 .7.1 1 .1.4 0 .7 0 1-.1h.2c4-.6 7.1-4.1 7.1-8.1 0-.8-.1-1.7-.4-2.4V34l-5.1-15.4c.4-.2.7-.6 1-.9zM66 92.8c16.9 0 32.8 1.1 47.1 3.2 4-16.9 8.9-26.7 14-33.5l-9.6-3.4c1 4.9 1.1 7.2 0 10.2-1.5-1.4-3-4.3-4.2-8.7L108.6 76c2.8-2 5-3.2 7.5-3.3-4.4 9.4-10 11.9-13.6 11.2-4.3-.8-6.3-4.6-5.6-7.9 1-4.7 5.7-5.9 8-.5 4.3-8.7-3-11.4-7.6-8.8 7.1-7.2 7.9-13.5 2.1-21.1-8 6.1-8.1 12.3-4.5 20.8-4.7-5.4-12.1-2.5-9.5 6.2 3.4-5.2 7.9-2 7.2 3.1-.6 4.3-6.4 7.8-13.5 7.2-10.3-.9-10.9-8-11.2-13.8 2.5-.5 7.1 1.8 11 7.3L80.2 60c-4.1 4.4-8 5.3-12.3 5.4 1.4-4.4 8-11.6 8-11.6H55.5s6.4 7.2 7.9 11.6c-4.2-.1-8-1-12.3-5.4l1.4 16.4c3.9-5.5 8.5-7.7 10.9-7.3-.3 5.8-.9 12.8-11.1 13.8-7.2.6-12.9-2.9-13.5-7.2-.7-5 3.8-8.3 7.1-3.1 2.7-8.7-4.6-11.6-9.4-6.2 3.7-8.5 3.6-14.7-4.6-20.8-5.8 7.6-5 13.9 2.2 21.1-4.7-2.6-11.9.1-7.7 8.8 2.3-5.5 7.1-4.2 8.1.5.7 3.3-1.3 7.1-5.7 7.9-3.5.7-9-1.8-13.5-11.2 2.5.1 4.7 1.3 7.5 3.3l-4.7-15.4c-1.2 4.4-2.7 7.2-4.3 8.7-1.1-3-.9-5.3 0-10.2l-9.5 3.4c5 6.9 9.9 16.7 14 33.5 14.8-2.1 30.8-3.2 47.7-3.2z"></path>
+                <image src="/assets/images/govuk-logotype-crown.png" xlink:href="" class="govuk-header__logotype-crown-fallback-image" width="36" height="32"></image>
+              </svg>
+            <% end %>
+            <%= tag.span(logotype, class: "govuk-header__logotype-text") %>
+          <% end %>
+        </span>
+        <% if product_name.present? %>
+          <%= product_name %>
+        <% end %>
+      <% end %>
+    </div>
+
+    <% if service_name.present? || items.present? %>
+      <div class="govuk-header__content">
+        <% if service_name.present? %>
+          <%= link_to(service_name, service_url, class: %w(govuk-header__link govuk-header__link--service-name)) %>
+        <% end %>
+
+        <% if items.any? %>
+          <%= tag.button("Menu", type: "button", class: %w(govuk-header__menu-button govuk-js-header-toggle), aria: { controls: "navigation", label: menu_button_label }) %>
+          <nav>
+            <%= tag.ul(class: navigation_classes, id: "navigation", aria: { label: navigation_label }) do %>
+              <% items.each do |item| %>
+                <%= tag.li(class: item.classes.append(item.active_class), **item.html_attributes) do %>
+                  <% if item.link? %>
+                    <%= link_to(item.text, item.href, class: "govuk-header__link") %>
+                  <% else %>
+                    <%= item.text %>
+                  <% end %>
+                <% end %>
+              <% end %>
+            <% end %>
+          </nav>
+        <% end %>
+      </div>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/govuk_component/header_component.rb

@@ -0,0 +1,112 @@
+class GovukComponent::HeaderComponent < GovukComponent::Base
+  renders_many :items, "Item"
+  renders_one :custom_logo
+  renders_one :product_name, "ProductName"
+
+  attr_reader :logotype,
+              :crown,
+              :homepage_url,
+              :service_name,
+              :service_url,
+              :menu_button_label,
+              :navigation_label,
+              :custom_navigation_classes,
+              :custom_container_classes
+
+  def initialize(classes: [],
+                 html_attributes: {},
+                 logotype: 'GOV.UK',
+                 crown: true,
+                 homepage_url: '/',
+                 menu_button_label: 'Show or hide navigation menu',
+                 navigation_classes: [],
+                 navigation_label: 'Navigation menu',
+                 service_name: nil,
+                 service_url: '/',
+                 container_classes: nil)
+
+    super(classes: classes, html_attributes: html_attributes)
+
+    @logotype                  = logotype
+    @crown                     = crown
+    @homepage_url              = homepage_url
+    @service_name              = service_name
+    @service_url               = service_url
+    @menu_button_label         = menu_button_label
+    @custom_navigation_classes = navigation_classes
+    @navigation_label          = navigation_label
+    @custom_container_classes  = container_classes
+  end
+
+private
+
+  def default_classes
+    %w(govuk-header)
+  end
+
+  def navigation_classes
+    combine_classes(%w(govuk-header__navigation), custom_navigation_classes)
+  end
+
+  def container_classes
+    combine_classes(%w(govuk-header__container govuk-width-container), custom_container_classes)
+  end
+
+  class Item < GovukComponent::Base
+    attr_reader :text, :href, :active
+
+    def initialize(text:, href: nil, active: false, classes: [], html_attributes: {})
+      super(classes: classes, html_attributes: html_attributes)
+
+      @text   = text
+      @href   = href
+      @active = active
+    end
+
+    def active?
+      active
+    end
+
+    def active_class
+      %w(govuk-header__navigation-item--active) if active?
+    end
+
+    def link?
+      href.present?
+    end
+
+  private
+
+    def default_classes
+      %w(govuk-header__navigation-item)
+    end
+  end
+
+  class ProductName < GovukComponent::Base
+    attr_reader :name
+
+    def initialize(name: nil, html_attributes: {}, classes: [])
+      super(classes: classes, html_attributes: html_attributes)
+
+      @name = name
+    end
+
+    def render?
+      name.present? || content.present?
+    end
+
+    def call
+      if content.present?
+        tag.div(content, class: classes)
+      else
+        tag.span(name, class: classes)
+      end
+    end
+
+  private
+
+    def default_classes
+      %w(govuk-header__product-name)
+    end
+  end
+end