Class: ViewComponent::Preview

Inherits:
Object
  • Object
show all
Extended by:
ActiveSupport::DescendantsTracker
Includes:
ActionView::Helpers::TagHelper
Defined in:
lib/view_component/preview.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.all ⇒ Object

Returns all component preview classes.



16
17
18
19
 
# File 'lib/view_component/preview.rb', line 16

def all
  load_previews if descendants.empty?
  descendants
end

.component ⇒ Object

Returns the component object class associated to the preview.



31
32
33
 
# File 'lib/view_component/preview.rb', line 31

def component
  name.chomp("Preview").constantize
end

.example_exists?(example) ⇒ Boolean

Returns true if the example of the component preview exists.

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/view_component/preview.rb', line 41

def example_exists?(example)
  examples.include?(example)
end

.examples ⇒ Object

Returns all of the available examples for the component preview.



36
37
38
 
# File 'lib/view_component/preview.rb', line 36

def examples
  public_instance_methods(false).map(&:to_s).sort
end

.exists?(preview) ⇒ Boolean

Returns true if the preview exists.

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/view_component/preview.rb', line 46

def exists?(preview)
  all.any? { |p| p.preview_name == preview }
end

.find(preview) ⇒ Object

Find a component preview by its underscored class name.



51
52
53
 
# File 'lib/view_component/preview.rb', line 51

def find(preview)
  all.find { |p| p.preview_name == preview }
end

.layout(layout_name) ⇒ Object

Setter for layout name.



61
62
63
 
# File 'lib/view_component/preview.rb', line 61

def layout(layout_name)
  @layout = layout_name
end

.preview_name ⇒ Object

Returns the underscored name of the component preview without the suffix.



56
57
58
 
# File 'lib/view_component/preview.rb', line 56

def preview_name
  name.chomp("Preview").underscore
end

.render_args(example, params: {}) ⇒ Object

Returns the arguments for rendering of the component in its layout



22
23
24
25
26
27
28
 
# File 'lib/view_component/preview.rb', line 22

def render_args(example, params: {})
  example_params_names = instance_method(example).parameters.map(&:last)
  provided_params = params.slice(*example_params_names).to_h.symbolize_keys
  result = provided_params.empty? ? new.public_send(example) : new.public_send(example, **provided_params)
  @layout = nil unless defined?(@layout)
  result.merge(layout: @layout)
end

Instance Method Details

#render(component, **args, &block) ⇒ Object 



10
11
12
 
# File 'lib/view_component/preview.rb', line 10

def render(component, **args, &block)
  { component: component, args: args, block: block }
end