Class: Primer::TimelineItemComponent

Inherits:
Component
  • Object
show all
Includes:
ViewComponent::Slotable
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: Avatar, Badge, Body

Constant Summary

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from FetchOrFallbackHelper

#fetch_or_fallback

Methods included from ClassNameHelper

#class_names

Constructor Details

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

Returns a new instance of TimelineItemComponent.

Examples:

75|Default

<div style="padding-left: 60px">
  <%= render(Primer::TimelineItemComponent.new) do |component| %>
    <% component.slot(:avatar, src: "https://github.com/github.png", alt: "github") %>
    <% component.slot(:badge, bg: :green, color: :white, icon: :check) %>
    <% component.slot(: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 %>



25
26
27
28
29
30
31
32
33
 
# File 'app/components/primer/timeline_item_component.rb', line 25

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

Instance Attribute Details

#system_arguments ⇒ Object (readonly)

Returns the value of attribute system_arguments.



12
13
14
 
# File 'app/components/primer/timeline_item_component.rb', line 12

def system_arguments
  @system_arguments
end

Instance Method Details

#render? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'app/components/primer/timeline_item_component.rb', line 35

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