Class: Primer::OpenProject::GridLayout

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/open_project/grid_layout.rb,
app/components/primer/open_project/grid_layout/area.rb

Overview

A layouting component used to arrange multiple components in a CSS Grid Note that this component only provides helpers (as the class names and grid-area styles). However, it does not define the actual Grid which should be done in a separate CSS-file.

Defined Under Namespace

Classes: Area

Constant Summary

Constants inherited from Component

Component::INVALID_ARIA_LABEL_TAGS

Constants included from Status::Dsl

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from TestSelectorHelper

TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Constants included from AttributesHelper

AttributesHelper::PLURAL_ARIA_ATTRIBUTES, AttributesHelper::PLURAL_DATA_ATTRIBUTES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Component

deprecated?, generate_id

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from TestSelectorHelper

#add_test_selector

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?

Methods included from ClassNameHelper

#class_names

Methods included from AttributesHelper

#aria, #data, #extract_data, #merge_aria, #merge_data, #merge_prefixed_attribute_hashes

Methods included from ExperimentalSlotHelpers

included

Methods included from ExperimentalRenderHelpers

included

Constructor Details

#initialize(css_class:, **system_arguments) ⇒ GridLayout

Returns a new instance of GridLayout.

Parameters:

  • css_class (String) —

    The basic css class applied on the grid-container

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



18
19
20
21
22
23
24
25
26
27
 
# File 'app/components/primer/open_project/grid_layout.rb', line 18

def initialize(css_class:, **system_arguments)
  super

  @system_arguments = system_arguments
  @css_class = css_class
  @system_arguments[:classes] = class_names(
    @system_arguments[:classes],
    css_class
  )
end

Instance Attribute Details

#css_class ⇒ Object (readonly)

Returns the value of attribute css_class.



10
11
12
 
# File 'app/components/primer/open_project/grid_layout.rb', line 10

def css_class
  @css_class
end

Instance Method Details

#render? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'app/components/primer/open_project/grid_layout.rb', line 29

def render?
  areas.any?
end