Class: Ariadne::LayoutComponent

Inherits:
Component
  • Object
show all
Defined in:
app/components/ariadne/layout_component.rb

Overview

Layout component to control the widths of 1-3 columns

Constant Summary collapse

DEFAULT_TAG = 
:div
DEFAULT_SIDECAR_TAG = 
:div
DEFAULT_ASIDE_TAG = 
:div
DEFAULT_MAIN_TAG = 
:div
DEFAULT_CLASSES = 
{
  wrapper: "ariadne-group ariadne-flex ariadne-gap-2 ariadne-flex-col md:ariadne-flex-row",
  sidecar: "ariadne-w-full md:ariadne-w-1/6",
  main: "ariadne-grow",
  aside: "ariadne-w-full md:ariadne-w-1/6",
}
DEFAULT_ATTRIBUTES = 
{
  wrapper: {},
  sidecar: {},
  main: {},
  aside: {},
}

Constants inherited from Component

Component::BASE_HIDDEN_CLASS, Component::BASE_MAIN_CLASSES, Component::BASE_WRAPPER_CLASSES, Component::INVALID_ARIA_LABEL_TAGS

Constants included from ActionViewExtensions::FormHelper

ActionViewExtensions::FormHelper::DEFAULT_FORM_CLASSES

Constants included from Status::Dsl

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::INTEGER_TYPES, FetchOrFallbackHelper::InvalidValueError, FetchOrFallbackHelper::TRUE_OR_FALSE

Instance Method Summary collapse

Methods included from ActionViewExtensions::FormHelper

#ariadne_form_with

Methods included from ClassNameHelper

#merge_class_names

Methods included from LoggerHelper

#logger, #silence_deprecations?, #silence_warnings?

Methods included from FetchOrFallbackHelper

#check_incoming_attribute, #check_incoming_tag, #check_incoming_value, #fetch_or_raise, #fetch_or_raise_boolean, #fetch_or_raise_integer

Constructor Details

#initialize(tag: DEFAULT_TAG, classes: "", attributes: {}, main_tag: DEFAULT_MAIN_TAG, main_classes: "", main_attributes: {}, sidecar_tag: DEFAULT_SIDECAR_TAG, sidecar_classes: "", sidecar_attributes: {}, aside_tag: DEFAULT_ASIDE_TAG, aside_classes: "", aside_attributes: {}) ⇒ LayoutComponent

Returns a new instance of LayoutComponent.

Examples:

Default


<%= render(Ariadne::LayoutComponent.new) { "Example" } %>

Parameters:

  • tag (Symbol, String) (defaults to: DEFAULT_TAG) —

    The rendered tag name.

  • classes (String) (defaults to: "") —

    <%= link_to_classes_docs %>

  • attributes (Hash) (defaults to: {}) —

    <%= link_to_attributes_docs %>



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'app/components/ariadne/layout_component.rb', line 38

def initialize(
  tag: DEFAULT_TAG,
  classes: "",
  attributes: {},
  main_tag: DEFAULT_MAIN_TAG,
  main_classes: "",
  main_attributes: {},
  sidecar_tag: DEFAULT_SIDECAR_TAG,
  sidecar_classes: "",
  sidecar_attributes: {},
  aside_tag: DEFAULT_ASIDE_TAG,
  aside_classes: "",
  aside_attributes: {}
)
  @tag = check_incoming_tag(DEFAULT_TAG, tag)
  @classes = merge_class_names(DEFAULT_CLASSES[:wrapper], classes)
  @attributes = DEFAULT_ATTRIBUTES[:wrapper].merge(attributes)

  @sidecar_tag = check_incoming_tag(DEFAULT_SIDECAR_TAG, tag)
  @sidecar_attributes = DEFAULT_ATTRIBUTES[:sidecar].merge(sidecar_attributes)
  @sidecar_classes = merge_class_names(DEFAULT_CLASSES[:sidecar], sidecar_classes)

  @main_tag = check_incoming_tag(DEFAULT_MAIN_TAG, tag)
  @main_attributes = DEFAULT_ATTRIBUTES[:main].merge(main_attributes)
  @main_classes = merge_class_names(DEFAULT_CLASSES[:main], main_classes)

  @aside_tag = check_incoming_tag(DEFAULT_ASIDE_TAG, tag)
  @aside_attributes = DEFAULT_ATTRIBUTES[:aside].merge(aside_attributes)
  @aside_classes = merge_class_names(DEFAULT_CLASSES[:aside], aside_classes)
end