Class: Component

Inherits:

Object

• Object
• Component

Includes:

ActiveModel::Attributes, ActiveModel::Model

Defined in:

app/lib/component.rb

Overview

The Ancestral Component

All components descend from this class. It provides:

• ActiveModel::Attributes for declarative attribute definitions

• Named slots via the ‘slot` class macro

• The ‘render_in` contract: block capture, HTML safety, dev annotations

See: specs/the-holy-view-spec.md, specs/the-holy-slot-spec.md

Direct Known Subclasses

AccordionComponent, AdComponent, ApiComponent, BackButtonComponent, BreadcrumbComponent, ButtonComponent, ButtonToComponent, CalendarComponent, CardComponent, CheckboxComponent, ColumnComponent, CommentComponent, ContainerComponent, DimmerComponent, DividerComponent, DropdownComponent, EmbedComponent, EmojiComponent, FeedComponent, FlagComponent, FlyoutComponent, GridComponent, HStackComponent, HeaderComponent, IconComponent, ImageComponent, InputComponent, ItemComponent, ItemGroupComponent, LabelComponent, LinkToComponent, ListComponent, LoaderComponent, MenuComponent, MenuItemComponent, MessageComponent, ModalComponent, NagComponent, OverlayComponent, ParagraphComponent, PlaceholderComponent, PopupComponent, ProgressComponent, PusherComponent, RailComponent, RatingComponent, ResetComponent, ResourceListBlock, RevealComponent, RowComponent, SearchComponent, SegmentComponent, SegmentGroupComponent, ShapeComponent, SidebarComponent, SiteComponent, SliderComponent, StateComponent, StatisticComponent, StepComponent, StepGroupComponent, StickyComponent, StyleComponent, SubHeaderComponent, SubMenuComponent, TabComponent, TableCellComponent, TableComponent, TableRowComponent, TemplateComponent, TextComponent, ToastComponent, TransitionComponent, VStackComponent, VisibilityComponent, WrapperComponent

Constant Summary

HTML_OPTIONS =

HTML pass-through keys that bypass ActiveModel attributes

%i[id class data style role tabindex title aria target rel].to_set.freeze

Class Method Summary

• .default(**overrides) ⇒ Object
• .slot(name) ⇒ Object

Instance Method Summary

• #initialize(**kwargs) ⇒ Component constructor

  A new instance of Component.

• #render_in(context, &block) ⇒ Object
• #to_s ⇒ Object

Constructor Details

#initialize(**kwargs) ⇒ Component

Returns a new instance of Component.

# File 'app/lib/component.rb', line 21

def initialize(**kwargs)
  known = self.class.attribute_names.map(&:to_sym).to_set
  attrs = kwargs.select { |k, _| known.include?(k) }
  @html_options = kwargs.except(*attrs.keys)
  super(**attrs)
end

Class Method Details

.default(**overrides) ⇒ Object

# File 'app/lib/component.rb', line 28

def self.default(**overrides)
  overrides.each do |name, value|
    type = attribute_types.fetch(name.to_s).type
    attribute name, type, default: value
  end
end

.slot(name) ⇒ Object

# File 'app/lib/component.rb', line 35

def self.slot(name)
  self.slot_names = slot_names + [ name ]

  define_method(name) { |&block|
    @slots[name] = @view_context.capture(&block)
  }
end

Instance Method Details

#render_in(context, &block) ⇒ Object

# File 'app/lib/component.rb', line 43

def render_in(context, &block)
  @view_context = context
  @slots = {}
  @content = context.capture(self, &block) if block
  @content = ERB::Util.html_escape(@content) unless @content.nil? || @content.html_safe?

  if Rails.env.development?
    "<!-- BEGIN #{self.class.name} -->#{self}<!-- END #{self.class.name} -->".html_safe
  else
    to_s
  end
end

#to_s ⇒ Object

Raises:

• (NotImplementedError)

# File 'app/lib/component.rb', line 56

def to_s
  raise NotImplementedError
end