sdr_view_components 0.8.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a89b7fb8bfdf855c3cd22ea788658b10738f042a3900b5475b7edaa9f54bac5
-  data.tar.gz: acd6997c3b3781ec16a49f3ee029d58211f1ed99e980f9502e06c7621b6e227f
+  metadata.gz: ef8577c7ba2659565cc9bc0fc7abde0dc81581d56d4ca04d0fd97c6af6bfa152
+  data.tar.gz: 762e2ab51b230c2c65620d63f9521adc652bd8dd177307066a4d37c2614ccab9
 SHA512:
-  metadata.gz: 3d076c42c048b050edd2ed57655e9203a3a534fbaa57008eed50cbcf2572f78efc3c2edf61558f542446b9b6fb413682b40eec5e42ec5110bc20f012c254fc0c
-  data.tar.gz: b398eb960a67d533b2b7ca2676c71fff58a5dba641acc2d0c1a9ef56b4ed6d79952df88f1e18a6d0714ae38c0b0e2001297446ec0cdb76bd2d62e69331c299a4
+  metadata.gz: 5afcd584845fcd490a6bb7a371c59ce5d890e7f37dafa66e601b3720d887c3af65a75f973e597836903386a1988562e94bf719ef7c396e51f03f7afe872f9ed7
+  data.tar.gz: 0a53d768a9355718afda4fa06c609b5ee5d61563637c5bb8ad52443a4070eb61c203a02b0f357db8f6f3b64f0d1b0981afaecbb67830a2709430e768f8410214

data/app/components/component_support/button_support.rb

@@ -3,11 +3,12 @@
 module ComponentSupport
   # General support for buttons.
   class ButtonSupport
-    def self.classes(variant: nil, size: nil, classes: [], bordered: true)
+    def self.classes(variant: nil, size: nil, classes: [], bordered: true, disabled: false)
       ComponentSupport::CssClasses.merge('btn',
                                          variant ? "btn-#{variant}" : nil,
                                          size ? "btn-#{size}" : nil,
                                          bordered ? nil : %w[border border-0],
+                                         disabled ? 'disabled' : nil,
                                          classes)
     end
   end

data/app/components/sdr_view_components/elements/button_component.rb

@@ -4,13 +4,14 @@ module SdrViewComponents
   module Elements
     # Generic button component
     class ButtonComponent < BaseComponent
-      def initialize(label: nil, classes: [], variant: nil, size: nil, bordered: true, **options) # rubocop:disable Metrics/ParameterLists
+      def initialize(label: nil, classes: [], variant: nil, size: nil, bordered: true, disabled: false, **options) # rubocop:disable Metrics/ParameterLists
         @label = label
         @classes = classes
         @variant = variant
         @size = size
         @options = options
         @bordered = bordered
+        @disabled = disabled
         super()
       end
 
@@ -19,7 +20,7 @@ module SdrViewComponents
       def call
         tag.button(
           class: ComponentSupport::ButtonSupport.classes(variant: @variant, size: @size, classes: @classes,
-                                                         bordered: @bordered),
+                                                         bordered: @bordered, disabled: @disabled),
           type: 'button',
           **options
         ) do

data/app/components/sdr_view_components/elements/button_form_component.rb

@@ -4,8 +4,8 @@ module SdrViewComponents
   module Elements
     # Component for a button that is wrapped in a form
     class ButtonFormComponent < BaseComponent
-      def initialize(link:, label: nil, variant: :primary, classes: [], method: :get, confirm: nil, # rubocop:disable Metrics/ParameterLists
-                     top: true, data: {})
+      def initialize(link:, label: nil, variant: :primary, classes: [], method: :get, confirm: nil, # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+                     top: true, data: {}, disabled: false, params: {})
         @link = link
         @label = label
         @variant = variant
@@ -14,15 +14,18 @@ module SdrViewComponents
         @confirm = confirm
         @top = top
         @data = data
+        @disabled = disabled
+        @params = params
         super()
       end
 
-      attr_reader :link
+      attr_reader :link, :params
 
       def call
         button_to(link, method: @method,
-                        class: ComponentSupport::ButtonSupport.classes(variant: @variant, classes:),
-                        form: { data: }) do
+                        class: ComponentSupport::ButtonSupport.classes(variant: @variant, classes:, disabled: @disabled),
+                        form: { data: },
+                        params:) do
           @label || content
         end
       end

