TimelineItem

readyNot reviewed for a11y
This page may be removed. Primer plans to move all Rails component documentation to Lookbook.

Description

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

Arguments

NameRequiredDescription
condensed
Boolean

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

system_arguments

Slots

avatar

Avatar to be rendered to the left of the Badge.

NameRequiredDescription
kwargs
Hash

The same arguments as Primer::Beta::Avatar.

badge

Badge that will be connected to other TimelineItems.

NameRequiredDescription
icon
String

Name of Octicons to use.

system_arguments

body

Body to be rendered to the left of the Badge.

NameRequiredDescription
system_arguments

TimelineItem::Badge

This component is part of Primer::Beta::TimelineItem and should not be used as a standalone component.