Class: Primer::Alpha::Overlay::Footer

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

Overview

A ‘Overlay::Footer` is a compositional component, used to render the Footer of an overlay. See <%= link_to_component(Primer::Alpha::Overlay) %>.

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 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, #merge_aria, #merge_data, #merge_prefixed_attribute_hashes

Constructor Details

#initialize(show_divider: false, align_content: DEFAULT_ALIGN_CONTENT, **system_arguments) ⇒ Footer

Returns a new instance of Footer.

Parameters:

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

    Show a divider between the footer and body.

  • align_content (Symbol) (defaults to: DEFAULT_ALIGN_CONTENT) —

    The alginment of contents. <%= one_of(Primer::Alpha::Overlay::ALIGN_CONTENT_OPTIONS) %>

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'app/components/primer/alpha/overlay/footer.rb', line 20

def initialize(
  show_divider: false,
  align_content: DEFAULT_ALIGN_CONTENT,
  **system_arguments
)
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = :div
  @system_arguments[:classes] = class_names(
    "Overlay-footer",
    ALIGN_CONTENT_MAPPINGS[fetch_or_fallback(ALIGN_CONTENT_OPTIONS, align_content, DEFAULT_ALIGN_CONTENT)],
    { "Overlay-footer--divided": show_divider },
    system_arguments[:classes]
  )
end

Instance Method Details

#call ⇒ Object 



35
36
37
 
# File 'app/components/primer/alpha/overlay/footer.rb', line 35

def call
  render(Primer::BaseComponent.new(**@system_arguments)) { content }
end