RubyGems - sdr_view_components - Versions diffs - 0.1.14 → 0.2.1 - Mend

sdr_view_components 0.1.14 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (174) hide show

data/app/components/sdr_view_components/tables/row_component.rb ADDED Viewed

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module SdrViewComponents
+  module Tables
+    # Component for rendering a table row.
+    class RowComponent < BaseComponent
+      renders_many :cells, SdrViewComponents::Tables::CellComponent
+      renders_one :label_content
+      def initialize(label: nil, first_value: nil, values: [], value: nil, tooltip: nil, **row_options) # rubocop:disable Metrics/ParameterLists
+        # Provide either label or first_value but not both; these are rendered in the first column
+        # label renders with <th> (bold), first_value is a normal <td>
+        @label = label
+        @first_value = first_value
+        # Provide either value, values or cells (e.g. for content files).
+        @values = Array(value).presence || values
+        @tooltip = tooltip
+        @row_options = row_options
+        raise ArgumentError if label.present? && first_value.present?
+        super()
+      end
+      attr_reader :label, :values, :tooltip, :first_value, :row_options
+      def empty_cell?
+        label.present? && values.empty? && !cells?
+      end
+    end
+  end
+end

data/app/components/sdr_view_components/tables/table_component.rb ADDED Viewed

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module SdrViewComponents
+  module Tables
+    # Component for rendering a table.
+    class TableComponent < BaseTableComponent
+      renders_many :rows, SdrViewComponents::Tables::RowComponent
+    end
+  end
+end

data/app/views/layouts/lookbook.html.erb ADDED Viewed

@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= content_for(:title) || 'Lookbook' %></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <meta name="apple-mobile-web-app-capable" content="yes">
+    <meta name="application-name" content="Lookbook">
+    <meta name="mobile-web-app-capable" content="yes">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <%# Enable PWA manifest for installable apps (make sure to enable in config/routes.rb too!) %>
+    <%# = tag.link rel: "manifest", href: pwa_manifest_path(format: :json) %>
+    <link rel="icon" href="/icon.png" type="image/png">
+    <link rel="icon" href="/icon.svg" type="image/svg+xml">
+    <link rel="apple-touch-icon" href="/icon.png">
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-sRIl4kxILFvY47J16cr9ZwB07vP4J8+LH7qKQnuqkuIAvNWLzeN8tE5YBujZqJLB" crossorigin="anonymous">
+    <link
+      rel="stylesheet"
+      href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.0/font/bootstrap-icons.css"
+>
+    <%= tag.link rel: 'icon', href: "#{SdrViewComponents.configuration.component_library_url}/styles/icon.png", type: 'image/png' %>
+    <%= tag.link rel: 'icon', href: "#{SdrViewComponents.configuration.component_library_url}/styles/icon.svg", type: 'image/svg+xml' %>
+    <%= tag.link rel: 'apple-touch-icon', href: "#{SdrViewComponents.configuration.component_library_url}/styles/icon.png" %>
+    <%= stylesheet_link_tag 'sdr_view_components', 'data-turbo-track': 'reload' %>
+    <%= tag.link rel: 'stylesheet', href: "#{SdrViewComponents.configuration.component_library_url}/styles/sul.css" %>
+  </head>
+  <body>
+    <div class="container-fluid py-4">
+      <%= yield %>
+    </div>
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.8/dist/js/bootstrap.bundle.min.js" integrity="sha384-FKyoEForCGlyvwx9Hj09JcYn3nv7wiPVlz7YYwJrWVcXK/BmnVDxM+D2scQbITxI" crossorigin="anonymous"></script>
+  </body>
+</html>

data/lib/sdr_view_components/configuration.rb ADDED Viewed

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+# SDR View Components module
+module SdrViewComponents
+  # Configuration class for the SDR View Components gem
+  class Configuration
+    attr_accessor :component_library_url
+    def initialize
+      # Default URL for the component library assets
+      @component_library_url = 'https://cdn.jsdelivr.net/gh/sul-dlss/component-library@v2026-01-27'
+    end
+  end
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+  def self.configure
+    yield configuration
+  end
+end

data/lib/sdr_view_components/engine.rb CHANGED Viewed

@@ -7,19 +7,25 @@ module SdrViewComponents
   class Engine < ::Rails::Engine
     isolate_namespace SdrViewComponents
-    initializer 'sdr_view_components.view_component' do
-      require 'view_component/engine'
+    initializer 'sdr_view_components.preview_autoload', before: :set_autoload_paths do |app|
+      preview_path = root.join('spec/components/previews').to_s
+      app.config.autoload_paths |= [preview_path]
+    end
+    initializer 'sdr_view_components.preview_paths' do |app|
+      preview_path = root.join('spec/components/previews').to_s
-      # Tell VC where your previews live (inside the engine)
-      config.view_component.previews.paths << root.join('spec/components/previews')
+      app.config.view_component.previews.paths |= [preview_path] if app.config.view_component.respond_to?(:previews)
-      # Optional: which layout to wrap previews in (comes from the dummy app)
-      config.view_component.default_preview_layout = 'application'
+      # Lookbook direct config
+      if app.config.respond_to?(:lookbook) && app.config.lookbook.respond_to?(:preview_paths)
+        app.config.lookbook.preview_paths |= [preview_path]
+      end
     end
     initializer 'sdr_view_components.assets' do |app|
+      app.config.assets.paths << Engine.root.join('app', 'assets').to_s
       app.config.assets.paths << Engine.root.join('app', 'assets', 'stylesheets').to_s
-      app.config.assets.precompile += %w[sdr_view_components.css]
     end
     initializer 'sdr_view_components.helpers' do
@@ -27,5 +33,9 @@ module SdrViewComponents
         include SdrViewComponents::Helpers
       end
     end
+    initializer 'sdr_view_components.configure_lookbook' do
+      config.view_component.previews.default_layout = 'lookbook'
+    end
   end
 end

data/lib/sdr_view_components/error.rb ADDED Viewed

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module SdrViewComponents
+  module Error
+    class UnknownComponentIcon < StandardError; end
+  end
+end

data/lib/sdr_view_components/version.rb CHANGED Viewed

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

data/lib/sdr_view_components.rb CHANGED Viewed

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 require 'sdr_view_components/version'
+require 'sdr_view_components/configuration'
 require 'sdr_view_components/engine'
+require 'sdr_view_components/error'
 require 'zeitwerk'
 loader = Zeitwerk::Loader.for_gem

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

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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