Timeline

The timeline component is used to display items on a vertical timeline, connected by timeline elements.

v0.18.2BetaNot reviewed for accessibility

Description

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

Arguments

NameDefaultDescription
condensed

false

Boolean

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

system_arguments

N/A

Hash

Examples

Slots

avatar

Avatar to be rendered to the left of the Badge.

NameDefaultDescription
kwargs

N/A

Hash

The same arguments as Avatar.

badge

Badge that will be connected to other TimelineItems.

NameDefaultDescription
icon

N/A

String

Name of Octicons to use.

system_arguments

N/A

Hash

body

Body to be rendered to the left of the Badge.

NameDefaultDescription
system_arguments

N/A

Hash

TimelineItem::Badge

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