sdr_view_components 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e3803526ec08ea8786418750aded1cefd281a20bbc9d9911fe8b684ffaceb25
-  data.tar.gz: 1db98361a27b37e781a0bb8a17e4e7e913ee22f455ff6b97aaacd115ea5292bc
+  metadata.gz: 961d9463dcd2c8acb582e5e97f18c31fff4aa9ec1520456351f6e7aaef232a7e
+  data.tar.gz: 6f75438e29d6c7571cdbd54aef23966323fcc85a31b757e777489f4babd5a59c
 SHA512:
-  metadata.gz: 7d2e42055690b2e650f841d791f09d122b879b8ccf040f7c25911e080ad91c9221e4c141f1c68720491c9dad77dc50308d3401f58dbe13796a6a3bfad0c32ba6
-  data.tar.gz: 35e9aee8a9ce3642e04db16e953307c54fcb41f8079fdb4872424f461a43289f1a6cd465be00739a6646213874932c778de351d1db58dd61b55ef473eb65d20d
+  metadata.gz: 8de70284a279feae9500bdeb0dabef38e67a8f0433b67d2dfeccbc34f72b78c7703061a3e3fb7ad234148d6d2c0f9738953e01554bed19bfc5f69ce6b13264ce
+  data.tar.gz: 8be397da249a2e0871f80f78e9ae3ee65d237c5437ee3e79dc20b4db9548403bd7802f0f1b397a4d350793f8c688c4e6b08099439098c44b9874ffe924462743

data/README.md

