katalyst-govuk-formbuilder 1.21.1 → 1.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f00959f1768249d99d69e4d492dd9cf62158c0ffcbad3678c4217b9bb55857b6
-  data.tar.gz: 85d1fd29983d9c4fe35af50a70bedd043e38a328a8db1f25a9411af546cef13c
+  metadata.gz: 7e8a404c5a4d6164193e63c33a4e1f418544d22f73641461a37f5f4db27c5a5e
+  data.tar.gz: d0bc19a8376c942a170596b5c790acab1415e5d8455e1a69b653f889b977c4b6
 SHA512:
-  metadata.gz: 84faeab7a88f4f97d844020a3998926a75de6f89265e5bcff7ba95aa466a44c2d1870d69ace02a72a3fb67189c3523233c50d00be15d2b2f2c3b9502914ce6a2
-  data.tar.gz: 13738c0739b4e0af4b0f8989fc219632c2cd24719c0c6e0407e47d689f19c8a9b4a7f203f6f35296ba35bf4fa2f4280119bc19ba0091fc92de56ef6b1e038c47
+  metadata.gz: 5aab818761b6138c58eb45c9126c037294434fb23beb41f1c31e1573498fbce83df7a47372d75b73db1ec79dbfab6468f476ab7db0c68377a12aa5e242bb12fc
+  data.tar.gz: cab0ba669c000a4239b7eb4e8d22ca45ceb051e736982bbffc8d0cdc4eec2ab745fef2cd0608c834f265adde01accb716f08393c6d34ebbd9fa8571eaec99038

data/lib/katalyst/govuk/form_builder/builder.rb

@@ -91,6 +91,51 @@ module Katalyst
           end
         end
 
+        # Generates a input of type +time+
+        #
+        # @param attribute_name [Symbol] The name of the attribute
+        # @param hint [Hash,Proc] The content of the hint. No hint will be added if 'text' is left +nil+. When a +Proc+
+        #   is supplied the hint will be wrapped in a +div+ instead of a +span+
+        # @option hint text [String] the hint text
+        # @option hint kwargs [Hash] additional arguments are applied as attributes to the hint
+        # @param width [Integer,String] sets the width of the input, can be +2+, +3+ +4+, +5+, +10+ or +20+ characters
+        #   or +one-quarter+, +one-third+, +one-half+, +two-thirds+ or +full+ width of the container
+        # @param extra_letter_spacing [Boolean] when true adds space between characters to increase the readability of
+        #   sequences of letters and numbers. Defaults to +false+.
+        # @param label [Hash,Proc] configures or sets the associated label content
+        # @option label text [String] the label text
+        # @option label size [String] the size of the label font, can be +xl+, +l+, +m+, +s+ or nil
+        # @option label tag [Symbol,String] the label's wrapper tag, intended to allow labels to act as page headings
+        # @option label hidden [Boolean] control the visability of the label. Hidden labels are read by screenreaders.
+        # @option label kwargs [Hash] additional arguments are applied as attributes on the +label+ element
+        # @param caption [Hash] configures or sets the caption content which is inserted above the label
+        # @option caption text [String] the caption text
+        # @option caption size [String] the size of the caption, can be +xl+, +l+ or +m+. Defaults to +m+
+        # @option caption kwargs [Hash] additional arguments are applied as attributes on the caption +span+ element
+        # @option kwargs [Hash] kwargs additional arguments are applied as attributes to the +input+ element
+        # @param form_group [Hash] configures the form group
+        # @option form_group kwargs [Hash] additional attributes added to the form group
+        # @param prefix_text [String] the text placed before the input. No prefix will be added if left +nil+
+        # @param suffix_text [String] the text placed after the input. No suffix will be added if left +nil+
+        # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
+        # @return [ActiveSupport::SafeBuffer] HTML output
+        # @see https://design-system.service.gov.uk/components/text-input/ GOV.UK Text input
+        # @see https://design-system.service.gov.uk/styles/typography/#headings-with-captions Headings with captions
+        #
+        # @example A required time field with a placeholder
+        #   = f.govuk_time_field :time,
+        #     label: { text: 'Event time' },
+        #     hint: { text: 'Assumes the server timezone' },
+        #     required: true,
+        #     placeholder: '08:00am'
+        #
+        def govuk_time_field(attribute_name, hint: {}, label: {}, caption: {}, width: nil, extra_letter_spacing: false,
+                             form_group: {}, prefix_text: nil, suffix_text: nil, **, &)
+          Elements::Time.new(self, object_name, attribute_name,
+                             hint:, label:, caption:, width:, extra_letter_spacing:, form_group:, prefix_text:,
+                             suffix_text:, **, &).html
+        end
+
         # Generates a check box within a fieldset to be used as a boolean toggle for a single attribute.
         # The values are 1 (toggled on), and 0 (toggled off).
         #

data/lib/katalyst/govuk/form_builder/elements/time.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "govuk_design_system_formbuilder"
+
+module Katalyst
+  module GOVUK
+    module FormBuilder
+      module Elements
+        class Time < GOVUKDesignSystemFormBuilder::Base
+          include GOVUKDesignSystemFormBuilder::Traits::Input
+          include GOVUKDesignSystemFormBuilder::Traits::Error
+          include GOVUKDesignSystemFormBuilder::Traits::Hint
+          include GOVUKDesignSystemFormBuilder::Traits::Label
+          include GOVUKDesignSystemFormBuilder::Traits::Supplemental
+          include GOVUKDesignSystemFormBuilder::Traits::HTMLAttributes
+
+          private
+
+          def builder_method
+            :time_field
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-govuk-formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.21.1
+  version: 1.22.0
 platform: ruby
 authors:
 - Katalyst Interactive
@@ -52,6 +52,7 @@ files:
 - lib/katalyst/govuk/form_builder/elements/label.rb
 - lib/katalyst/govuk/form_builder/elements/legend.rb
 - lib/katalyst/govuk/form_builder/elements/rich_text_area.rb
+- lib/katalyst/govuk/form_builder/elements/time.rb
 - lib/katalyst/govuk/form_builder/engine.rb
 - lib/katalyst/govuk/form_builder/extensions.rb
 - lib/katalyst/govuk/form_builder/frontend.rb