Module: Plutonium::UI::Component::Kit

Extended by:
ActiveSupport::Concern
Included in:
Behaviour
Defined in:
lib/plutonium/ui/component/kit.rb

Overview

Note:

All components are automatically rendered when called without the 'Build' prefix. For example, calling TabList(...) will internally call BuildTabList(...) and render the result.

Component Kit automatically handles component instantiation and rendering through a convention-based approach using Build* methods.

Examples:

Basic component usage

class MyView
  include Plutonium::UI::Component::Kit

  def view_template
    PageHeader(title: "Dashboard")
    TabList(items: tabs)
    Panel(class: "mt-4") do
      content
    end
  end
end

Adding a new component

def BuildCustomComponent(title:, **options)
  Plutonium::UI::CustomComponent.new(
    title: title,
    **options
  )
end

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args, **kwargs, &block) ⇒ Object 



38
39
40
41
42
43
44
45
46
 
# File 'lib/plutonium/ui/component/kit.rb', line 38

def method_missing(method_name, *args, **kwargs, &block)
  build_method = "Build#{method_name}"

  if self.class.method_defined?(build_method)
    render send(build_method, *args, **kwargs, &block)
  else
    super
  end
end

Instance Method Details

#BuildActionButton ⇒ Object 



73
 
# File 'lib/plutonium/ui/component/kit.rb', line 73

def BuildActionButton(...) = Plutonium::UI::ActionButton.new(...)

#BuildActionsDropdown ⇒ Object 



75
 
# File 'lib/plutonium/ui/component/kit.rb', line 75

def BuildActionsDropdown(...) = Plutonium::UI::ActionsDropdown.new(...)

#BuildAvatar ⇒ Object 



53
 
# File 'lib/plutonium/ui/component/kit.rb', line 53

def BuildAvatar(...) = Plutonium::UI::Avatar.new(...)

#BuildBlock ⇒ Object 



59
 
# File 'lib/plutonium/ui/component/kit.rb', line 59

def BuildBlock(...) = Plutonium::UI::Block.new(...)

#BuildBreadcrumbs ⇒ Object 



55
 
# File 'lib/plutonium/ui/component/kit.rb', line 55

def BuildBreadcrumbs(...) = Plutonium::UI::Breadcrumbs.new(...)

#BuildBulkActionsToolbar ⇒ Object 



91
 
# File 'lib/plutonium/ui/component/kit.rb', line 91

def BuildBulkActionsToolbar(...) = Plutonium::UI::Table::Components::BulkActionsToolbar.new(...)

#BuildColorModeSelector ⇒ Object 



99
 
# File 'lib/plutonium/ui/component/kit.rb', line 99

def BuildColorModeSelector(...) = Plutonium::UI::ColorModeSelector.new(...)

#BuildDynaFrameContent ⇒ Object 



69
 
# File 'lib/plutonium/ui/component/kit.rb', line 69

def BuildDynaFrameContent(...) = Plutonium::UI::DynaFrame::Content.new(...)

#BuildDynaFrameHost ⇒ Object 



67
 
# File 'lib/plutonium/ui/component/kit.rb', line 67

def BuildDynaFrameHost(...) = Plutonium::UI::DynaFrame::Host.new(...)

#BuildEmptyCard ⇒ Object 



77
 
# File 'lib/plutonium/ui/component/kit.rb', line 77

def BuildEmptyCard(...) = Plutonium::UI::EmptyCard.new(...)

#BuildFrameNavigatorPanel ⇒ Object 



63
 
# File 'lib/plutonium/ui/component/kit.rb', line 63

def BuildFrameNavigatorPanel(...) = Plutonium::UI::FrameNavigatorPanel.new(...)

#BuildModalCentered ⇒ Object 



101
 
# File 'lib/plutonium/ui/component/kit.rb', line 101

def BuildModalCentered(...) = Plutonium::UI::Modal::Centered.new(...)

#BuildModalSlideover ⇒ Object 



103
 
# File 'lib/plutonium/ui/component/kit.rb', line 103

def BuildModalSlideover(...) = Plutonium::UI::Modal::Slideover.new(...)

#BuildPageHeader ⇒ Object 



71
 
# File 'lib/plutonium/ui/component/kit.rb', line 71

def BuildPageHeader(...) = Plutonium::UI::PageHeader.new(...)

#BuildPanel ⇒ Object 



61
 
# File 'lib/plutonium/ui/component/kit.rb', line 61

def BuildPanel(...) = Plutonium::UI::Panel.new(...)

#BuildRowActionsDropdown ⇒ Object 



89
 
# File 'lib/plutonium/ui/component/kit.rb', line 89

def BuildRowActionsDropdown(...) = Plutonium::UI::Table::Components::RowActionsDropdown.new(...)

#BuildSkeletonTable ⇒ Object 



57
 
# File 'lib/plutonium/ui/component/kit.rb', line 57

def BuildSkeletonTable(...) = Plutonium::UI::SkeletonTable.new(...)

#BuildTableFilterPills ⇒ Object 



95
 
# File 'lib/plutonium/ui/component/kit.rb', line 95

def BuildTableFilterPills(...) = Plutonium::UI::Table::Components::FilterPills.new(...)

#BuildTableInfo ⇒ Object 



85
 
# File 'lib/plutonium/ui/component/kit.rb', line 85

def BuildTableInfo(...) = Plutonium::UI::Table::Components::PagyInfo.new(...)

#BuildTablePagination ⇒ Object 



87
 
# File 'lib/plutonium/ui/component/kit.rb', line 87

def BuildTablePagination(...) = Plutonium::UI::Table::Components::PagyPagination.new(...)

#BuildTableScopesBar ⇒ Object 



81
 
# File 'lib/plutonium/ui/component/kit.rb', line 81

def BuildTableScopesBar(...) = Plutonium::UI::Table::Components::ScopesBar.new(...)

#BuildTableScopesPills ⇒ Object 



83
 
# File 'lib/plutonium/ui/component/kit.rb', line 83

def BuildTableScopesPills(...) = Plutonium::UI::Table::Components::ScopesPills.new(...)

#BuildTableSearchBar ⇒ Object 



79
 
# File 'lib/plutonium/ui/component/kit.rb', line 79

def BuildTableSearchBar(...) = Plutonium::UI::Table::Components::SearchBar.new(...)

#BuildTableToolbar ⇒ Object 



93
 
# File 'lib/plutonium/ui/component/kit.rb', line 93

def BuildTableToolbar(...) = Plutonium::UI::Table::Components::Toolbar.new(...)

#BuildTableViewSwitcher ⇒ Object 



97
 
# File 'lib/plutonium/ui/component/kit.rb', line 97

def BuildTableViewSwitcher(...) = Plutonium::UI::Table::Components::ViewSwitcher.new(...)

#BuildTabList ⇒ Object 



65
 
# File 'lib/plutonium/ui/component/kit.rb', line 65

def BuildTabList(...) = Plutonium::UI::TabList.new(...)

#respond_to_missing?(method_name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
51
 
# File 'lib/plutonium/ui/component/kit.rb', line 48

def respond_to_missing?(method_name, include_private = false)
  build_method = "Build#{method_name}"
  self.class.method_defined?(build_method) || super
end