sdr_view_components 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbfc52ae67fecdff708f4696aaa7092396da6dff749264858c11dbbfbe8a4382
-  data.tar.gz: 32a60c51ecd3fdb27a1ef011ad8fbaee64053f956e66d0d3d42c51fd36801f78
+  metadata.gz: b973a9d37ca8cbaf8923757222f1e73ae754a72ca99731008c68d22c7be41f28
+  data.tar.gz: 6014055eb861360362ee8527f5f7d2afba60665428720df0e095982af8aa9c46
 SHA512:
-  metadata.gz: 0f7f24fc7019c867299b390b5ae6dff1a93fc7b41f66a5075f473b5ebd69061d7cd4f44f92480b6e3337f26ac2683b5b48260580bbc11aa72b9007a910884c11
-  data.tar.gz: bbca5c2fc24924a8df4e40a706140b568502bf4816b3e2a43840614d201c28d849d1e2374febb56d9b4656f4ae6a0d8cd28e13750fcc5c94da0685dc78305161
+  metadata.gz: ec8945789ecbc351308b32e6f7df8600e8b43d9bfe92ef9bd4013279b69a20a0eeebf5f4ea6cf6fb36946690a5564020e57e268826a145c1a0911d9cd1aad796
+  data.tar.gz: d5fe578fc6d4c376408b315536cf97d538dd19c466785e73472266d402663d95150f2ae5e7fe9095989e1c39bac616c88582067282863d893a3eebbfa35e2c1a