data/app/components/sdr_view_components/elements/button_link_component.rb

@@ -4,7 +4,8 @@ module SdrViewComponents
   module Elements
     # Component for a button that is a link
     class ButtonLinkComponent < BaseComponent
-      def initialize(link:, label: nil, variant: :primary, classes: [], bordered: true, size: nil, **options) # rubocop:disable Metrics/ParameterLists
+      def initialize(link:, label: nil, variant: :primary, classes: [], bordered: true, size: nil, # rubocop:disable Metrics/ParameterLists
+                     disabled: false, **options)
         @link = link
         @label = label
         @variant = variant
@@ -12,6 +13,7 @@ module SdrViewComponents
         @classes = classes
         @bordered = bordered
         @size = size
+        @disabled = disabled
         super()
       end
 
@@ -19,7 +21,8 @@ module SdrViewComponents
 
       def call
         link_to(link, class: ComponentSupport::ButtonSupport.classes(classes: @classes, variant: @variant,
-                                                                     bordered: @bordered, size: @size),
+                                                                     bordered: @bordered, size: @size,
+                                                                     disabled: @disabled),
                       **@options) do
           label || content
         end

data/app/components/sdr_view_components/elements/icon_button_component.html.erb

@@ -1,3 +1,3 @@
-<%= render SdrViewComponents::Elements::ButtonComponent.new(classes:, variant: :'outline-primary', **options) do %>
+<%= render SdrViewComponents::Elements::ButtonComponent.new(classes:, variant: :'outline-primary', disabled:, **options) do %>
   <%= button_icon %><span class="visually-hidden"><%= label %></span>
 <% end %>

data/app/components/sdr_view_components/elements/icon_button_component.rb

@@ -4,10 +4,12 @@ module SdrViewComponents
   module Elements
     # Component for a button which is an icon
     class IconButtonComponent < BaseComponent
-      def initialize(icon:, label:, classes: [], **options)
+      def initialize(icon:, label:, classes: [], icon_classes: [], disabled: false, **options) # rubocop:disable Metrics/ParameterLists
         @icon = icon
         @label = label
         @classes = classes
+        @icon_classes = icon_classes
+        @disabled = disabled
         @options = options
         super()
       end
@@ -16,14 +18,14 @@ module SdrViewComponents
         raise SdrViewComponents::Error::UnknownComponentIcon, "Unknown icon type: #{@icon}" unless button_icon?
       end
 
-      attr_reader :label, :options
+      attr_reader :label, :options, :disabled
 
       def classes
         merge_classes(%w[border border-0], @classes)
       end
 
       def button_icon
-        helpers.public_send(:"#{@icon}_icon")
+        helpers.public_send(:"#{@icon}_icon", classes: @icon_classes)
       end
 
       private

