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

Code Example

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

Code Example

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

Code Example

<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

Code Example

<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

Code Example

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

classname
dark
margin
margin_bottom
margin_left
margin_right
margin_top
margin_x
margin_y
max_width
padding
padding_bottom
padding_left
padding_right
padding_top
padding_x
padding_y
z_index
number_spacing
id
data
aria
children
orientation
icon
show_icon
variant
color