Progress Step

Progress Step kit is used to show the progress of a process. There are three types of steps in this kit: completed, active, and inactive. Completed steps are indicated by a solid, blue circle (with or without an icon). The current, or active, step is indicated by an outlined blue circle. The inactive, or future, step is indicated by a solid gray circle.

Summary

Uses Icons

Default

step 1
step 2
step 3
step 4
step 5

step 1
step 2
step 3
step 4

The default Progress Step kit sets orientation to horizontal and can be used with completed, active, and inactive steps as shown here.

icon is a boolean prop that can also be set to true to render icons within the steps indicator. icon is false by default.

<%= pb_rails("progress_step", props: {orientation: "horizontal"}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
  <% end %>
<% end %>

<br /><br />

<%= pb_rails("progress_step", props: {orientation: "horizontal"}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
  step 1
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
  step 2
  <% end %>
   <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
  step 3
  <% end %>
   <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
  step 4
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
  step 5
  <% end %>
<% end %>

<br /><br />

<%= pb_rails("progress_step", props: {orientation: "horizontal", icon:true }) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
  step 1
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
  step 2
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
  step 3
  <% end %>
    <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
  step 4
  <% end %>
<% end %>

Vertical

Child
Child
Child

orientation can also be set to vertical as shown here. By default, this is set to horizontal.

<%= pb_rails("progress_step", props: {orientation: "vertical", icon: true}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
  <% end %>
<% end %>

<br />

<%= pb_rails("progress_step", props: {orientation: "vertical"}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
  <% end %>
<% end %>

<br />

<%= pb_rails("progress_step", props: {orientation: "vertical"}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
    Child
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
    Child
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
    Child
  <% end %>
<% end %>

Tracker

Ordered
Shipped
Delivered

The variant prop can be set to tracker to achieve this UI. Tracker is only available with the horizontal orientation and it is also recommended that you set the icon prop to true for this variant.

This variant takes children just like the default progress step, however, it is best to use the caption kit for children in this variant.

<br><br>
<%= pb_rails("progress_step",props:{ variant:"tracker", icon:true}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
      <%= pb_rails("caption", props:{text: "Ordered"})%>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
      <%= pb_rails("caption", props:{text: "Shipped"})%>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
      <%= pb_rails("caption", props:{text: "Delivered"})%>
  <% end %>
<% end %>

<br>

<%= pb_rails("progress_step",props:{ variant:"tracker", icon:true}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
  <% end %>
    <%= pb_rails("progress_step/progress_step_item", props: {status: "hidden"}) do %>
  <% end %>
    <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
  <% end %>
<% end %>

Color

Ordered
Shipped
Delivered

The color prop can also be used to set color for the tracker variant. Options for color are primary and info with default being set to primary.

NOTE: The color prop is only available with the tracker variant.

<br><br>
<%= pb_rails("progress_step",props:{ variant:"tracker", icon:true, color: "info"}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
      <%= pb_rails("caption", props:{text: "Ordered"})%>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
      <%= pb_rails("caption", props:{text: "Shipped"})%>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
      <%= pb_rails("caption", props:{text: "Delivered"})%>
  <% end %>
<% end %>

<br>

Custom Icon

Ordered
Shipped
Delivered

Custom icons can also be set for individual steps. Simply use the icon prop for the relevant ProgressStepItem/progress_step_item as shown here.

<br><br>
<%= pb_rails("progress_step",props:{ variant:"tracker", icon:true}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
      <%= pb_rails("caption", props:{text: "Ordered"})%>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active", icon: "exclamation-triangle"}) do %>
      <%= pb_rails("caption", props:{text: "Shipped"})%>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
      <%= pb_rails("caption", props:{text: "Delivered"})%>
  <% end %>
<% end %>

Available Props

Props	Type	Values
gap	array	none xxs xs sm md lg xl
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 max
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 grid
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
column_gap	string
row_gap	string
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
icon	boolean		false
show_icon	boolean		false
variant	enum	default tracker	default
color	enum	primary info	primary

Contribute to Playbook

When you start designing a new feature, you may come across a Design Token or Component that isn’t defined in Playbook. If so, you should open an issue or reach out to the team to make a contribution.

Contribute on GitHub

As the highest-rated residential remodeler in the nation, our international technology team builds a custom suite of products that continuously transform our business.

Power

Tech @ Power

Open Positions

About Power

Connect

Github

Connect Chat

Progress Step

Available Props

gap

max_width

min_width

width

z_index

number_spacing

shadow

line_height

display

cursor

flex_direction

flex_wrap

justify_content

justify_self

align_items

align_content

align_self

flex

flex_grow

flex_shrink

order

position

hover

border_radius

text_align

overflow

truncate

left

top

right

bottom

vertical_align

height

min_height

max_height

overflow_x

overflow_y

margin

margin_bottom

margin_left

margin_right

margin_top

margin_x

margin_y

padding

padding_bottom

padding_left

padding_right

padding_top

padding_x

padding_y

classname

dark

column_gap

row_gap

group_hover

id

data

aria

html_options

children

style

orientation

icon

show_icon

variant

color

Contribute to Playbook

Power

Connect