data/lib/sdr_view_components/version.rb

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

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class AlertComponentPreview < ViewComponent::Preview
+      # @!group Variants
+      def default
+        render SdrViewComponents::Elements::AlertComponent.new(title: 'Information', variant: :info) do
+          'This is an informational alert.'
+        end
+      end
+
+      def danger
+        render SdrViewComponents::Elements::AlertComponent.new(title: 'Error', variant: :danger) do
+          'This is a danger alert.'
+        end
+      end
+
+      def success
+        render SdrViewComponents::Elements::AlertComponent.new(title: 'Success', variant: :success) do
+          'This is a success alert.'
+        end
+      end
+
+      def note
+        render SdrViewComponents::Elements::AlertComponent.new(title: 'Note', variant: :note) do
+          'This is a note alert.'
+        end
+      end
+
+      def warning
+        render SdrViewComponents::Elements::AlertComponent.new(title: 'Warning', variant: :warning) do
+          'This is a warning alert.'
+        end
+      end
+
+      def input
+        render SdrViewComponents::Elements::AlertComponent.new(title: 'Input Required', variant: :input) do
+          'This is an input validation alert.'
+        end
+      end
+      # @!endgroup
+
+      def with_title_only
+        render SdrViewComponents::Elements::AlertComponent.new(title: 'Alert Title Only') do
+          'Content goes here.'
+        end
+      end
+
+      def dismissible_alert
+        render SdrViewComponents::Elements::AlertComponent.new(title: 'Dismissible Alert', dismissible: true) do
+          'Click the X button to dismiss this alert.'
+        end
+      end
+
+      # @!group Content Options
+      def with_text_property
+        render SdrViewComponents::Elements::AlertComponent
+          .new(title: 'Using Text Property',
+               text: 'This alert uses the text parameter instead of block content.')
+      end
+
+      def with_block_content
+        render SdrViewComponents::Elements::AlertComponent.new(title: 'Using Block Content') do
+          'This alert uses block content, which can include HTML or other components.'
+        end
+      end
+      # @!endgroup
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class BannerComponentPreview < ViewComponent::Preview
+      # @!group Variants
+      def default
+        render SdrViewComponents::Elements::BannerComponent.new do |component|
+          component.with_header { 'Welcome to the Banner Component' }
+        end
+      end
+
+      def note
+        render SdrViewComponents::Elements::BannerComponent.new(variant: :note) do |component|
+          component.with_header { 'Note: Important Information' }
+        end
+      end
+
+      def success
+        render SdrViewComponents::Elements::BannerComponent.new(variant: :success) do |component|
+          component.with_header { 'Success: Action Completed' }
+        end
+      end
+
+      def warning
+        render SdrViewComponents::Elements::BannerComponent.new(variant: :warning) do |component|
+          component.with_header { 'Warning: Please Review' }
+        end
+      end
+
+      def info
+        render SdrViewComponents::Elements::BannerComponent.new(variant: :info) do |component|
+          component.with_header { 'Information: For Your Reference' }
+        end
+      end
+
+      def danger
+        render SdrViewComponents::Elements::BannerComponent.new(variant: :danger) do |component|
+          component.with_header { 'Danger: Critical Alert' }
+        end
+      end
+      # @!endgroup
+
+      def with_title
+        render SdrViewComponents::Elements::BannerComponent.new(title: 'Subtitle or Additional Title') do |component|
+          component.with_header { 'Main Header' }
+        end
+      end
+
+      def with_header_and_body
+        render SdrViewComponents::Elements::BannerComponent.new do |component|
+          component.with_header { 'Banner Header' }
+          component.with_body { 'This is the body content of the banner, providing additional context or details.' }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class BreadcrumbNavComponentPreview < ViewComponent::Preview
+      # @!group Breadcrumb Types
+      def default_breadcrumbs
+        render SdrViewComponents::Elements::BreadcrumbNavComponent.new do |component|
+          component.with_breadcrumb(text: 'Home', link: '/')
+          component.with_breadcrumb(text: 'Collections', link: '/collections')
+          component.with_breadcrumb(text: 'Current Page', active: true)
+        end
+      end
+
+      def title_breadcrumbs
+        render SdrViewComponents::Elements::BreadcrumbNavComponent.new do |component|
+          component.with_title_breadcrumb(text: 'Home', link: '/')
+          component.with_title_breadcrumb(text: 'A Very Long Title That Will Be Truncated', link: '/titles')
+          component.with_title_breadcrumb(text: 'Current Title Item', active: true)
+        end
+      end
+
+      def collection_breadcrumbs
+        render SdrViewComponents::Elements::BreadcrumbNavComponent.new do |component|
+          component.with_collection_breadcrumb(text: 'Home', link: '/')
+          component.with_collection_breadcrumb(text: 'Collection Name Truncated', link: '/collections')
+          component.with_collection_breadcrumb(text: 'Item', active: true)
+        end
+      end
+      # @!endgroup
+
+      # @!group With Links and Active State
+      def with_all_links
+        render SdrViewComponents::Elements::BreadcrumbNavComponent.new do |component|
+          component.with_breadcrumb(text: 'Home', link: '/')
+          component.with_breadcrumb(text: 'Section', link: '/section')
+          component.with_breadcrumb(text: 'Subsection', link: '/section/subsection')
+          component.with_breadcrumb(text: 'Current', active: true)
+        end
+      end
+
+      def mixed_active_items
+        render SdrViewComponents::Elements::BreadcrumbNavComponent.new do |component|
+          component.with_breadcrumb(text: 'Home', link: '/')
+          component.with_breadcrumb(text: 'Active Section', active: true)
+          component.with_breadcrumb(text: 'Another Item', link: '/other')
+        end
+      end
+      # @!endgroup
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class ButtonComponentPreview < ViewComponent::Preview
+      # @!group Button Variants
+      def primary
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Primary', variant: 'primary')
+      end
+
+      def secondary
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Secondary', variant: 'secondary')
+      end
+
+      def success
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Success', variant: 'success')
+      end
+
+      def danger
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Danger', variant: 'danger')
+      end
+
+      def warning
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Warning', variant: 'warning')
+      end
+
+      def info
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Info', variant: 'info')
+      end
+      # @!endgroup
+
+      # @!group Button Sizes
+      def small
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Small Button', variant: 'primary', size: 'sm')
+      end
+
+      def large
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Large Button', variant: 'primary', size: 'lg')
+      end
+      # @!endgroup
+
+      # @!group Borderless
+      def borderless
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Borderless Button', variant: 'primary',
+                                                                bordered: false)
+      end
+
+      def borderless_secondary
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Borderless Secondary', variant: 'secondary',
+                                                                bordered: false)
+      end
+      # @!endgroup
+
+      # @!group Content Options
+      def with_label
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Button with Label', variant: 'primary')
+      end
+
+      def with_block_content
+        render SdrViewComponents::Elements::ButtonComponent.new(variant: 'primary') do
+          'Button with Block Content'
+        end
+      end
+      # @!endgroup
+
+      def default
+        render SdrViewComponents::Elements::ButtonComponent.new(label: 'Default Button')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class ButtonFormComponentPreview < ViewComponent::Preview
+      # @!group Button Variants
+      def primary
+        render SdrViewComponents::Elements::ButtonFormComponent.new(link: '/action', label: 'Primary Form Button',
+                                                                    variant: :primary)
+      end
+
+      def secondary
+        render SdrViewComponents::Elements::ButtonFormComponent.new(link: '/action', label: 'Secondary Form Button',
+                                                                    variant: :secondary)
+      end
+
+      def success
+        render SdrViewComponents::Elements::ButtonFormComponent.new(link: '/action', label: 'Success Action',
+                                                                    variant: :success)
+      end
+
+      def danger
+        render SdrViewComponents::Elements::ButtonFormComponent.new(link: '/action', label: 'Delete Item', variant: :danger)
+      end
+
+      def warning
+        render SdrViewComponents::Elements::ButtonFormComponent.new(link: '/action', label: 'Warning Action',
+                                                                    variant: :warning)
+      end
+
+      def info
+        render SdrViewComponents::Elements::ButtonFormComponent.new(link: '/action', label: 'Information Action',
+                                                                    variant: :info)
+      end
+      # @!endgroup
+
+      # @!group With Confirmation
+      def with_confirmation
+        render SdrViewComponents::Elements::ButtonFormComponent.new(
+          link: '/delete-item',
+          label: 'Delete (with confirmation)',
+          variant: :danger,
+          confirm: 'Are you sure you want to delete this item?'
+        )
+      end
+
+      def without_confirmation
+        render SdrViewComponents::Elements::ButtonFormComponent.new(
+          link: '/action',
+          label: 'Action (no confirmation)',
+          variant: :primary
+        )
+      end
+      # @!endgroup
+
+      # @!group Turbo Frame Behavior
+      def turbo_frame_top
+        render SdrViewComponents::Elements::ButtonFormComponent.new(
+          link: '/submit',
+          label: 'Submit (reload top)',
+          variant: :primary,
+          top: true
+        )
+      end
+
+      def turbo_frame_scoped
+        render SdrViewComponents::Elements::ButtonFormComponent.new(
+          link: '/submit',
+          label: 'Submit (scoped frame)',
+          variant: :primary,
+          top: false
+        )
+      end
+      # @!endgroup
+
+      # @!group Content Options
+      def with_label
+        render SdrViewComponents::Elements::ButtonFormComponent.new(
+          link: '/action',
+          label: 'Button with Label',
+          variant: :primary
+        )
+      end
+
+      def with_block_content
+        render SdrViewComponents::Elements::ButtonFormComponent.new(link: '/action', variant: :primary) do
+          'Button with Block Content'
+        end
+      end
+      # @!endgroup
+
+      def default
+        render SdrViewComponents::Elements::ButtonFormComponent.new(link: '/', label: 'Form Button')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class ButtonLinkComponentPreview < ViewComponent::Preview
+      # @!group Button Variants
+      def primary
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Primary Link Button',
+                                                                    variant: :primary)
+      end
+
+      def secondary
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Secondary Link Button',
+                                                                    variant: :secondary)
+      end
+
+      def success
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Success Link Button',
+                                                                    variant: :success)
+      end
+
+      def danger
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Danger Link Button',
+                                                                    variant: :danger)
+      end
+
+      def warning
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Warning Link Button',
+                                                                    variant: :warning)
+      end
+
+      def info
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Info Link Button',
+                                                                    variant: :info)
+      end
+      # @!endgroup
+
+      # @!group Button Sizes
+      def small
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Small Link Button',
+                                                                    variant: :primary, size: 'sm')
+      end
+
+      def large
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Large Link Button',
+                                                                    variant: :primary, size: 'lg')
+      end
+      # @!endgroup
+
+      # @!group Borderless
+      def borderless
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Borderless Link Button',
+                                                                    variant: :primary, bordered: false)
+      end
+
+      def borderless_secondary
+        render SdrViewComponents::Elements::ButtonLinkComponent
+          .new(link: '/example',
+               label: 'Borderless Secondary Link Button', variant: :secondary, bordered: false)
+      end
+      # @!endgroup
+
+      # @!group Content Options
+      def with_label
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Label Link Button',
+                                                                    variant: :primary)
+      end
+
+      def with_block_content
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', variant: :primary) do
+          'Link Button with Block Content'
+        end
+      end
+      # @!endgroup
+
+      def default
+        render SdrViewComponents::Elements::ButtonLinkComponent.new(link: '/example', label: 'Default Link Button')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class CardComponentPreview < ViewComponent::Preview
+      # @!group Card Slots
+      def default
+        render SdrViewComponents::Elements::CardComponent.new
+      end
+
+      def with_header
+        render SdrViewComponents::Elements::CardComponent.new do |card|
+          card.with_header do
+            'Card Header'
+          end
+        end
+      end
+
+      def with_body
+        render SdrViewComponents::Elements::CardComponent.new do |card|
+          card.with_body do
+            'Card body content goes here.'
+          end
+        end
+      end
+
+      def with_header_and_body
+        render SdrViewComponents::Elements::CardComponent.new do |card|
+          card.with_header do
+            'Card Header'
+          end
+
+          card.with_body do
+            'Card body content goes here.'
+          end
+        end
+      end
+      # @!endgroup
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class HeadingComponentPreview < ViewComponent::Preview
+      # @!group Heading Levels
+      def h1
+        render SdrViewComponents::Elements::HeadingComponent.new(level: :h1, text: 'Page title')
+      end
+
+      def h2
+        render SdrViewComponents::Elements::HeadingComponent.new(level: :h2, text: 'Section heading')
+      end
+
+      def h3
+        render SdrViewComponents::Elements::HeadingComponent.new(level: :h3, text: 'Subsection heading')
+      end
+
+      def h4
+        render SdrViewComponents::Elements::HeadingComponent.new(level: :h4, text: 'Supporting heading')
+      end
+
+      def h5
+        render SdrViewComponents::Elements::HeadingComponent.new(level: :h5, text: 'Minor heading')
+      end
+
+      def h6
+        render SdrViewComponents::Elements::HeadingComponent.new(level: :h6, text: 'Eyebrow heading')
+      end
+      # @!endgroup
+
+      # @!group Variant Styling
+      def h2_with_h1_styling
+        render SdrViewComponents::Elements::HeadingComponent.new(level: :h2, text: 'Rendered as h2, styled like h1',
+                                                                 variant: :h1)
+      end
+
+      def h3_with_h2_styling
+        render SdrViewComponents::Elements::HeadingComponent.new(level: :h3, text: 'Rendered as h3, styled like h2',
+                                                                 variant: :h2)
+      end
+      # @!endgroup
+
+      def with_block_content
+        render SdrViewComponents::Elements::HeadingComponent.new(level: :h2) do
+          'Heading supplied by block content'
+        end
+      end
+    end
+  end
+end

