Class: Primer::TimelineItemComponent

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

Overview

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

Defined Under Namespace

Classes: BadgeComponent

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

Primer::TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Instance Method Summary collapse

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

Constructor Details

#initialize(condensed: false, **system_arguments) ⇒ TimelineItemComponent

Returns a new instance of TimelineItemComponent.

Examples:

Default

<div style="padding-left: 60px">
  <%= render(Primer::TimelineItemComponent.new) do |component| %>
    <% component.avatar(src: "https://github.com/github.png", alt: "github") %>
    <% component.badge(bg: :success_emphasis, color: :on_emphasis, icon: :check) %>
    <% component.body { "Success!" } %>
  <% end %>
</div>

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 %>



51
52
53
54
55
56
57
58
59
 
# File 'app/components/primer/timeline_item_component.rb', line 51

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) 


61
62
63
 
# File 'app/components/primer/timeline_item_component.rb', line 61

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