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.

Tracker
You must set the icon prop to true for this kit.
This variant takes children just like the default progress step. It is best to use the caption kit for children in this variant.

Default

step 1
step 2
step 3
step 4
step 5

step 1
step 2
step 3

<%= 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: "complete"}) do %>
  step 3
  <% end %>
<% end %>

Vertical

Child
Card content

Card content
Child

<%= 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 %>
    <%= pb_rails("card", props: {highlight: {position: "side", color:"windows"}}) do %>
  Card content
<% end %>
<br>
<%= pb_rails("card", props: {highlight: {position: "side", color:"windows"}}) do %>
  Card content
<% end %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
    Child
  <% end %>
<% end %>

Tracker

Ordered
Shipped
Delivered

<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 %>

Custom Icon

Ordered
Shipped
Delivered

<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 %>

Tooltip

step 1
step 2
step 3
step 4
step 5

Ordered
Shipped
Delivered

Ordered
Shipped
Out for Delivery
Delivered

<%= pb_rails("progress_step", props: {orientation: "horizontal"}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete", classname: "tooltip-trigger-1", tooltip: "Tooltip for step 1", tooltip_position: "right", step_direction: "horizontal" }) do %>
  step 1
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete", classname: "tooltip-trigger-2", tooltip: "Tooltip for step 2", step_direction: "horizontal" }) do %>
  step 2
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active", classname: "tooltip-trigger-3", tooltip: "Tooltip for step 3", tooltip_position: "left", step_direction: "horizontal" }) do %>
  step 3
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive", classname: "tooltip-trigger-4", tooltip: "Tooltip for step 4", tooltip_position: "bottom" }) do %>
  step 4
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive", classname: "tooltip-trigger-5", tooltip: "Tooltip for step 5" }) do %>
  step 5
  <% end %>
<% end %>

<br /><br />

<%= pb_rails("progress_step", props: {orientation: "vertical"}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete", classname: "tooltip-trigger-6", tooltip: "Tooltip step 1", step_direction: "vertical" }) do %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active", classname: "tooltip-trigger-7", tooltip: "Tooltip step 2", tooltip_position: "left"}) do %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive", classname: "tooltip-trigger-8", tooltip: "Tooltip step 3", tooltip_position: "top", step_direction: "vertical" }) do %>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive", classname: "tooltip-trigger-9", tooltip: "Tooltip step 4", tooltip_position: "bottom"}) do %>
  <% end %>
<% end %>

<br /><br>
<%= pb_rails("progress_step",props:{ variant:"tracker", icon:true}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete", classname: "tooltip-trigger-10", tooltip: "The order has been received", step_direction: "horizontal" , tooltip_position: "right"  }) do %>
      <%= pb_rails("caption", props:{text: "Ordered"})%>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active", classname: "tooltip-trigger-11", tooltip:"Item(s) have been shipped" }) do %>
      <%= pb_rails("caption", props:{text: "Shipped"})%>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive", classname: "tooltip-trigger-12", tooltip:"This step has not been reached", tooltip_position: "left" }) do %>
      <%= pb_rails("caption", props:{text: "Delivered"})%>
  <% end %>
<% end %>

<br /><br>
<%= pb_rails("progress_step",props:{ variant:"tracker", icon:true}) do %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete", classname: "tooltip-trigger-13", tooltip: "The order has been processed", tooltip_position: "right" }) do %>
      <%= pb_rails("caption", props:{text: "Ordered"})%>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active", icon: "exclamation-triangle", classname: "tooltip-trigger-14", tooltip: "More details needed before shipment", tooltip_position: "bottom" }) do %>
      <%= pb_rails("caption", props:{text: "Shipped"})%>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive", classname: "tooltip-trigger-15", tooltip: "This step is inactive"}) do %>
      <%= pb_rails("caption", props:{text: "Out for Delivery"})%>
  <% end %>
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive", classname: "tooltip-trigger-16", tooltip: "Estimated delivery: Jun 27", tooltip_position: "left"}) do %>
      <%= pb_rails("caption", props:{text: "Delivered"})%>
  <% end %>
<% end %>

Available Props

Props	Type	Values
max_width	array	xs sm md lg xl 0 none
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
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
id	string
data	hash
aria	hash
children	proc

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

Progress Step

Available Props

max_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

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

id

data

aria

children

orientation

icon

show_icon

variant

color