data/spec/components/previews/sdr_view_components/elements/horizontal_rule_component_preview/default.html.erb

@@ -0,0 +1,5 @@
+<p>Content above the horizontal rule.</p>
+
+<%= render SdrViewComponents::Elements::HorizontalRuleComponent.new %>
+
+<p>Content below the horizontal rule.</p>

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class HorizontalRuleComponentPreview < ViewComponent::Preview
+      def default; end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class IconButtonComponentPreview < ViewComponent::Preview
+      # @!group Icon Buttons
+      def delete
+        render SdrViewComponents::Elements::IconButtonComponent.new(icon: :delete, label: 'Delete item')
+      end
+
+      def download
+        render SdrViewComponents::Elements::IconButtonComponent.new(icon: :download, label: 'Download file')
+      end
+      # @!endgroup
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class IconButtonLinkComponentPreview < ViewComponent::Preview
+      def default
+        render SdrViewComponents::Elements::IconButtonLinkComponent.new(
+          icon: :download,
+          label: 'Download item',
+          link: '/example'
+        )
+      end
+    end
+  end
+end

data/spec/components/previews/sdr_view_components/elements/modal_component_preview/default.html.erb

@@ -0,0 +1,9 @@
+<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#default-modal-preview">
+  Open default modal
+</button>
+
+<%= render SdrViewComponents::Elements::ModalComponent.new(id: 'default-modal-preview') do |modal| %>
+  <% modal.with_body do %>
+    <p class="mb-0">Use this modal to review submission details before publishing.</p>
+  <% end %>
+<% end %>