@@ -38,7 +38,7 @@ Supported header variations are `:dark`, `:light`, and `:white` (default is `:li
   <% end %>
   <% header.with_primary_navigation_link do %>
     <%= render SdrViewComponents::Elements::Navigation::DropdownMenuComponent.new(text: 'Logged in: amcollie-preview-dropdown') do |dropdown| %>
-      <% dropdown.with_link do %>
+      <% dropdown.with_item do %>
         <%= link_to 'Logout', '/Shibboleth.sso/Logout', class: 'dropdown-item' %>
       <% end %>
     <% end %>
@@ -63,6 +63,51 @@ The `:dark` variation supports providing an rgb value via the `background_color`
 
 By default, the SUL Rosette is included in the header, this can be disabled by setting `rosette: false` in the parameter list when instantiating the header.
 
+### Form components
+
+SdrViewComponents provides a wrapper for several [ActionView::Helper::Tags](https://api.rubyonrails.org/v8.1.1/classes/ActionView/Helpers/Tags.html).
+
+Currently supported tags:
+- Checkbox
+- File
+- RadioButton
+- TextArea
+- TextField
+
+#### Composed form components
+
+SdrViewComponents provides fully composed (label, help text, and validation) instances of the above components as:
+
+- SdrViewComponents::Forms::CheckboxComponent
+- SdrViewComponents::Forms::FileComponent
+- SdrViewComponents::Forms::RadioButtonComponent
+- SdrViewComponents::Forms::TextAreaComponent
+- SdrViewComponents::Forms::TextFieldComponent
+
+At a minimum, each of these components must be provided wih the `form:` and `field_name:` parameters. Additionally, you can provide prefixed parameters that will be passed the the individual parts of the components:
+
+- `container_`: is used to pass arguments to the surrounding `div` for the component.
+- `input_`: is used to pass arguments to the actual input component.
+- `label_`: is used to pass arguments to the label for the component.
+- `help_`: is used to pass arguments to the help text available for the component.
+- `error_`: is used to pass arguments to the validation output of the component.
+
+TODO:
+- Outline the supported params for each prefix
+- Provide an example instantiation and output
+
+#### Basic form components
+
+Each of the supported components above uses the provided "basic" components:
+
+- SdrViewComponents::Forms::BasicCheckboxComponent
+- SdrViewComponents::Forms::BasicFileComponent
+- SdrViewComponents::Forms::BasicRadioButtonComponent
+- SdrViewComponents::Forms::BasicTextAreaComponent
+- SdrViewComponents::Forms::BasicTextFieldComponent
+
+At a minimum, each of these components must be provided wih the `form:` and `field_name:` parameters. Additionally, you can provide additional parameters that will be passed to the standard ActionView::Helpers::Tag.
+
 ### General usage:
 
 ```

data/app/components/sdr_view_components/elements/navigation/dropdown_menu_component.html.erb

@@ -6,7 +6,7 @@
     <%= text %>
   </button>
   <ul class="dropdown-menu">
-    <%= items.map do |item| %>
+    <% items.each do |item| %>
       <li><%= item %></li>
     <% end %>
   </ul>

data/app/components/sdr_view_components/forms/basic_checkbox_component.rb

@@ -4,18 +4,17 @@ module SdrViewComponents
   module Forms
     # Component for form checkbox field
     class BasicCheckboxComponent < BaseComponent
-      def initialize(form:, field_name:, data: nil, **args)
+      def initialize(form:, field_name:, **args)
         @form = form
         @field_name = field_name
         @args = args
-        @data = data
         super()
       end
 
-      attr_reader :args, :data, :form, :field_name, :value
+      attr_reader :args, :form, :field_name
 
       def call
-        form.check_box field_name, data:, **args
+        form.check_box field_name, **args
       end
     end
   end

data/app/components/sdr_view_components/forms/basic_file_component.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Forms
+    # Component for form file field
+    class BasicFileComponent < BaseComponent
+      def initialize(form:, field_name:, **args)
+        @form = form
+        @field_name = field_name
+        @args = args
+        super()
+      end
+
+      attr_reader :args, :form, :field_name
+
+      def call
+        form.file_field field_name, **args
+      end
+    end
+  end
+end

data/app/components/sdr_view_components/forms/basic_radio_button_component.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Forms
+    # Component for form radio button field
+    class BasicRadioButtonComponent < BaseComponent
+      def initialize(form:, field_name:, value:, **args)
+        @form = form
+        @field_name = field_name
+        @value = value
+        @args = args
+        super()
+      end
+
+      attr_reader :args, :form, :field_name, :value
+
+      def call
+        form.radio_button field_name, value, **args
+      end
+    end
+  end
+end

data/app/components/sdr_view_components/forms/basic_text_area_component.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Forms
+    # Component for form text area field
+    class BasicTextAreaComponent < BaseComponent
+      def initialize(form:, field_name:, **args)
+        @form = form
+        @field_name = field_name
+        @args = args
+        super()
+      end
+
+      attr_reader :args, :form, :field_name
+
+      def call
+        form.text_area field_name, **args
+      end
+    end
+  end
+end

data/app/components/sdr_view_components/forms/basic_text_field_component.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Forms
+    # Component for form text field
+    class BasicTextFieldComponent < BaseComponent
+      def initialize(form:, field_name:, **args)
+        @form = form
+        @field_name = field_name
+        @args = args
+        super()
+      end
+
+      attr_reader :args, :form, :field_name
+
+      def call
+        form.text_field field_name, **args
+      end
+    end
+  end
+end

data/app/components/sdr_view_components/forms/checkbox_component.rb

@@ -11,12 +11,8 @@ module SdrViewComponents
         super
       end
 
-      attr_reader :value
-
-      # The component must implement a `default_component` method in order
-      # to render in the component slot of the FieldComponent.
-      def default_component
-        render SdrViewComponents::Forms::BasicCheckboxComponent.new(form:, field_name:, data:, **input_args)
+      def input_component
+        SdrViewComponents::Forms::BasicCheckboxComponent.new(form:, field_name:, **input_args)
       end
     end
   end

data/app/components/sdr_view_components/forms/field_component.html.erb

@@ -1,6 +1,6 @@
-<%= tag.div container_args do %>
-  <%= component %>
+<%= tag.div **container_args do %>
   <%= render SdrViewComponents::Forms::LabelComponent.new(form:, field_name:, **label_args) %>
   <%= render SdrViewComponents::Forms::HelpTextComponent.new(**help_text_args) %>
-  <%= render SdrViewComponents::Forms::InvalidFeedbackComponent.new(form:, field_name:) %>
+  <%= render input_component %>
+  <%= render SdrViewComponents::Forms::InvalidFeedbackComponent.new(form:, field_name:, **error_args) %>
 <% end %>

data/app/components/sdr_view_components/forms/field_component.rb

@@ -4,8 +4,6 @@ module SdrViewComponents
   module Forms
     # Base component for all form fields.
     class FieldComponent < BaseComponent
-      renders_one :component
-
       def initialize(**args)
         @args = args
         super()
@@ -13,38 +11,53 @@ module SdrViewComponents
 
       attr_reader :args
 
-      def input_args
-        args_for(args:, prefix: 'input_').merge({ aria: field_aria, data: })
+      # Any component that inherits from FieldComponent must implement this method
+      # or provide its own template.
+      def input_component
+        raise NotImplementedError
       end
 
+      ##########################################################################
+      # Argument builders for the various sub-components of a form field.
+      # These methods extract arguments from the main args hash
+      # based on a prefix convention.
+
+      # Returns a hash of arguments for the container element.
+      # Prefix and argument with 'container_' in order for it to be passed to
+      # the container div. (i.e. :container_class will be passed as :class to
+      # the container div)
       def container_args
         args_for(args:, prefix: 'container_')
       end
 
-      def data
-        @data ||= args.delete(:data) || {}
+      # Returns a hash of arguments for the error element.
+      # Prefix and argument with 'error_' in order for it to be passed to
+      # to the invalid feedback element.
+      def error_args
+        args_for(args:, prefix: 'error_')
       end
 
-      def error_aria
-        InvalidFeedbackSupport.arias_for(field_name:, form:).tap do |arias|
-          arias[:describedby] = merge_actions(arias[:describedby], help_text_id) if help_text_args[:text].present?
-        end
+      # Returns a hash of arguments for the help text element.
+      # Prefix and argument with 'help_' in order for it to be passed to
+      # to the help text element.
+      def help_text_args
+        args_for(args:, prefix: 'help_').merge({ id: help_text_id })
       end
 
-      def error_classes
-        merge_classes(args.fetch(:error_classes, []))
+      # Returns a hash of arguments for the input element.
+      # Prefix and argument with 'input_' in order for it to be passed to
+      # the input element.
+      def input_args
+        args_for(args:, prefix: 'input_').merge({ aria: field_aria })
       end
 
-      def field_aria
-        error_aria.tap do |arias|
-          # Set aria-required if we want to indicate required, but the field
-          # does not actually have a required attribute
-          #
-          # This is used for collection/work forms where we do server-side
-          # validation and don't want to block form submission on empty fields
-          arias[:required] = true if @mark_required
-        end
+      # Returns a hash of arguments for the label element.
+      # Prefix and argument with 'label_' in order for it to be passed to
+      # the label element.
+      def label_args
+        args_for(args:, prefix: 'label_')
       end
+      ##########################################################################
 
       def field_name
         @field_name ||= args.delete(:field_name)
@@ -54,21 +67,28 @@ module SdrViewComponents
         @form ||= args.delete(:form)
       end
 
-      def help_text_args
-        args_for(args:, prefix: 'help_').merge({
-                                                 id: help_text_id
-                                               })
-      end
+      private
 
-      def help_text_id
-        @help_text_id ||= form.field_id(field_name, 'help')
+      def error_aria
+        InvalidFeedbackSupport.arias_for(field_name:, form:).tap do |arias|
+          arias[:describedby] = merge_actions(arias[:describedby], help_text_id) if help_text_args[:text].present?
+        end
       end
 
-      def label_args
-        args_for(args:, prefix: 'label_')
+      def field_aria
+        error_aria.tap do |arias|
+          # Set aria-required if we want to indicate required, but the field
+          # does not actually have a required attribute
+          #
+          # This is used for collection/work forms where we do server-side
+          # validation and don't want to block form submission on empty fields
+          arias[:required] = true if @args[:mark_required]
+        end
       end
 
-      delegate :id, to: :form, prefix: true
+      def help_text_id
+        @help_text_id ||= form.field_id(field_name, 'help')
+      end
     end
   end
 end

data/app/components/sdr_view_components/forms/file_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Forms
+    # Component for form file field
+    class FileComponent < FieldComponent
+      def initialize(**args)
+        args[:container_class] = merge_classes('form-file', args[:container_class])
+        args[:input_class] = merge_classes('form-file-input', args[:input_class])
+        args[:label_default_class] = merge_classes('form-file-label', args[:input_class])
+        super
+      end
+
+      def input_component
+        SdrViewComponents::Forms::BasicFileComponent.new(form:, field_name:, **input_args)
+      end
+    end
+  end
+end

data/app/components/sdr_view_components/forms/radio_button_component.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Forms
+    # Component for form radio button field
+    class RadioButtonComponent < FieldComponent
+      def initialize(**args)
+        args[:container_class] = merge_classes('form-check', args[:container_class])
+        args[:input_class] = merge_classes('form-check-input', args[:input_class])
+        args[:label_default_class] = merge_classes('form-check-label', args[:input_class])
+        super
+      end
+
+      def input_component
+        SdrViewComponents::Forms::BasicRadioButtonComponent.new(form:, field_name:, **input_args)
+      end
+    end
+  end
+end

data/app/components/sdr_view_components/forms/text_area_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Forms
+    # Component for form text area field
+    class TextAreaComponent < FieldComponent
+      def initialize(**args)
+        args[:container_class] = merge_classes('form-text', args[:container_class])
+        args[:input_class] = merge_classes('form-control', args[:input_class])
+        super
+      end
+
+      def input_component
+        SdrViewComponents::Forms::BasicTextAreaComponent.new(form:, field_name:, **input_args)
+      end
+    end
+  end
+end

data/app/components/sdr_view_components/forms/text_field_component.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Forms
+    # Component for form text field
+    class TextFieldComponent < FieldComponent
+      def initialize(**args)
+        args[:container_class] = merge_classes('field-container', args[:container_class])
+        args[:input_class] = merge_classes('form-control', args[:input_class])
+        super
+      end
+
+      def input_component
+        SdrViewComponents::Forms::BasicTextFieldComponent.new(form:, field_name:, **input_args)
+      end
+    end
+  end
+end

data/lib/sdr_view_components/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SdrViewComponents
-  VERSION = '0.1.4'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sdr_view_components
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Aaron Collier
 bindir: bin
 cert_chain: []
-date: 2025-12-10 00:00:00.000000000 Z
+date: 2025-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -86,19 +86,26 @@ files:
 - app/components/sdr_view_components/elements/tooltip_component.html.erb
 - app/components/sdr_view_components/elements/tooltip_component.rb
 - app/components/sdr_view_components/forms/basic_checkbox_component.rb
+- app/components/sdr_view_components/forms/basic_file_component.rb
+- app/components/sdr_view_components/forms/basic_radio_button_component.rb
+- app/components/sdr_view_components/forms/basic_text_area_component.rb
+- app/components/sdr_view_components/forms/basic_text_field_component.rb
 - app/components/sdr_view_components/forms/button_component.rb
-- app/components/sdr_view_components/forms/checkbox_component.html.erb
 - app/components/sdr_view_components/forms/checkbox_component.rb
 - app/components/sdr_view_components/forms/field_component.html.erb
 - app/components/sdr_view_components/forms/field_component.rb
+- app/components/sdr_view_components/forms/file_component.rb
 - app/components/sdr_view_components/forms/help_text_component.html.erb
 - app/components/sdr_view_components/forms/help_text_component.rb
 - app/components/sdr_view_components/forms/invalid_feedback_component.rb
 - app/components/sdr_view_components/forms/invalid_feedback_support.rb
 - app/components/sdr_view_components/forms/label_component.html.erb
 - app/components/sdr_view_components/forms/label_component.rb
+- app/components/sdr_view_components/forms/radio_button_component.rb
 - app/components/sdr_view_components/forms/submit_component.html.erb
 - app/components/sdr_view_components/forms/submit_component.rb
+- app/components/sdr_view_components/forms/text_area_component.rb
+- app/components/sdr_view_components/forms/text_field_component.rb
 - app/components/sdr_view_components/forms/toggle_component.html.erb
 - app/components/sdr_view_components/forms/toggle_component.rb
 - app/components/sdr_view_components/forms/toggle_option_component.html.erb

data/app/components/sdr_view_components/forms/checkbox_component.html.erb

@@ -1,6 +0,0 @@
-<%= tag.div container_args do %>
-  <%= render SdrViewComponents::Forms::BasicCheckboxComponent.new(form:, field_name:, data:, **input_args) %>
-  <%= render SdrViewComponents::Forms::LabelComponent.new(form:, field_name:, **label_args) %>
-  <%= render SdrViewComponents::Forms::HelpTextComponent.new(**help_text_args) %>
-  <%= render SdrViewComponents::Forms::InvalidFeedbackComponent.new(form:, field_name:) %>
-<% end %>