govuk-components 4.0.0 → 4.1.1

data/app/helpers/govuk_link_helper.rb

@@ -3,34 +3,20 @@ require "html_attributes_utils"
 module GovukLinkHelper
   using HTMLAttributesUtils
 
-  LINK_STYLES = {
-    inverse:          "govuk-link--inverse",
-    muted:            "govuk-link--muted",
-    no_underline:     "govuk-link--no-underline",
-    no_visited_state: "govuk-link--no-visited-state",
-    text_colour:      "govuk-link--text-colour",
-  }.freeze
-
-  BUTTON_STYLES = {
-    disabled:  "govuk-button--disabled",
-    secondary: "govuk-button--secondary",
-    warning:   "govuk-button--warning",
-  }.freeze
-
-  def govuk_link_classes(*styles, default_class: 'govuk-link')
-    if (invalid_styles = (styles - LINK_STYLES.keys)) && invalid_styles.any?
-      fail(ArgumentError, "invalid styles #{invalid_styles.to_sentence}. Valid styles are #{LINK_STYLES.keys.to_sentence}")
+  def govuk_link_classes(*styles, default_class: "#{brand}-link")
+    if (invalid_styles = (styles - link_styles.keys)) && invalid_styles.any?
+      fail(ArgumentError, "invalid styles #{invalid_styles.to_sentence}. Valid styles are #{link_styles.keys.to_sentence}")
     end
 
-    [default_class] + LINK_STYLES.values_at(*styles).compact
+    [default_class] + link_styles.values_at(*styles).compact
   end
 
-  def govuk_button_classes(*styles, default_class: 'govuk-button')
-    if (invalid_styles = (styles - BUTTON_STYLES.keys)) && invalid_styles.any?
-      fail(ArgumentError, "invalid styles #{invalid_styles.to_sentence}. Valid styles are #{BUTTON_STYLES.keys.to_sentence}")
+  def govuk_button_classes(*styles, default_class: "#{brand}-button")
+    if (invalid_styles = (styles - button_styles.keys)) && invalid_styles.any?
+      fail(ArgumentError, "invalid styles #{invalid_styles.to_sentence}. Valid styles are #{button_styles.keys.to_sentence}")
     end
 
-    [default_class] + BUTTON_STYLES.values_at(*styles).compact
+    [default_class] + button_styles.values_at(*styles).compact
   end
 
   def govuk_link_to(name = nil, options = nil, extra_options = {}, &block)
@@ -68,8 +54,11 @@ module GovukLinkHelper
 
   def govuk_button_link_to(name = nil, options = nil, extra_options = {}, &block)
     extra_options = options if block_given?
-    html_options = GovukComponent::StartButtonComponent::LINK_ATTRIBUTES
-      .merge build_html_options(extra_options, style: :button)
+    html_options = {
+      data: { module: "#{brand}-button" },
+      draggable: 'false',
+      role: 'button',
+    }.merge build_html_options(extra_options, style: :button)
 
     if block_given?
       link_to(name, html_options, &block)
@@ -91,8 +80,31 @@ module GovukLinkHelper
 
 private
 
+  def brand
+    Govuk::Components.brand
+  end
+
+  def link_styles
+    {
+      inverse:          "#{brand}-link--inverse",
+      muted:            "#{brand}-link--muted",
+      no_underline:     "#{brand}-link--no-underline",
+      no_visited_state: "#{brand}-link--no-visited-state",
+      text_colour:      "#{brand}-link--text-colour",
+    }
+  end
+
+  def button_styles
+    {
+      disabled:  "#{brand}-button--disabled",
+      secondary: "#{brand}-button--secondary",
+      warning:   "#{brand}-button--warning",
+      inverse:   "#{brand}-button--inverse",
+    }
+  end
+
   def build_html_options(provided_options, style: :link)
