The timeline kit can use two different line styles in the same timeline - solid
and dotted
line styles.
To view different colors of icon circle, visit Icon Circle Kit.
<%= pb_rails("timeline") do %> <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal"}) do %> <%= pb_rails("body", props: { text: "Conversation started", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal"}) do %> <%= pb_rails("body", props: { text: "Trip #12422", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "credit-card", icon_color: "red"}) do %> <%= pb_rails("body", props: { text: "Refund issue #12422", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "smile", icon_color: "green"}) do %> <%= pb_rails("body", props: { text: "Conversation resolved", color: "light" }) %> <% end %> <% end %> <br /><br /> <%= pb_rails("timeline") do %> <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal", line_style: "dotted" }) do %> <%= pb_rails("title_detail", props: { title: "Jackson Heights", detail: "37-27 74th Street" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal" }) do %> <%= pb_rails("title_detail", props: { title: "Greenpoint", detail: "81 Gate St Brooklyn" }) %> <% end %> <% end %>
<%= pb_rails("timeline", props: {orientation: "vertical"}) do %> <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal"}) do %> <%= pb_rails("body", props: { text: "Conversation started", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal"}) do %> <%= pb_rails("body", props: { text: "Trip #12422", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "credit-card", icon_color: "red"}) do %> <%= pb_rails("body", props: { text: "Refund issue #12422", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "smile", icon_color: "green"}) do %> <%= pb_rails("body", props: { text: "Conversation resolved", color: "light" }) %> <% end %> <% end %> <br /><br /> <%= pb_rails("timeline", props: {orientation: "vertical"}) do %> <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal", line_style: "dotted"}) do %> <%= pb_rails("title_detail", props: { title: "Jackson Heights", detail: "37-27 74th Street" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal" }) do %> <%= pb_rails("title_detail", props: { title: "Greenpoint", detail: "81 Gate St Brooklyn" }) %> <% end %> <% end %>
Use the optional showDate
prop to render the timeline kit with a visible date. If the date is from the current year, the year will not be displayed, however if date is NOT from the current year, the kit will display the year as well.
<%= pb_rails("timeline", props: {orientation: "horizontal", show_date: true}) do %> <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal", line_style: "solid", date: Date.today }) do %> <%= pb_rails("title_detail", props: { title: "Jackson Heights", detail: "37-27 74th Street" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal", line_style: "dotted" }) do %> <%= pb_rails("title_detail", props: { title: "Greenpoint", detail: "81 Gate St Brooklyn" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "map-marker-alt", icon_color: "purple", date: Date.today+1 }) do %> <%= pb_rails("title_detail", props: { title: "Society Hill", detail: "72 E St Astoria" }) %> <% end %> <% end %> <br /><br /><br /> <%= pb_rails("timeline", props: {orientation: "vertical", show_date: true}) do %> <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal", line_style: "solid", date: Date.today }) do %> <%= pb_rails("title_detail", props: { title: "Jackson Heights", detail: "37-27 74th Street" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal", line_style: "dotted" }) do %> <%= pb_rails("title_detail", props: { title: "Greenpoint", detail: "81 Gate St Brooklyn" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "map-marker-alt", icon_color: "purple", date: Date.today+1 }) do %> <%= pb_rails("title_detail", props: { title: "Society Hill", detail: "72 E St Astoria" }) %> <% end %> <% end %> <br /><br /><br /> <%= pb_rails("timeline", props: {orientation: "vertical", show_date: true}) do %> <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal", line_style: "solid", date: Date.new(2018, 03, 20) }) do %> <%= pb_rails("title_detail", props: { title: "Jackson Heights", detail: "37-27 74th Street" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal", line_style: "dotted" }) do %> <%= pb_rails("title_detail", props: { title: "Greenpoint", detail: "81 Gate St Brooklyn" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "map-marker-alt", icon_color: "purple", date: Date.new(2018, 05, 20) }) do %> <%= pb_rails("title_detail", props: { title: "Society Hill", detail: "72 E St Astoria" }) %> <% end %> <% end %>
Any kit can be used inside of our compound components of label, step, or detail. Expand the code snippet below to see how to use these children elements.
<%= pb_rails("timeline", props: {orientation: "horizontal", show_date: true}) do %> <%= pb_rails("timeline/item", props: { line_style: "solid"}) do |item| %> <% item.label do %> <%= pb_rails("timeline/label") do %> <%= pb_rails("title", props: { text: "Any Kit Here", size: 2 }) %> <% end %> <% end %> <% item.step do %> <%= pb_rails("timeline/step", props: { icon: 'check', icon_color: 'teal' }) %> <% end %> <% item.detail do %> <%= pb_rails("title_detail", props: { title: "Jackson Heights", detail: "37-27 74th Street" }) %> <% end %> <% end %> <%= pb_rails("timeline/item", props: { line_style: "dotted"}) do |item| %> <% item.step do %> <%= pb_rails("timeline/step") do %> <%= pb_rails("pill", props: { text: "Any Kit" , variant: "success" }) %> <% end %> <% end %> <% item.detail do %> <%= pb_rails("title_detail", props: { title: "Greenpoint", detail: "81 Gate St Brooklyn" }) %> <% end %> <% end %> <%= pb_rails("timeline/item", props: {icon: "map-marker-alt", icon_color: "purple", date: Date.today+1 }) do |item| %> <%= pb_rails("title_detail", props: { title: "Society Hill", detail: "72 E St Astoria" }) %> <% end %> <% end %> <br /><br /><br /> <%= pb_rails("timeline", props: {orientation: "vertical", show_date: true}) do %> <%= pb_rails("timeline/item") do |item| %> <% item.label do %> <%= pb_rails("timeline/label") do %> <%= pb_rails("title", props: { text: "Any Kit", size: 4 }) %> <% end %> <% end %> <% item.step do %> <%= pb_rails("timeline/step", props: { icon: 'user', icon_color: 'royal' }) %> <% end %> <% item.detail do %> <%= pb_rails("title_detail", props: { title: "Jackson Heights", detail: "37-27 74th Street" }) %> <% end %> <% end %> <%= pb_rails("timeline/item", props: {icon: "map-marker-alt", icon_color: "purple", date: Date.today+1, line_style: "dotted" }) do |item| %> <%= pb_rails("title_detail", props: { title: "Society Hill", detail: "72 E St Astoria" }) %> <% end %> <%= pb_rails("timeline/item") do |item| %> <% item.step do %> <%= pb_rails("timeline/step") do %> <%= pb_rails("pill", props: { text: "3" , variant: "success" }) %> <% end %> <% end %> <% item.detail do %> <%= pb_rails("title_detail", props: { title: "Greenpoint", detail: "81 Gate St Brooklyn" }) %> <% end %> <% end %> <% end %>
Use the optional gap
prop to render the timeline kit with adjusted spacing between nodes. The gap
prop will only work when utilized with a vertical timeline. Horizontal timelines will show no difference in spacing.
<%= pb_rails("flex", props: { justify: "evenly" }) do %> <%= pb_rails("flex/flex_item") do %> <%= pb_rails("timeline", props: {orientation: "vertical", gap: "xs"}) do %> <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal"}) do %> <%= pb_rails("body", props: { text: "Conversation started", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal", line_style: "dotted"}) do %> <%= pb_rails("body", props: { text: "Trip #12422", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "credit-card", icon_color: "red"}) do %> <%= pb_rails("body", props: { text: "Refund issue #12422", color: "light" }) %> <% end %> <% end %> <% end %> <%= pb_rails("flex/flex_item") do %> <%= pb_rails("timeline", props: {orientation: "vertical", gap: "sm"}) do %> <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal"}) do %> <%= pb_rails("body", props: { text: "Conversation started", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal", line_style: "dotted"}) do %> <%= pb_rails("body", props: { text: "Trip #12422", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "credit-card", icon_color: "red"}) do %> <%= pb_rails("body", props: { text: "Refund issue #12422", color: "light" }) %> <% end %> <% end %> <% end %> <%= pb_rails("flex/flex_item") do %> <%= pb_rails("timeline", props: {orientation: "vertical", gap: "md"}) do %> <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal"}) do %> <%= pb_rails("body", props: { text: "Conversation started", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal", line_style: "dotted"}) do %> <%= pb_rails("body", props: { text: "Trip #12422", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "credit-card", icon_color: "red"}) do %> <%= pb_rails("body", props: { text: "Refund issue #12422", color: "light" }) %> <% end %> <% end %> <% end %> <%= pb_rails("flex/flex_item") do %> <%= pb_rails("timeline", props: {orientation: "vertical", gap: "lg"}) do %> <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal"}) do %> <%= pb_rails("body", props: { text: "Conversation started", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal", line_style: "dotted"}) do %> <%= pb_rails("body", props: { text: "Trip #12422", color: "light" }) %> <% end %> <%= pb_rails("timeline/item", props: {icon: "credit-card", icon_color: "red"}) do %> <%= pb_rails("body", props: { text: "Refund issue #12422", color: "light" }) %> <% end %> <% end %> <% end %> <% end %>
Props | Type | Values |
---|---|---|
max_width |
array
|
0%
xs
sm
md
lg
xl
xxl
0
none
100%
|
min_width |
array
|
0%
xs
sm
md
lg
xl
xxl
0
none
100%
|
width |
array
|
0%
xs
sm
md
lg
xl
xxl
0
none
100%
|
z_index |
array
|
1
2
3
4
5
6
7
8
9
10
|
number_spacing |
array
|
tabular
|
shadow |
array
|
none
deep
deeper
deepest
|
line_height |
array
|
tightest
tighter
tight
normal
loose
looser
loosest
|
display |
array
|
block
inline_block
inline
flex
inline_flex
none
|
cursor |
array
|
auto
default
none
contextMenu
help
pointer
progress
wait
cell
crosshair
text
verticalText
alias
copy
move
noDrop
notAllowed
grab
grabbing
eResize
nResize
neResize
nwResize
sResize
seResize
swResize
wResize
ewResize
nsResize
neswResize
nwseResize
colResize
rowResize
allScroll
zoomIn
zoomOut
|
flex_direction |
array
|
row
column
rowReverse
columnReverse
|
flex_wrap |
array
|
wrap
nowrap
wrapReverse
|
justify_content |
array
|
start
end
center
spaceBetween
spaceAround
spaceEvenly
|
justify_self |
array
|
auto
start
end
center
stretch
|
align_items |
array
|
flexStart
flexEnd
start
end
center
baseline
stretch
|
align_content |
array
|
start
end
center
spaceBetween
spaceAround
spaceEvenly
|
align_self |
array
|
auto
start
end
center
stretch
baseline
|
flex |
array
|
auto
initial
0
1
2
3
4
5
6
7
8
9
10
11
12
none
|
flex_grow |
array
|
1
0
|
flex_shrink |
array
|
1
0
|
order |
array
|
1
2
3
4
5
6
7
8
9
10
11
12
|
position |
array
|
relative
absolute
fixed
sticky
|
hover |
array
|
|
border_radius |
array
|
none
xs
sm
md
lg
xl
rounded
|
text_align |
array
|
start
end
left
right
center
justify
justify-all
match-parent
|
overflow |
array
|
visible
hidden
scroll
auto
|
truncate |
array
|
1
2
3
4
5
|
left |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
top |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
right |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
bottom |
array
|
0
xxs
xs
sm
md
lg
xl
auto
initial
inherit
|
vertical_align |
array
|
baseline
super
top
middle
bottom
sub
text-top
text-bottom
|
height |
array
|
auto
xs
sm
md
lg
xl
xxl
xxxl
|
min_height |
array
|
auto
xs
sm
md
lg
xl
xxl
xxxl
|
max_height |
array
|
auto
xs
sm
md
lg
xl
xxl
xxxl
|
overflow_x |
array
|
visible
hidden
scroll
auto
|
overflow_y |
array
|
visible
hidden
scroll
auto
|
margin |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_bottom |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_left |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_right |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_top |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_x |
array
|
none
xxs
xs
sm
md
lg
xl
|
margin_y |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_bottom |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_left |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_right |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_top |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_x |
array
|
none
xxs
xs
sm
md
lg
xl
|
padding_y |
array
|
none
xxs
xs
sm
md
lg
xl
|
classname |
string
|
|
dark |
boolean
|
|
group_hover |
boolean
|
|
id |
string
|
|
data |
hashprop
|
|
aria |
hashprop
|
|
html_options |
hashprop
|
|
children |
proc
|
|
style |
hashprop
|
Props | Type | Values | Default |
---|---|---|---|
orientation |
enum
|
vertical
horizontal
|
horizontal
|
show_date |
boolean
|
false
|
|
gap |
enum
|
xs
sm
md
lg
none
|
none
|