Class: Primer::Alpha::StackItem

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/alpha/stack_item.rb

Overview

StackItem is a layout component designed to be used as the child of a Stack.

Defined Under Namespace

Classes: GrowArg

Constant Summary collapse

DEFAULT_TAG = 
:div
ARG_CLASSES = 
[GrowArg].freeze

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 Primer::AttributesHelper

Primer::AttributesHelper::PLURAL_ARIA_ATTRIBUTES, Primer::AttributesHelper::PLURAL_DATA_ATTRIBUTES

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 Primer::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(tag: DEFAULT_TAG, grow: false, **system_arguments) ⇒ StackItem

Returns a new instance of StackItem.

Parameters:

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

    Customize the element type of the rendered container.

  • grow (Boolean) (defaults to: false) —

    Allow item to keep size or expand to fill the available space.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'app/components/primer/alpha/stack_item.rb', line 33

def initialize(tag: DEFAULT_TAG, grow: false, **system_arguments)
  @tag = tag
  @grow = grow
  @system_arguments = system_arguments
  @system_arguments[:tag] = tag

  @system_arguments[:classes] = class_names(
    @system_arguments.delete(:classes),
    "StackItem"
  )

  @system_arguments[:data] = merge_data(
    @system_arguments, {
      data: {
        **GrowArg.for(grow).to_data_attributes
      }
    }
  )
end