-    element_styles = { link: LINK_STYLES, button: BUTTON_STYLES }.fetch(style, {})
+    element_styles = { link: link_styles, button: button_styles }.fetch(style, {})
 
     # we need to take a couple of extra steps here because we don't want the style
     # params (inverse, muted, etc) to end up as extra attributes on the link.
@@ -110,7 +122,7 @@ private
     case style
     when :link then govuk_link_classes(*keys)
     when :button then govuk_button_classes(*keys)
-    when :breadcrumb then %w(govuk-breadcrumbs__link)
+    when :breadcrumb then "#{brand}-breadcrumbs__link"
     end
   end
 

data/app/helpers/govuk_skip_link_helper.rb

@@ -1,8 +1,8 @@
 module GovukSkipLinkHelper
   def govuk_skip_link(text: 'Skip to main content', href: '#main-content', classes: [], **html_attributes, &block)
-    link_classes = Array.wrap(classes).append('govuk-skip-link')
+    link_classes = Array.wrap(classes).append("#{brand}-skip-link")
 
-    html_attributes_with_data_module = { data: { module: "govuk-skip-link" } }.deep_merge(html_attributes)
+    html_attributes_with_data_module = { data: { module: "#{brand}-skip-link" } }.deep_merge(html_attributes)
 
     return link_to(href, class: link_classes, **html_attributes_with_data_module, &block) if block_given?
 

data/app/helpers/title_with_error_prefix_helper.rb

@@ -0,0 +1,7 @@
+module TitleWithErrorPrefixHelper
+  def title_with_error_prefix(title, error:, error_prefix: Govuk::Components.config.default_error_prefix)
+    "#{error_prefix if error}#{title}"
+  end
+end
+
+ActiveSupport.on_load(:action_view) { include TitleWithErrorPrefixHelper }

data/lib/govuk/components/engine.rb

@@ -32,11 +32,19 @@ module Govuk
     #
     # Default components configuration
     #
+    # +:brand+ sets the value used to prefix all classes, used to allow the components to be branded for alternative (similar) design systems
     # +:default_back_link_text+ Default text for the back link, defaults to +Back+
     # +:default_breadcrumbs_collapse_on_mobile+ false
     # +:default_breadcrumbs_hide_in_print+ false
     # +:default_cookie_banner_aria_label+ "Cookie banner"
     # +:default_cookie_banner_hide_in_print+ true
+    # +:default_error_prefix+ Text to use at the start of the page title tag when there is an error on the page. Default is 'Error: '
+    # +:default_exit_this_page_redirect_url+ The URL that the exit this page component links to by default. Defaults to https://www.bbc.co.uk/weather
+    # +:default_exit_this_page_text+ The default text that forms the link. Defaults to 'Exit this page'
+    # +:default_exit_this_page_activated_text+ Text announced by screen readers when Exit this Page has been activated via the keyboard shortcut. Default in govuk-frontend is 'Exiting page.' Defaults to nil so govuk-frontend value is used unless overridden.
+    # +:default_exit_this_page_timed_out_text+ Text announced by screen readers when the keyboard shortcut has timed out without successful activation. Default in govuk-frontend is 'Exit this page expired.' Defaults to nil so govuk-frontend value is used unless overridden.
+    # +:default_exit_this_page_press_two_more_times_text+ Text announced by screen readers when the user must press *Shift* two more times to activate the button. Default in govuk-frontend is 'Shift, press 2 more times to exit.' Defaults to nil so govuk-frontend value is used unless overridden.
+    # +:default_exit_this_page_press_one_more_time_text+ Text announced by screen readers when the user must press *Shift* one more time to activate the button. Default in govuk-frontend is 'Shift, press 1 more time to exit.' Defaults to nil so govuk-frontend value is used unless overridden.
     # +:default_header_navigation_label+ 'Navigation menu'
     # +:default_header_menu_button_label+ 'Show or hide navigation menu'
     # +:default_header_logotype+ 'GOV.UK'
