DEV Community

loading...
Cover image for Bootstrap 5 Scrollspy

Bootstrap 5 Scrollspy

mdbootstrap profile image MD Bootstrap ・Updated on ・4 min read

What is Bootstrap Scrollspy?

Using this component you can highlight where the user is on a page by updating links in navigation based on scroll position. Works perafectly with smooth scroll.


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 
Enter fullscreen mode Exit fullscreen mode
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 
Enter fullscreen mode Exit fullscreen mode
Importing CSS file

To import MDB stylesheet please use the following syntax:

@import '~mdb-ui-kit/css/mdb.min.css'; 
Enter fullscreen mode Exit fullscreen mode
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"
/>
Enter fullscreen mode Exit fullscreen mode
JS
<!-- MDB -->
<script
  type="text/javascript"
  src="https://cdnjs.cloudflare.com/ajax/libs/mdb-ui-kit/3.3.0/mdb.min.js"
></script>
Enter fullscreen mode Exit fullscreen mode

How it works

Scrollspy has a few requirements to function properly:

  • It must be used on a Bootstrap nav component or list group.
  • Scrollspy requires position: relative; on the element you’re spying on, usually the <body>.
  • When spying on elements other than the <body>, be sure to have a height set and overflow-y: scroll; applied.
  • Anchors (<a>) are required and must point to an element with that id.

When successfully implemented, your nav or list group will update accordingly, moving the .active class from one item to the next based on their associated targets.


Customization

Basic example
<div class="row">
  <div class="col-md-8">
    <!-- Spied element -->
    <div
      data-mdb-spy="scroll"
      data-mdb-target="#scrollspy1"
      data-mdb-offset="0"
      class="scrollspy-example"
    >
      <section id="example-1">
        <h3>Section 1</h3>
        ...
      </section>
      <section id="example-2">
        <h3>Section 2</h3>
        ...
      </section>
      <section id="example-3">
        <h3>Section 3</h3>
        ...
        <section id="example-sub-A">
          <h3>Subsection A</h3>
          ...
        </section>
        <section id="example-sub-B">
          <h3>Subsection B</h3>
          ...
        </section>
      </section>
      <section id="example-4">
        <h3>Section 4</h3>
        ...
      </section>
    </div>
    <!-- Spied element -->
  </div>

  <div class="col-md-4">
    <!-- Scrollspy -->
    <div id="scrollspy1" class="sticky-top">
      <ul class="nav flex-column nav-pills menu-sidebar">
        <li class="nav-item">
          <a class="nav-link" href="#example-1">Section 1</a>
        </li>
        <li class="nav-item">
          <a class="nav-link" href="#example-2">Section 2</a>
        </li>
        <li class="nav-item">
          <a class="nav-link" href="#example-3">Section 3</a>
          <ul class="nav flex-column ps-3">
            <li class="nav-item">
              <a class="nav-link" href="#example-sub-A">Subsection A</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="#example-sub-B">Subsection B</a>
            </li>
          </ul>
        </li>
        <li class="nav-item">
          <a class="nav-link" href="#example-4">Section 4</a>
        </li>
      </ul>
    </div>
    <!-- Scrollspy -->
  </div>
</div>
Enter fullscreen mode Exit fullscreen mode
.scrollspy-example {
  position: relative;
  height: 200px;
  overflow: auto;
}
Enter fullscreen mode Exit fullscreen mode

You can see more customization examples on the πŸ“„ Scrollspy documentation page


Crucial Resources

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

  1. Read πŸ“„ Scrollspy documentation page <-- start here
  2. In to get the most out of your project, you should also get acquainted with other Navigation options related to Scrollspy. See the section below to find the list of them.
  3. You can use predesigned Navigation elements in πŸ“₯ Starter Bootstrap 5 templates
  4. Templates are a part of πŸ“¦ Free UI Kit for Bootstrap 5
  5. After finishing the project you can publish it with CLI in order to receive πŸ’½ Free hosting (beta)

Related Content and Styles options & features


Learn Bootstrap 5 in 1.5H


Additional resources

Learn web development with our learning roadmap:
πŸŽ“ Start Learning

Join our mailing list & receive exclusive resources for developers
🎁 Get gifts

Join our private FB group for inspiration & community experience
πŸ‘¨β€πŸ‘©β€πŸ‘§β€πŸ‘¦ Ask to join

Support creation of open-source packages with a STAR on GitHub
GitHub Stars

Discussion (0)

Forem Open with the Forem app