Stepper

Source: https://getbootstrap.com/docs/6.0/components/stepper

Create timelines, wizards, or step-by-step progress bars. Ideal for shopping carts, sign-up forms, and more.

Examples

Stepper is built with CSS Grid and <ol> elements. By default, steps are displayed vertically. You can transform them into horizontal lists with responsive modifier classes.

Basic

Here’s a simple example of a vertical stepper.

&lt;li class="stepper-item active">Create account&lt;/li>
&lt;li class="stepper-item active">Confirm email&lt;/li>
&lt;li class="stepper-item">Update profile&lt;/li>
&lt;li class="stepper-item">Finish&lt;/li>

</ol>`} />

Responsive

Steppers can be made horizontal at specific breakpoints using the contains-inline utility on a parent element and by adding the responsive .stepper-horizontal-{breakpoint} modifier classes on the stepper. The extra parent element is required when using container queries.

&lt;ol class="stepper sm:stepper-horizontal">
  &lt;li class="stepper-item active">Create account&lt;/li>
  &lt;li class="stepper-item active">Confirm email&lt;/li>
  &lt;li class="stepper-item">Update profile&lt;/li>
  &lt;li class="stepper-item">Finish&lt;/li>
&lt;/ol>

</div>`} />

Gap

Customize the gap with styles that override the --bs-stepper-gap CSS variable.

&lt;li class="stepper-item active">Create account&lt;/li>
&lt;li class="stepper-item active">Confirm email&lt;/li>
&lt;li class="stepper-item">Update profile&lt;/li>
&lt;li class="stepper-item">Finish&lt;/li>

</ol>`} />

Variants

&lt;li class="stepper-item active theme-accent">Create account&lt;/li>
&lt;li class="stepper-item">Confirm email&lt;/li>
&lt;li class="stepper-item active theme-success">Update profile&lt;/li>
&lt;li class="stepper-item active theme-danger">Finish&lt;/li>

</ol>`} />

Overflow

Wrap your horizontal stepper in a .stepper-overflow container to enable horizontal scrolling when the stepper overflows its parent. Uses container-type: inline-size for container query support as opposed to a viewport-based media query.

&lt;ol class="stepper stepper-horizontal">
  &lt;li class="stepper-item active">Create account&lt;/li>
  &lt;li class="stepper-item active">Verify email address&lt;/li>
  &lt;li class="stepper-item">Complete profile setup&lt;/li>
  &lt;li class="stepper-item">Add payment method&lt;/li>
  &lt;li class="stepper-item">Review and confirm&lt;/li>
  &lt;li class="stepper-item">Finish onboarding&lt;/li>
&lt;/ol>

</div>`} />

Complex

Add additional content beyond labels to provide more context within each step, such as descriptions, helper messages, status indicators, or other decorative elements.

&lt;li class="stepper-item align-items-start active">
  &lt;div class="pt-1">
    &lt;div class="fw-semibold">Create&lt;/div>
    &lt;small class="fg-3">Create an account.&lt;/small>
  &lt;/div>
&lt;/li>
&lt;li class="stepper-item align-items-start active">
  &lt;div class="pt-1">
    &lt;div class="fw-semibold">Confirm&lt;/div>
    &lt;small class="fg-3">Confirm your email.&lt;/small>
  &lt;/div>
&lt;/li>
&lt;li class="stepper-item align-items-start">
  &lt;div class="pt-1">
    &lt;div class="fw-semibold">Set-up&lt;/div>
    &lt;small class="fg-3">Configure your profile.&lt;/small>
  &lt;/div>
&lt;/li>
&lt;li class="stepper-item align-items-start">
  &lt;div class="pt-1">
    &lt;div class="fw-semibold">Finish&lt;/div>
    &lt;small class="fg-3">Welcome aboard!&lt;/small>
  &lt;/div>
&lt;/li>

</ol>`} />

Mix with other components, like badges, and our theme helpers to create a more unique steppers.

&lt;li class="stepper-item theme-success active">
  &lt;div>
    &lt;div>Create account&lt;/div>
    &lt;div class="badge badge-subtle">Complete&lt;/div>
  &lt;/div>
&lt;/li>
&lt;li class="stepper-item theme-success active">
  &lt;div>
    &lt;div>Confirm email&lt;/div>
    &lt;div class="badge badge-subtle">Complete&lt;/div>
  &lt;/div>
&lt;/li>
&lt;li class="stepper-item theme-primary active">
  &lt;div>
    &lt;div>Update profile&lt;/div>
    &lt;div class="badge badge-subtle">In-progress&lt;/div>
  &lt;/div>
&lt;/li>
&lt;li class="stepper-item theme-secondary">
  &lt;div>
    &lt;div>Finish&lt;/div>
    &lt;div class="badge badge-subtle">Pending&lt;/div>
  &lt;/div>
&lt;/li>

</ol>`} />

Alignment

Use text alignment utilities (because we use display: inline-grid) to align the steps. The inline grid arrangement allows us to keep the steps equal width and ensures the connecting lines are rendered correctly.

&lt;li class="stepper-item active">Default stepper&lt;/li>
&lt;li class="stepper-item active">Confirm email&lt;/li>
&lt;li class="stepper-item">Update profile&lt;/li>
&lt;li class="stepper-item">Finish&lt;/li>

</ol>`} />

&lt;li class="stepper-item active">Center stepper&lt;/li>
&lt;li class="stepper-item active">Confirm email&lt;/li>
&lt;li class="stepper-item">Update profile&lt;/li>
&lt;li class="stepper-item">Finish&lt;/li>

</ol>`} />

&lt;li class="stepper-item active">End stepper&lt;/li>
&lt;li class="stepper-item active">Confirm email&lt;/li>
&lt;li class="stepper-item">Update profile&lt;/li>
&lt;li class="stepper-item">Finish&lt;/li>

</ol>`} />

Apply .w-100 to the stepper to make it full width. Stepper items will be stretched to fill the available space. Alignment doesn’t affect full-width steppers.

&lt;li class="stepper-item active">Create account&lt;/li>
&lt;li class="stepper-item active">Confirm email&lt;/li>
&lt;li class="stepper-item">Update profile&lt;/li>
&lt;li class="stepper-item">Finish&lt;/li>

</ol>`} />

With anchors

Use anchor elements to build your stepper if it links across multiple pages. Add role="button" or use <button> elements if you’re linking across sections in the same document.

Consider using our link utilities for quick color control.

&lt;a href="#" role="button" class="stepper-item active">Create account&lt;/a>
&lt;a href="#" role="button" class="stepper-item active">Confirm email&lt;/a>
&lt;a href="#" role="button" class="stepper-item theme-secondary">Update profile&lt;/a>
&lt;a href="#" role="button" class="stepper-item theme-secondary">Finish&lt;/a>

</div>`} />

CSS

Variables

Sass mixin

Overflow wrapper