data/app/components/sdr_view_components/elements/icon_button_form_component.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    # Component for a button which is an icon and is wrapped in a form
+    class IconButtonFormComponent < BaseComponent
+      def initialize(link:, icon:, label:, variant: :'outline-primary', classes: [], icon_classes: [], method: :get, # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+                     confirm: nil, top: true, data: {}, disabled: false, params: {})
+        @link = link
+        @icon = icon
+        @label = label
+        @variant = variant
+        @classes = classes
+        @icon_classes = icon_classes
+        @method = method
+        @confirm = confirm
+        @top = top
+        @data = data
+        @disabled = disabled
+        @params = params
+        super()
+      end
+
+      def before_render
+        raise SdrViewComponents::Error::UnknownComponentIcon, "Unknown icon type: #{@icon}" unless button_icon?
+      end
+
+      attr_reader :link, :params, :label
+
+      def call
+        button_to(link, method: @method,
+                        class: ComponentSupport::ButtonSupport.classes(variant: @variant, classes:, disabled: @disabled),
+                        form: { data: },
+                        params:) do
+          concat button_icon
+          concat tag.span(label, class: 'visually-hidden')
+        end
+      end
+
+      def classes
+        merge_classes(%w[border border-0], @classes)
+      end
+
+      def data
+        @data.tap do |data|
+          data[:turbo_frame] = '_top' if @top
+          data[:turbo_confirm] = @confirm if @confirm
+        end
+      end
+
+      def button_icon
+        helpers.public_send(:"#{@icon}_icon", classes: @icon_classes)
+      end
+
+      private
+
+      def button_icon?
+        helpers.respond_to?(:"#{@icon}_icon")
+      end
+    end
+  end
+end

data/app/components/sdr_view_components/elements/icon_button_link_component.html.erb

@@ -1,3 +1,3 @@
-<%= render SdrViewComponents::Elements::ButtonLinkComponent.new(classes:, variant: :'outline-primary', link:, **options) do %>
+<%= render SdrViewComponents::Elements::ButtonLinkComponent.new(classes:, variant: :'outline-primary', link:, disabled:, **options) do %>
   <%= button_icon %><span class="visually-hidden"><%= label %></span>
 <% end %>

data/app/components/sdr_view_components/elements/icon_button_link_component.rb

@@ -4,17 +4,18 @@ module SdrViewComponents
   module Elements
     # Component for a button which is an icon
     class IconButtonLinkComponent < BaseComponent
-      def initialize(icon:, label:, classes: [], icon_classes: [], link: nil, **options) # rubocop:disable Metrics/ParameterLists
+      def initialize(icon:, label:, classes: [], icon_classes: [], link: nil, disabled: false, **options) # rubocop:disable Metrics/ParameterLists
         @icon = icon
         @label = label
         @classes = classes
         @link = link
         @options = options
         @icon_classes = icon_classes
+        @disabled = disabled
         super()
       end
 
-      attr_reader :label, :link, :options
+      attr_reader :label, :link, :options, :disabled
 
       def classes
         merge_classes(%w[border border-0], @classes)

data/app/components/sdr_view_components/tables/base_table_component.html.erb

@@ -1,7 +1,7 @@
 <% @table_content = capture do %>
   <%= tag.table class: classes, 'aria-label': label, **@table_options do %>
     <% if show_label? %>
-      <caption><%= label || caption %></caption>
+      <caption><%= caption || label %></caption>
     <% end %>
     <% if headers? %>
       <%= tag.thead class: head_classes do %>

data/lib/sdr_view_components/version.rb

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

data/spec/components/previews/sdr_view_components/elements/button_component_preview.rb

@@ -63,6 +63,18 @@ module SdrViewComponents
       end
       # @!endgroup
 
+      # @!group Disabled State
+      def enabled
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Enabled Button', variant: 'primary',
+                                                                disabled: false)
+      end
+
+      def disabled
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Disabled Button', variant: 'primary',
+                                                                disabled: true)
+      end
+      # @!endgroup
+
       def default
         render SdrViewComponents::Elements::ButtonComponent.new(label: 'Default Button')
       end

data/spec/components/previews/sdr_view_components/elements/button_form_component_preview.rb

@@ -89,6 +89,37 @@ module SdrViewComponents
       end
       # @!endgroup
 
+      # @!group Disabled State
+      def enabled
+        render SdrViewComponents::Elements::ButtonFormComponent.new(
+          link: '/action',
+          label: 'Enabled Button',
+          variant: :primary,
+          disabled: false
+        )
+      end
+
+      def disabled
+        render SdrViewComponents::Elements::ButtonFormComponent.new(
+          link: '/action',
+          label: 'Disabled Button',
+          variant: :primary,
+          disabled: true
+        )
+      end
+      # @!endgroup
+
+      # @!group Params
+      def with_params
+        render SdrViewComponents::Elements::ButtonFormComponent.new(
+          link: '/action',
+          label: 'Submit with Params',
+          variant: :primary,
+          params: { foo: 'bar', baz: 'qux' }
+        )
+      end
+      # @!endgroup
+
       def default
         render SdrViewComponents::Elements::ButtonFormComponent.new(link: '/', label: 'Form Button')
       end

data/spec/components/previews/sdr_view_components/elements/button_link_component_preview.rb

@@ -79,6 +79,18 @@ module SdrViewComponents
       end
       # @!endgroup
 
