ccs-frontend_helpers 0.1.0 → 0.1.1.rc.1

data/lib/ccs/components/govuk/footer/navigation.rb

@@ -0,0 +1,60 @@
+require_relative 'link'
+
+module CCS
+  module Components
+    module GovUK
+      class Footer < Base
+        # = GOV.UK Footer Navigation
+        #
+        # The individual footer navigation item
+        #
+        # @!attribute [r] title
+        #   @return [String] Title for the navigation section
+        # @!attribute [r] navigation_links
+        #   @return [Array<Link>] An array of the initialised navigation links
+        # @!attribute [r] width
+        #   @return [String] Width of the navigation section
+        # @!attribute [r] columns
+        #   @return [Integer] Number of columns to display the links in
+
+        class Navigation
+          include ActionView::Context
+          include ActionView::Helpers
+
+          private
+
+          attr_reader :title, :navigation_links, :width, :columns
+
+          public
+
+          # @param title [String] the title for the navigation section
+          # @param items [Array<Hash>] an array of links for the navigation section.
+          #                            See {Components::GovUK::Footer::Link#initialize Link#initialize} for details of the items in the array.
+          # @param width [String] ('full') width of each navigation section in the footer
+          # @param columns [Integer] (nil) number of columns to display the links
+          # @param context [ActionView::Base] the view context
+
+          def initialize(title:, items:, context:, width: nil, columns: nil)
+            @title = title
+            @navigation_links = items.map { |navigation_link| Link.new(li_class: 'govuk-footer__list-item', context: context, **navigation_link) }
+            @width = width || 'full'
+            @columns = columns
+          end
+
+          # Generates the HTML for the GOV.UK Footer Navigation sections
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.div(class: "govuk-footer__section govuk-grid-column-#{width}") do
+              concat(tag.h2(title, class: 'govuk-footer__heading govuk-heading-m'))
+              concat(tag.ul(class: "govuk-footer__list #{"govuk-footer__list--columns-#{columns}" if columns}".rstrip) do
+                navigation_links.each { |navigation_link| concat(navigation_link.render) }
+              end)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/footer.rb

@@ -0,0 +1,131 @@
+require_relative '../base'
+require_relative 'footer/navigation'
+require_relative 'footer/meta'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Footer
+      #
+      # This is used to generate the footer component from the
+      # {https://design-system.service.gov.uk/components/footer GDS - Components - Footer}
+      #
+      # @!attribute [r] navigation
+      #   @return [Array<Navigation>] An array of the initialised navigation sections
+      # @!attribute [r] meta
+      #   @return [Meta] The initialised meta section
+
+      class Footer < Base
+        private
+
+        attr_reader :navigation, :meta
+
+        public
+
+        # @param navigation [Array<Hash>] an array of sections for the footer navigation.
+        #                                 See {Components::GovUK::Footer::Navigation#initialize Navigation#initialize} for details of the items in the array.
+        # @param meta [Hash] ptions for the meta section of the footer.
+        #                    See {Components::GovUK::Footer::Meta#initialize Meta#initialize} for details of the options.
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the footer HTML
+        # @option options [String] :container_class classes that can be added to the inner container
+        # @option options [ActiveSupport::SafeBuffer,String] :content_licence The content licence information, see {CCS::Components::GovUK::Footer#footer_content_licence footer_content_licence} for default
+        # @option options [ActiveSupport::SafeBuffer,String] :copyright The copyright information, (default: '© Crown copyright')
+        # @option options [Hash] :attributes additional attributes that will added as part of the HTML
+
+        def initialize(navigation: nil, meta: nil, **options)
+          super(**options)
+
+          @options[:attributes][:role] = 'contentinfo'
+          @options[:copyright] ||= '© Crown copyright'
+
+          @navigation = navigation&.map { |navigation_item| Navigation.new(context: @context, **navigation_item) }
+          @meta = Meta.new(context: @context, **meta) if meta
+        end
+
+        # rubocop:disable Metrics/AbcSize
+
+        # Generates the HTML for the GOV.UK Footer component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.footer(**options[:attributes]) do
+            tag.div(class: "govuk-width-container #{options[:container_classes]}".rstrip) do
+              if navigation
+                concat(tag.div(class: 'govuk-footer__navigation') do
+                  navigation.each { |navigation_item| concat(navigation_item.render) }
+                end)
+                concat(tag.hr(class: 'govuk-footer__section-break'))
+              end
+              concat(tag.div(class: 'govuk-footer__meta') do
+                concat(tag.div(class: 'govuk-footer__meta-item govuk-footer__meta-item--grow') do
+                  concat(meta.render) if meta
+                  concat(footer_logo)
+                  concat(footer_content_licence)
+                end)
+                concat(footer_copyright)
+              end)
+            end
+          end
+        end
+
+        # rubocop:enable Metrics/AbcSize
+
+        # The default attributes for the breadcrumbs
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-footer' }.freeze
+
+        private
+
+        # Generates the logo used in the footer
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def footer_logo
+          tag.svg(
+            class: 'govuk-footer__licence-logo',
+            aria: { hidden: 'true' },
+            focusable: 'false',
+            xmlns: 'http://www.w3.org/2000/svg',
+            viewBox: '0 0 483.2 195.7',
+            height: '17',
+            width: '41'
+          ) do
+            tag.path(
+              fill: 'currentColor',
+              d: 'M421.5 142.8V.1l-50.7 32.3v161.1h112.4v-50.7zm-122.3-9.6A47.12 47.12 0 0 1 221 97.8c0-26 21.1-47.1 47.1-47.1 16.7 0 31.4 8.7 39.7 21.8l42.7-27.2A97.63 97.63 0 0 0 268.1 0c-36.5 0-68.3 20.1-85.1 49.7A98 98 0 0 0 97.8 0C43.9 0 0 43.9 0 97.8s43.9 97.8 97.8 97.8c36.5 0 68.3-20.1 85.1-49.7a97.76 97.76 0 0 0 149.6 25.4l19.4 22.2h3v-87.8h-80l24.3 27.5zM97.8 145c-26 0-47.1-21.1-47.1-47.1s21.1-47.1 47.1-47.1 47.2 21 47.2 47S123.8 145 97.8 145'
+            )
+          end
+        end
+
+        # Generates the content licence for the footer
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def footer_content_licence
+          tag.span(class: 'govuk-footer__licence-description') do
+            if options[:content_licence]
+              concat(options[:content_licence])
+            else
+              concat('All content is available under the')
+              concat(link_to('Open Government Licence v3.0', 'https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/', class: 'govuk-footer__link', rel: 'license'))
+              concat(', except where otherwise stated')
+            end
+          end
+        end
+
+        # Generates the copyright used in the footer
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def footer_copyright
+          tag.div(class: 'govuk-footer__meta-item') do
+            link_to(options[:copyright], 'https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/', class: 'govuk-footer__link govuk-footer__copyright-logo')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/form_group.rb

@@ -0,0 +1,60 @@
+require_relative '../base'
+require_relative 'error_message'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK FormGroup
+      #
+      # This helper is used for generating the form group component from the Government Design Systems
+      #
+      # @!attribute [r] attribute
+      #   @return [String,Symbol] Attribute that the form group is for
+      # @!attribute [r] error_message
+      #   @return [String] Text for the error message
+
+      class FormGroup < Base
+        private
+
+        attr_reader :attribute, :error_message
+
+        public
+
+        # @param attribute [String,Symbol] the attribute that the form group is for
+        # @param error_message [String] (nil) the error message to be displayed
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the form group HTML
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(attribute:, error_message: nil, **options)
+          super(**options)
+
+          @options[:attributes][:id] ||= "#{attribute}-form-group"
+          @options[:attributes][:class][..15] = 'govuk-form-group govuk-form-group--error' if error_message
+
+          @attribute = attribute
+          @error_message = error_message
+        end
+
+        # Generates the HTML for the GOV.UK Form Group component
+        #
+        # @yield HTML that will be contained within the 'govuk-form-group' div
+        #
+        # @yieldparam displayed_error_message [ActiveSupport::SafeBuffer] the HTML for the error message (if there is one)
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            yield((ErrorMessage.new(message: error_message, attribute: attribute, context: context).render if error_message))
+          end
+        end
+
+        # The default attributes for the form group
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-form-group' }.freeze
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/header/link.rb

@@ -0,0 +1,56 @@
+require_relative '../../base'
+
+module CCS
+  module Components
+    module GovUK
+      class Header < Base
+        # = GOV.UK Header link
+        #
+        # The individual header link item
+        #
+        # @!attribute [r] text
+        #   @return [String] Text for the header link
+        # @!attribute [r] href
+        #   @return [String] The href for the header link
+
+        class Link < Base
+          private
+
+          attr_reader :text, :href
+
+          public
+
+          # @param text [String] the text for the header link
+          # @param href [String] the href for the header link
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [Boolean] :active flag to mark the navigation item as active or not
+          # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+          def initialize(text:, href: nil, **options)
+            super(**options)
+
+            @text = text
+            @href = href
+          end
+
+          # Generates the HTML for the GOV.UK Header link
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.li(class: "govuk-header__navigation-item #{'govuk-header__navigation-item--active' if options[:active]}".rstrip) do
+              if href
+                options[:attributes][:class] = 'govuk-header__link'
+
+                link_to(text, href, **options[:attributes])
+              else
+                text
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/header/navigation.rb

@@ -0,0 +1,71 @@
+require_relative 'link'
+
+module CCS
+  module Components
+    module GovUK
+      class Header < Base
+        # = GOV.UK Header navigation
+        #
+        # The header navigation section
+        #
+        # @!attribute [r] navigation_links
+        #   @return [Array<Link>] An array of the initialised navigation links
+        # @!attribute [r] navigation_label
+        #   @return [String] The aria label for the navigation
+        # @!attribute [r] navigation_classes
+        #   @return [String] The classes for the navigation
+        # @!attribute [r] menu_button
+        #   @return [Hash] The options for the menu button
+
+        class Navigation
+          include ActionView::Context
+          include ActionView::Helpers
+
+          private
+
+          attr_reader :navigation_links, :navigation_label, :navigation_classes, :menu_button
+
+          public
+
+          # @param navigation [Hash] options for the navigation
+          # @param context [ActionView::Base] the view context
+          # @param menu_button [Hash] options for the menu button
+          #
+          # @option navigation [Array] :items an array of links for the navigation section.
+          #                            See {Components::GovUK::Header::Link#initialize Link#initialize} for details of the items in the array.
+          # @option navigation [String] :classes additional CSS classes for the navigation HTML
+          # @option navigation [String] :label text for the aria-label attribute of the navigation. Defaults to the menu button text
+          #
+          # @option menu_button [String] :text text for the button that opens the mobile navigation menu.
+          #                                    By default, this is set to +Menu+.
+          # @option menu_button [String] :label text for the aria-label attribute of the button that opens the mobile navigation.
+          #                                     Defaults to +Show or hide menu+.
+
+          def initialize(navigation:, context:, menu_button: nil)
+            menu_button ||= {}
+            menu_button[:text] ||= 'Menu'
+            menu_button[:label] ||= 'Show or hide menu'
+
+            @menu_button = menu_button
+            @navigation_links = navigation[:items].map { |navigation_link| Link.new(context: context, **navigation_link) }
+            @navigation_label = navigation[:label] || menu_button[:text]
+            @navigation_classes = "govuk-header__navigation #{navigation[:classes]}".rstrip
+          end
+
+          # Generates the HTML for the GOV.UK Navigation
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.nav(aria: { label: navigation_label }, class: navigation_classes) do
+              concat(button_tag(menu_button[:text], type: :button, class: 'govuk-header__menu-button govuk-js-header-toggle', aria: { controls: 'navigation', label: menu_button[:label] }, hidden: true))
+              concat(tag.ul(id: 'navigation', class: 'govuk-header__navigation-list') do
+                navigation_links.each { |navigation_link| concat(navigation_link.render) }
+              end)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/header.rb

@@ -0,0 +1,107 @@
+require_relative '../base'
+require_relative 'header/navigation'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Header
+      #
+      # This is used to generate the header component from the
+      # {https://design-system.service.gov.uk/components/header GDS - Components - Header}
+      #
+      # @!attribute [r] navigation
+      #   @return [Navigation] The initialised navigation section
+      # @!attribute [r] service
+      #   @return [Hash] The options for the service section
+
+      class Header < Base
+        private
+
+        attr_reader :navigation, :service
+
+        public
+
+        # @param navigation [Hash] options for the navigation section of the header.
+        #                          See {Components::GovUK::Header::Navigation#initialize Navigation#initialize} for details of the options.
+        # @param menu_button [Hash] options for the menu button in the header.
+        #                           See {Components::GovUK::Header::Navigation#initialize Navigation#initialize} for details of the options.
+        # @param service [Hash] options for the service name
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option service [String] :name the name of the service, included in the header
+        # @option service [String] :href URL for the service name anchor
+        #
+        # @option options [String] :classes additional CSS classes for the header HTML
+        # @option options [String] :container_classes classes for the container
+        # @option options [String] :homepage_url URL of the homepage. Defaults to +/+
+        # @option options [String] :product_name product name, used when the product name follows on directly from ‘GOV.UK
+        # @option options [Hash] :attributes additional attributes that will added as part of the header HTML
+
+        def initialize(navigation: nil, menu_button: nil, service: nil, **options)
+          super(**options)
+
+          @options[:attributes][:role] = 'banner'
+          @options[:container_classes] ||= 'govuk-width-container'
+          @options[:homepage_url] ||= '/'
+
+          @navigation = Navigation.new(navigation: navigation, menu_button: menu_button, context: @context) if navigation
+          @service = service
+        end
+
+        # Generates the HTML for the GOV.UK Header component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.header(**options[:attributes]) do
+            tag.div(class: "govuk-header__container #{options[:container_classes]}") do
+              concat(header_logo)
+              if service || navigation
+                concat(tag.div(class: 'govuk-header__content') do
+                  concat(header_service_name) if service
+                  concat(navigation.render) if navigation
+                end)
+              end
+            end
+          end
+        end
+
+        # The default attributes for the breadcrumbs
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-header', data: { module: 'govuk-header' } }.freeze
+
+        private
+
+        # Generates the logo for header
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def header_logo
+          tag.div(class: 'govuk-header__logo') do
+            link_to(options[:homepage_url], class: 'govuk-header__link govuk-header__link--homepage') do
+              concat(tag.span(class: 'govuk-header__logotype') do
+                concat(tag.svg(class: 'govuk-header__logotype-crown', xmlns: 'http://www.w3.org/2000/svg', height: '30', width: '36', aria: { hidden: 'true' }, focusable: 'false', viewBox: '0 0 132 97') do
+                  tag.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')
+                end)
+                concat(tag.span('GOV.UK', class: 'govuk-header__logotype-text'))
+              end)
+              concat(tag.span(options[:product_name], class: 'govuk-header__product-name')) if options[:product_name]
+            end
+          end
+        end
+
+        # Generates the service name section
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def header_service_name
+          if service[:href]
+            link_to(service[:name], service[:href], class: 'govuk-header__link govuk-header__service-name')
+          else
+            tag.span(service[:name], class: 'govuk-header__service-name')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/hint.rb

@@ -0,0 +1,49 @@
+require_relative '../base'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Hint
+      #
+      # This is used to generate the hint text component from the Government Design Systems
+      #
+      # @!attribute [r] text
+      #   @return [String] Text for the hint
+
+      class Hint < Base
+        private
+
+        attr_reader :text
+
+        public
+
+        # @param text [String] the hint text.
+        #                      If nil, then a block will be rendered
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the hint HTML
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(text: nil, **options)
+          super(**options)
+
+          @text = text
+        end
+
+        # Generates the HTML for the GOV.UK Hint component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            text || yield
+          end
+        end
+
+        # The default attributes for the hint
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-hint' }.freeze
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/inset_text.rb

@@ -0,0 +1,52 @@
+require_relative '../base'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Inset Text
+      #
+      # This is used to generate the inset text component from the
+      # {https://design-system.service.gov.uk/components/inset-text GDS - Components - Inset text}
+      #
+      # @!attribute [r] text
+      #   @return [String] Text for the inset text
+
+      class InsetText < Base
+        private
+
+        attr_reader :text
+
+        public
+
+        # @param text [String] text to use within the inset text component.
+        #                      If nil, then a block will be rendered
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the inset text HTML
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(text: nil, **options)
+          super(**options)
+
+          @text = text
+        end
+
+        # Generates the HTML for the GOV.UK Inset text component
+        #
+        # @yield HTML that will be contained within the inset text div. Ignored if inset text is given
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.div(**options[:attributes]) do
+            text || yield
+          end
+        end
+
+        # The default attributes for the inset text
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-inset-text' }.freeze
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/label.rb

@@ -0,0 +1,85 @@
+require_relative '../base'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Label
+      #
+      # This is used to generate the label component from the Government Design Systems
+      #
+      # @!attribute [r] attribute
+      #   @return [String, Symbol] Attribute of the input that requires a label
+      # @!attribute [r] text
+      #   @return [String] Text for the label
+      # @!attribute [r] form
+      #   @return [ActionView::Helpers::FormBuilder] Form builder used to create the label
+
+      class Label < Base
+        private
+
+        attr_reader :attribute, :text, :form
+
+        public
+
+        # @param attribute [String, Symbol] the attribute of the input that requires a label
+        # @param text [String] (nil) the text for the label
+        #                            If nil, then a block will be rendered
+        # @param form [ActionView::Helpers::FormBuilder] (nil) optional form builder used to create the label
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the label HTML
+        # @option options [Boolean] :is_page_heading (false) if the label is also the heading it will rendered in a h1
+        # @option options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+        def initialize(attribute:, text: nil, form: nil, **options)
+          super(**options)
+
+          @attribute = attribute
+          @text = text
+          @form = form
+        end
+
+        # Generates the HTML for the GOV.UK label component
+        #
+        # @yield HTML that will be generated for the label
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render(&block)
+          if options[:is_page_heading]
+            tag.h1(class: 'govuk-label-wrapper') do
+              label_html(&block)
+            end
+          else
+            label_html(&block)
+          end
+        end
+
+        # The default attributes for the label
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-label' }.freeze
+
+        private
+
+        # Generates the HTML for the label.
+        # If +:form+ attribute is present, it will be used to generate the label tag
+        #
+        # @yield HTML that will be used in the label. Ignored if text is passed.
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def label_html
+          if form
+            form.label(attribute, **options[:attributes]) do
+              text || yield
+            end
+          else
+            label_tag(attribute, **options[:attributes]) do
+              text || yield
+            end
+          end
+        end
+      end
+    end
+  end
+end