Bootstrap 5 Stepper

What is Bootstrap Stepper?

Stepper is a component that displays content as a process with defined by user milestones. This is a great solution for a variety of registration forms, where you don't want to scare the user with lots of fields and questions.

Installation

Manual installation (zip package)

To take advantage of our Bootstrap images component and use them in your project, you first need to install the MDB 5 Free package

MDB CLI

Watch our Quick Start Tutorial to discover and use the full potential of MDB 5 and MDB CLI

NPM

Prerequisites

Before starting the project make sure to install Node LTS (12.x.x recommended).

Installation

To install MDB UI KIT in your project easily type the following command in the terminal:

npm i mdb-ui-kit

Importing JS modules

You can import the entire library or just individual modules:

import * as mdb from 'mdb-ui-kit'; // lib
import { Input } from 'mdb-ui-kit'; // module

Importing CSS file

To import MDB stylesheet please use the following syntax:

@import '~mdb-ui-kit/css/mdb.min.css';

Importing SCSS modules

You can also import individual SCSS modules. To do it properly, we recommend to copy them from the node_modules/mdb-ui-kit/src/scss location directly to your project and import in the same way as CSS files.

Webpack integration

You can significantly speed up the process of creating a new project based on Webpack using our Starter.

CDN

Installation via CDN is one of the easiest methods of integrating MDB UI KIT with your project. Just copy the latest compiled JS script tag and CSS link tag from cdnjs to the application.

Don't forget to add also Font Awesome and Roboto font if you need. Here's an example code:

CSS

<!-- Font Awesome -->
<link
  href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css"
  rel="stylesheet"
/>
<!-- Google Fonts -->
<link
  href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap"
  rel="stylesheet"
/>
<!-- MDB -->
<link
  href="https://cdnjs.cloudflare.com/ajax/libs/mdb-ui-kit/3.3.0/mdb.min.css"
  rel="stylesheet"
/>

JS

<!-- MDB -->
<script
  type="text/javascript"
  src="https://cdnjs.cloudflare.com/ajax/libs/mdb-ui-kit/3.3.0/mdb.min.js"
></script>

Customization

Basic example

You can automatically initialize the stepper component using data-mdb-stepper="stepper".

HTML

<ul class="stepper" data-mdb-stepper="stepper">
  <li class="stepper-step stepper-active">
    <div class="stepper-head">
      <span class="stepper-head-icon"> 1 </span>
      <span class="stepper-head-text"> step1 </span>
    </div>
    <div class="stepper-content py-3">
      <span>
        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
        incididunt ut labore et dolore magna aliqua</span
      >
    </div>
  </li>
  <li class="stepper-step">
    <div class="stepper-head">
      <span class="stepper-head-icon"> 2 </span>
      <span class="stepper-head-text"> step2 </span>
    </div>
    <div class="stepper-content py-3">
      Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
      ex ea commodo consequat
    </div>
  </li>
  <li class="stepper-step">
    <div class="stepper-head">
      <span class="stepper-head-icon"> 3 </span>
      <span class="stepper-head-text"> step3 </span>
    </div>
    <div class="stepper-content py-3">
      Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
      fugiat nulla pariatur
    </div>
  </li>
</ul>

Change steps using external elements

To go to the next or previous step, you can use the nextStep and previousStep methods. You can also choose a specific step using the changeStep method by entering the step index.

HTML

<div class="mb-3">
  <button id="prev-step" class="btn btn-primary">prev</button>
  <button id="step-1" class="btn btn-primary">step1</button>
  <button id="step-2" class="btn btn-primary">step2</button>
  <button id="step-3" class="btn btn-primary">step3</button>
  <button id="next-step" class="btn btn-primary">next</button>
</div>
<div>
  <ul class="stepper" id="stepper-buttons">
    <li class="stepper-step stepper-active">
      <div class="stepper-head">
        <span class="stepper-head-icon"> 1 </span>
        <span class="stepper-head-text"> step1 </span>
      </div>
      <div class="stepper-content py-3">
        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
        incididunt ut labore et dolore magna aliqua
      </div>
    </li>
    <li class="stepper-step">
      <div class="stepper-head">
        <span class="stepper-head-icon"> 2 </span>
        <span class="stepper-head-text"> step2 </span>
      </div>
      <div class="stepper-content py-3">
        Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip
        ex ea commodo consequat
      </div>
    </li>
    <li class="stepper-step">
      <div class="stepper-head">
        <span class="stepper-head-icon"> 3 </span>
        <span class="stepper-head-text"> step3 </span>
      </div>
      <div class="stepper-content py-3">
        Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
        fugiat nulla pariatur
      </div>
    </li>
  </ul>
</div>

JS

const stepper = new mdb.Stepper(document.getElementById('stepper-buttons'));

document.getElementById('next-step').addEventListener('click', () => {
  stepper.nextStep();
});

document.getElementById('prev-step').addEventListener('click', () => {
  stepper.previousStep();
});

document.getElementById('step-1').addEventListener('click', () => {
  stepper.changeStep(0);
});

document.getElementById('step-2').addEventListener('click', () => {
  stepper.changeStep(1);
});

document.getElementById('step-3').addEventListener('click', () => {
  stepper.changeStep(2);
});

You can see more customization examples on the 📄 Stepper documentation page

Crucial Resources

Here are the resources that we have prepared to help you work with this component:

Read 📄 Stepper documentation page <-- start here
In to get the most out of your project, you should also get acquainted with other Components options related to Stepper. See the section below to find the list of them.
You can use predesigned Components in 📥 Starter Bootstrap 5 templates
Templates are a part of 📦 Free UI Kit for Bootstrap 5
After finishing the project you can publish it with CLI in order to receive 💽 Free hosting (beta)