+      # @!group Disabled State
+      def enabled
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Enabled Link Button',
+                                                                    variant: :primary, disabled: false)
+      end
+
+      def disabled
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Disabled Link Button',
+                                                                    variant: :primary, disabled: true)
+      end
+      # @!endgroup
+
       def default
         render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Default Link Button')
       end

data/spec/components/previews/sdr_view_components/elements/icon_button_component_preview.rb

@@ -12,6 +12,23 @@ module SdrViewComponents
         render SdrViewComponents::Elements::IconButtonComponent.new(icon: :download, label: 'Download file')
       end
       # @!endgroup
+
+      # @!group Disabled State
+      def enabled
+        render SdrViewComponents::Elements::IconButtonComponent.new(icon: :delete, label: 'Delete item',
+                                                                    disabled: false)
+      end
+
+      def disabled
+        render SdrViewComponents::Elements::IconButtonComponent.new(icon: :delete, label: 'Delete item',
+                                                                    disabled: true)
+      end
+      # @!endgroup
+
+      def with_icon_classes
+        render SdrViewComponents::Elements::IconButtonComponent.new(icon: :delete, label: 'Delete item',
+                                                                    icon_classes: %w[fs-4])
+      end
     end
   end
 end

data/spec/components/previews/sdr_view_components/elements/icon_button_form_component_preview.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class IconButtonFormComponentPreview < ViewComponent::Preview
+      def default
+        render SdrViewComponents::Elements::IconButtonFormComponent.new(link: '/example', icon: :download,
+                                                                        label: 'Download item')
+      end
+
+      def with_confirmation
+        render SdrViewComponents::Elements::IconButtonFormComponent.new(
+          link: '/delete-item',
+          icon: :delete,
+          label: 'Delete item',
+          method: :delete,
+          confirm: 'Are you sure you want to delete this item?'
+        )
+      end
+
+      # @!group Disabled State
+      def enabled
+        render SdrViewComponents::Elements::IconButtonFormComponent.new(link: '/example', icon: :download,
+                                                                        label: 'Download item', disabled: false)
+      end
+
+      def disabled
+        render SdrViewComponents::Elements::IconButtonFormComponent.new(link: '/example', icon: :download,
+                                                                        label: 'Download item', disabled: true)
+      end
+      # @!endgroup
+    end
+  end
+end

data/spec/components/previews/sdr_view_components/elements/icon_button_link_component_preview.rb

@@ -10,6 +10,26 @@ module SdrViewComponents
           link: '/example'
         )
       end
+
+      # @!group Disabled State
+      def enabled
+        render SdrViewComponents::Elements::IconButtonLinkComponent.new(
+          icon: :download,
+          label: 'Download item',
+          link: '/example',
+          disabled: false
+        )
+      end
+
+      def disabled
+        render SdrViewComponents::Elements::IconButtonLinkComponent.new(
+          icon: :download,
+          label: 'Download item',
+          link: '/example',
+          disabled: true
+        )
+      end
+      # @!endgroup
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sdr_view_components
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Aaron Collier
@@ -82,6 +82,7 @@ files:
 - app/components/sdr_view_components/elements/horizontal_rule_component.rb
 - app/components/sdr_view_components/elements/icon_button_component.html.erb
 - app/components/sdr_view_components/elements/icon_button_component.rb
+- app/components/sdr_view_components/elements/icon_button_form_component.rb
 - app/components/sdr_view_components/elements/icon_button_link_component.html.erb
 - app/components/sdr_view_components/elements/icon_button_link_component.rb
 - app/components/sdr_view_components/elements/modal_component.html.erb
@@ -199,6 +200,7 @@ files:
 - spec/components/previews/sdr_view_components/elements/horizontal_rule_component_preview.rb
 - spec/components/previews/sdr_view_components/elements/horizontal_rule_component_preview/default.html.erb
 - spec/components/previews/sdr_view_components/elements/icon_button_component_preview.rb
+- spec/components/previews/sdr_view_components/elements/icon_button_form_component_preview.rb
 - spec/components/previews/sdr_view_components/elements/icon_button_link_component_preview.rb
 - spec/components/previews/sdr_view_components/elements/modal_component_preview.rb
 - spec/components/previews/sdr_view_components/elements/modal_component_preview/default.html.erb
@@ -373,7 +375,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Rails gem for providing SDR-specific ViewComponents.
 test_files: []