data/spec/components/previews/sdr_view_components/elements/modal_component_preview/with_header_and_footer.html.erb

@@ -0,0 +1,19 @@
+<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#modal-with-header-and-footer-preview">
+  Open modal with header and footer
+</button>
+
+<%= render SdrViewComponents::Elements::ModalComponent.new(id: 'modal-with-header-and-footer-preview') do |modal| %>
+  <% modal.with_header do %>
+    <h2 class="h5 mb-0">Publish item</h2>
+  <% end %>
+
+  <% modal.with_body do %>
+    <p>This item is ready to publish to the repository.</p>
+    <p class="mb-0">Review the metadata one final time before continuing.</p>
+  <% end %>
+
+  <% modal.with_footer do %>
+    <button type="button" class="btn btn-outline-secondary" data-bs-dismiss="modal">Cancel</button>
+    <button type="button" class="btn btn-primary">Publish</button>
+  <% end %>
+<% end %>

data/spec/components/previews/sdr_view_components/elements/modal_component_preview/without_size.html.erb

@@ -0,0 +1,9 @@
+<button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#without-size-modal-preview">
+  Open modal without size
+</button>
+
+<%= render SdrViewComponents::Elements::ModalComponent.new(id: 'without-size-modal-preview', size: nil) do |modal| %>
+  <% modal.with_body do %>
+    <p class="mb-0">This example renders the modal without an explicit size class.</p>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SdrViewComponents
+  module Elements
+    class ModalComponentPreview < ViewComponent::Preview
+      # @!group Sizes
+      def default; end
+
+      def without_size; end
+      # @!endgroup
+
+      def with_header_and_footer; end
+    end
+  end
+end