katalyst-govuk-formbuilder 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55dbcc46de912ec5d085cec6a9012f2c9519fab9faac2e75dc4db78b9fb11c8b
-  data.tar.gz: 33c0503e13126fdf81e7bc749d51137793e56c264b5866ff22416cc135cf1eb4
+  metadata.gz: c6480175ffd7ac7e718126f6b3e41314693c56cf87614d8691fb180adc7048fb
+  data.tar.gz: 67d870ab5c506e5dcfb9e85a599f1940085457963d04f114f8db11571eba0b9f
 SHA512:
-  metadata.gz: 26f134d6a93f1cf1c1569037a667818ffda1471d5ab5c1a1a71a0a026ed2361d6576556522d6c1902a59e55cbb4373ecef6c874c7a09bdab7d858511973f9e7e
-  data.tar.gz: 79abd30427a6b08a18bdff4254d9e95749ca3021a9071ae68d3f9a79c46954c3d8204c8a5064efb4e89957917e40886111757505111ec0da6549474dd81bead2
+  metadata.gz: e6b24e8b2adbd0415313a030d1362b0b8739525ef1c0996dfb0d3f8dc4f18e040cb380ac9f4de090a4e9c22b961b6f2e2cd02701e3a5370df0c280b08b151f6a
+  data.tar.gz: 7bfea8bff24edd542f4a786becbefc587f3ba50e529c8a08f5d8469a12c404b75206cfeaf8ca33e4a0dd7d619741d7403da4324fe34efdf0a1a6fcd8c0854291

data/lib/govuk_design_system_formbuilder/elements/rich_text_area.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require "govuk_design_system_formbuilder"
+
+module GOVUKDesignSystemFormBuilder
+  module Elements
+    class RichTextArea < Base
+      using PrefixableArray
+
+      include Traits::Error
+      include Traits::Hint
+      include Traits::Label
+      include Traits::Supplemental
+      include Traits::HTMLAttributes
+      include Traits::HTMLClasses
+
+      def initialize(builder, object_name, attribute_name, hint:, label:, caption:, form_group:, **kwargs, &block)
+        super(builder, object_name, attribute_name, &block)
+
+        @label           = label
+        @caption         = caption
+        @hint            = hint
+        @form_group      = form_group
+        @html_attributes = kwargs
+      end
+
+      def html
+        Containers::FormGroup.new(*bound, **@form_group).html do
+          safe_join([label_element, supplemental_content, hint_element, error_element, rich_text_area])
+        end
+      end
+
+      private
+
+      def rich_text_area
+        @builder.rich_text_area(@attribute_name, **attributes(@html_attributes))
+      end
+
+      def classes
+        build_classes(%(richtextarea), %(richtextarea--error) => has_errors?).prefix(brand)
+      end
+
+      def options
+        {
+          id:    field_id(link_errors: true),
+          class: classes,
+          aria:  { describedby: combine_references(hint_id, error_id, supplemental_id) },
+        }
+      end
+    end
+  end
+end
+
+module GOVUKDesignSystemFormBuilder
+  module Builder
+    delegate :config, to: GOVUKDesignSystemFormBuilder
+
+    # Generates a pair of +trix-toolbar+ and +trix-editor+ elements with a label, optional hint. Requires action-text to
+    # be correctly setup in the application
+    #
+    # @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 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 visibility of the label. Hidden labels will still be read by screen
+    #   readers
+    # @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 +trix-editor+ element. This is
+    #   picked up and handled by the action-text gem
+    # @param form_group [Hash] configures the form group
+    # @option form_group classes [Array,String] sets the form group's classes
+    # @option form_group kwargs [Hash] additional attributes added to the form group
+    # @param block [Block] arbitrary HTML that will be rendered between the hint and the input
+    # @return [ActiveSupport::SafeBuffer] HTML output
+    #
+    # @example A rich text area with injected content
+    #   = f.govuk_rich_text_area :description,
+    #     label: { text: 'Where did the incident take place?' } do
+    #
+    #     p.govuk-inset-text
+    #       | If you don't know exactly leave this section blank
+    #
+    # @example A rich text area with the label supplied as a proc
+    #   = f.govuk_rich_text_area :instructions,
+    #     label: -> { tag.h3("How do you set it up?") }
+    #
+    # @example A rich text area with a custom direct upload url and a custom stimulus controller
+    #   = f.govuk_rich_text_area :description,
+    #     data: {
+    #             direct_upload_url: direct_uploads_url,
+    #             controller:        "content--editor--trix",
+    #             action:            "trix-initialize->content--editor--trix#trixInitialize",
+    #           }
+    #
+    def govuk_rich_text_area(attribute_name, hint: {}, label: {}, caption: {}, form_group: {}, **kwargs, &block)
+      Elements::RichTextArea.new(self, object_name, attribute_name, hint: hint, label: label, caption: caption, form_group: form_group, **kwargs, &block).html
+    end
+  end
+end

data/lib/katalyst/govuk/formbuilder/version.rb

@@ -1,7 +1,7 @@
 module Katalyst
   module GOVUK
     module Formbuilder
-      VERSION = "1.1.1"
+      VERSION = "1.2.0"
     end
   end
 end

data/lib/katalyst/govuk/formbuilder.rb

@@ -1,4 +1,5 @@
 require "govuk_design_system_formbuilder"
+require "govuk_design_system_formbuilder/elements/rich_text_area"
 
 require "katalyst/govuk/formbuilder/engine"
 require "katalyst/govuk/formbuilder/frontend"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: katalyst-govuk-formbuilder
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Katalyst Interactive
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_design_system_formbuilder
@@ -38,6 +38,7 @@ files:
 - app/assets/javascripts/katalyst/govuk/formbuilder.js
 - app/assets/javascripts/katalyst/govuk/formbuilder.min.js
 - config/importmap.rb
+- lib/govuk_design_system_formbuilder/elements/rich_text_area.rb
 - lib/katalyst/govuk/formbuilder.rb
 - lib/katalyst/govuk/formbuilder/engine.rb
 - lib/katalyst/govuk/formbuilder/frontend.rb