Class: Primer::Beta::TimelineItem

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/beta/timeline_item.rb

Overview

Use ‘TimelineItem` to display items on a vertical timeline, connected by badge elements.

Defined Under Namespace

Classes: Badge

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 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(condensed: false, **system_arguments) ⇒ TimelineItem

Returns a new instance of TimelineItem.

Parameters:

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

    Reduce the vertical padding and remove the background from the badge item. Most commonly used in commits.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



43
44
45
46
47
48
49
50
51
 
# File 'app/components/primer/beta/timeline_item.rb', line 43

def initialize(condensed: false, **system_arguments)
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = :div
  @system_arguments[:classes] = class_names(
    "TimelineItem",
    condensed ? "TimelineItem--condensed" : "",
    system_arguments[:classes]
  )
end

Instance Method Details

#render? ⇒ Boolean

Returns:

  • (Boolean) 


53
54
55
 
# File 'app/components/primer/beta/timeline_item.rb', line 53

def render?
  avatar? || badge? || body?
end