@@ -66,11 +74,19 @@ module Govuk
     # +:require_summary_list_action_visually_hidden_text+ when true forces visually hidden text to be set for every action. It can still be explicitly skipped by passing in +nil+. Defaults to +false+
     # +:enable_auto_table_scopes+ automatically adds a scope of 'col' to th elements in thead and 'row' to th elements in tbody.
     DEFAULTS = {
+      brand: 'govuk',
       default_back_link_text: 'Back',
       default_breadcrumbs_collapse_on_mobile: false,
       default_breadcrumbs_hide_in_print: false,
       default_cookie_banner_aria_label: "Cookie banner",
       default_cookie_banner_hide_in_print: true,
+      default_error_prefix: "Error: ",
+      default_exit_this_page_redirect_url: "https://www.bbc.co.uk/weather",
+      default_exit_this_page_text: "Exit this page",
+      default_exit_this_page_activated_text: nil,
+      default_exit_this_page_timed_out_text: nil,
+      default_exit_this_page_press_two_more_times_text: nil,
+      default_exit_this_page_press_one_more_time_text: nil,
       default_header_navigation_label: 'Navigation menu',
       default_header_menu_button_label: 'Show or hide navigation menu',
       default_header_logotype: 'GOV.UK',
@@ -96,9 +112,7 @@ module Govuk
       default_notification_title_success: false,
       default_warning_text_icon_fallback_text: "Warning",
       default_warning_text_icon: "!",
-
       default_link_new_tab_text: "(opens in new tab)",
-
       require_summary_list_action_visually_hidden_text: false,
       enable_auto_table_scopes: true,
     }.freeze

data/lib/govuk/components/version.rb

@@ -1,5 +1,5 @@
 module Govuk
   module Components
-    VERSION = '4.0.0'.freeze
+    VERSION = '4.1.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk-components
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.1
 platform: ruby
 authors:
 - DfE developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-attributes-utils
@@ -48,16 +48,22 @@ dependencies:
   name: view_component
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
@@ -120,14 +126,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: 4.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: 4.12.0
 - !ruby/object:Gem::Dependency
   name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
@@ -310,8 +316,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.8.1
-description: A collection of components intended to ease the building of GOV.UK Design
-  System web applications
+description: This library provides view components for the GOV.UK Design System. It
+  makes creating services more familiar for Ruby on Rails developers.
 email:
 - peter.yates@digital.education.gov.uk
 executables: []
@@ -332,6 +338,7 @@ files:
 - app/components/govuk_component/cookie_banner_component.rb
 - app/components/govuk_component/cookie_banner_component/message_component.rb
 - app/components/govuk_component/details_component.rb
+- app/components/govuk_component/exit_this_page_component.rb
 - app/components/govuk_component/footer_component.html.erb
 - app/components/govuk_component/footer_component.rb
 - app/components/govuk_component/header_component.html.erb
@@ -372,15 +379,17 @@ files:
 - app/components/govuk_component/warning_text_component.rb
 - app/helpers/govuk_back_to_top_link_helper.rb
 - app/helpers/govuk_components_helper.rb
+- app/helpers/govuk_exit_this_page_link_helper.rb
 - app/helpers/govuk_link_helper.rb
 - app/helpers/govuk_skip_link_helper.rb
+- app/helpers/title_with_error_prefix_helper.rb
 - config/routes.rb
 - lib/govuk/components.rb
 - lib/govuk/components/engine.rb
 - lib/govuk/components/helpers/css_utilities.rb
 - lib/govuk/components/version.rb
 - lib/tasks/govuk/components_tasks.rake
-homepage: https://github.com/DFE-Digital/govuk-components
+homepage: https://github.com/x-govuk/govuk-components
 licenses:
 - MIT
 metadata: {}
@@ -402,5 +411,5 @@ requirements: []
 rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
-summary: Lightweight set of reusable GOV.UK Design System components
+summary: GOV.UK Components for Ruby on Rails
 test_files: []