Rate this docs

Scrollspy MDB Pro component

Bootstrap scrollspy

Automatically update Bootstrap navigation or list group components based on scroll position to indicate which link is currently active in the viewport.


How it works

Scrollspy has a few requirements to function properly:

  • If you’re building our JavaScript from source, it requires util.js.
  • It must be used on a nav component or a 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.



Example with nested nav

Scrollspy also works with nested .navs. If a nested .nav is .active, its parents will also be .active. Scroll the area next to the navbar and watch the active class change.

Item 1

Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.

Item 1-1

Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.

Item 2-2

Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.

Item 2

Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.

Item 3

Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.

Item 3-1

Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.

Item 3-2

Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.



        <div class="row">
          <div class="col-sm-4 col-lg-3">
            <nav id="navbar-example3" class="navbar navbar-light bg-light flex-column mt-4">
              <a class="navbar-brand" href="#">Navbar</a>
              <nav class="nav nav-pills flex-column">
                <a class="nav-link active" href="#item-1">Item 1</a>
                <nav class="nav nav-pills flex-column">
                  <a class="nav-link ml-3 my-1" href="#item-1-1">Item 1-1</a>
                  <a class="nav-link ml-3 my-1" href="#item-1-2">Item 1-2</a>
                </nav>
                <a class="nav-link" href="#item-2">Item2</a>
                <a class="nav-link" href="#item-3">Item3</a>
                <nav class="nav nav-pills flex-column">
                  <a class="nav-link ml-3 my-1" href="#item-3-1">Item 3-1</a>
                  <a class="nav-link ml-3 my-1" href="#item-3-2">Item 3-2</a>
                </nav>
              </nav>
            </nav>
          </div>

          <div class="col-sm-8 col-lg-9">
            <div data-spy="scroll" class="scrollspy-example z-depth-1 mt-4" data-target="#navbar-example3" data-offset="0">
              <h4 id="item-1">Item 1</h4>
              <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out
                qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan
                mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim
                qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic.
                Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p>
              <h5 id="item-1-1">Item 1-1</h5>
              <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out
                qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan
                mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim
                qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic.
                Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p>
              <h5 id="item-1-2">Item 2-2</h5>
              <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out
                qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan
                mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim
                qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic.
                Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p>
              <h4 id="item-2">Item 2</h4>
              <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out
                qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan
                mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim
                qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic.
                Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p>
              <h4 id="item-3">Item 3</h4>
              <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out
                qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan
                mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim
                qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic.
                Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p>
              <h5 id="item-3-1">Item 3-1</h5>
              <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out
                qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan
                mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim
                qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic.
                Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p>
              <h5 id="item-3-2">Item 3-2</h5>
              <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out
                qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan
                mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim
                qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic.
                Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p>
            </div>
          </div>
        </div>

      


        .scrollspy-example {
        height: 360px;
        }

      

Example with list-group

Scrollspy also works with .list-groups. Scroll the area next to the list group and watch the active class change.

Item 1

Ex consequat commodo adipisicing exercitation aute excepteur occaecat ullamco duis aliqua id magna ullamco eu. Do aute ipsum ipsum ullamco cillum consectetur ut et aute consectetur labore. Fugiat laborum incididunt tempor eu consequat enim dolore proident. Qui laborum do non excepteur nulla magna eiusmod consectetur in. Aliqua et aliqua officia quis et incididunt voluptate non anim reprehenderit adipisicing dolore ut consequat deserunt mollit dolore. Aliquip nulla enim veniam non fugiat id cupidatat nulla elit cupidatat commodo velit ut eiusmod cupidatat elit dolore.

Item 2

Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex nulla tempor. Laborum consequat non elit enim exercitation cillum aliqua consequat id aliqua. Esse ex consectetur mollit voluptate est in duis laboris ad sit ipsum anim Lorem. Incididunt veniam velit elit elit veniam Lorem aliqua quis ullamco deserunt sit enim elit aliqua esse irure. Laborum nisi sit est tempor laborum mollit labore officia laborum excepteur commodo non commodo dolor excepteur commodo. Ipsum fugiat ex est consectetur ipsum commodo tempor sunt in proident.

Item 3

Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.

Item 4

Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum fugiat minim proident occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.



        <div class="row">
          <div class="col-4">
            <div id="list-example" class="list-group">
              <a class="list-group-item list-group-item-action active" href="#list-item-1">Item 1</a>
              <a class="list-group-item list-group-item-action" href="#list-item-2">Item2</a>
              <a class="list-group-item list-group-item-action" href="#list-item-3">Item 3</a>
              <a class="list-group-item list-group-item-action" href="#list-item-4">Item 4</a>
            </div>
          </div>
          <div class="col-8">
            <div data-spy="scroll" data-target="#list-example" data-offset="0" class="scrollspy-example z-depth-1">
              <h4 id="list-item-1">Item 1</h4>
              <p>Ex consequat commodo adipisicing exercitation aute excepteur occaecat ullamco duis aliqua id magna
                ullamco eu. Do aute ipsum ipsum ullamco cillum consectetur ut et aute consectetur labore. Fugiat
                laborum incididunt tempor eu consequat enim dolore proident. Qui laborum do non excepteur nulla magna
                eiusmod consectetur in. Aliqua et aliqua officia quis et incididunt voluptate non anim reprehenderit
                adipisicing dolore ut consequat deserunt mollit dolore. Aliquip nulla enim veniam non fugiat id
                cupidatat nulla elit cupidatat commodo velit ut eiusmod cupidatat elit dolore.</p>
              <h4 id="list-item-2">Item 2</h4>
              <p>Quis magna Lorem anim amet ipsum do mollit sit cillum voluptate ex nulla tempor. Laborum consequat non
                elit enim exercitation cillum aliqua consequat id aliqua. Esse ex consectetur mollit voluptate est in
                duis laboris ad sit ipsum anim Lorem. Incididunt veniam velit elit elit veniam Lorem aliqua quis
                ullamco deserunt sit enim elit aliqua esse irure. Laborum nisi sit est tempor laborum mollit labore
                officia laborum excepteur commodo non commodo dolor excepteur commodo. Ipsum fugiat ex est consectetur
                ipsum commodo tempor sunt in proident.</p>
              <h4 id="list-item-3">Item 3</h4>
              <p>Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum
                fugiat minim proident occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor
                mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.</p>
              <h4 id="list-item-4">Item 4</h4>
              <p>Quis anim sit do amet fugiat dolor velit sit ea ea do reprehenderit culpa duis. Nostrud aliqua ipsum
                fugiat minim proident occaecat excepteur aliquip culpa aute tempor reprehenderit. Deserunt tempor
                mollit elit ex pariatur dolore velit fugiat mollit culpa irure ullamco est ex ullamco excepteur.</p>
            </div>
          </div>
        </div>

      


        .scrollspy-example {
        height: 360px;
        }
      

MDB Scrollspy

Section 1

Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores asperiores earum quis!


Subsection 1A

Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores asperiores earum quis!


Subsection 1B

Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores asperiores earum quis!


Subsection 1C

Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores asperiores earum quis!

Section 2

Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores asperiores earum quis!


Subsection 2A

Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores asperiores earum quis!


Subsection 2B

Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores asperiores earum quis!


Subsection 2C

Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores asperiores earum quis!



      <!--Grid row-->
      <div class="row">

        <!--Grid column-->

        <div class="col-md-8">

          <!--Spied element-->
          <div class="scrollspy-example
   z-depth-1 text-center p-0" data-spy="scroll" data-target="#mdb-scrollspy-ex"
            data-offset="0">


            <section id="section1" class="blue lighten-4">

              <h3>

                <strong>Section 1</strong>
              </h3>
              <p>Lorem ipsum dolor sit amet consectetur adipisicing
                elit. Dolorem ipsa at provident qui doloremque
                libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi
                officiis quasi dolores
                asperiores earum quis!</p>
              <hr>
              <section id="subsection1A" class=" m-4 red lighten-4">
                <h4>
                  Subsection 1A
                </h4>
                <p>Lorem
                  ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque
                  libero quo non pariatur
                  quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores
                  asperiores earum quis!</p>
              </section>

              <hr>
              <section id="subsection1B" class=" m-4 green lighten-4">
                <h4>

                  Subsection 1B
                </h4>
                <p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa
                  at provident qui doloremque
                  libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi
                  dolores
                  asperiores earum quis!</p>
              </section>
              <hr>
              <section id="subsection1C" class=" m-4 indigo lighten-4">
                <h4>
                  Subsection 1C

                </h4>
                <p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque

                  libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores
                  asperiores earum quis!</p>

              </section>
            </section>
            <section id="section2" class="blue lighten-4">

              <h3>
                <strong>Section 2</strong>
              </h3>
              <p>Lorem ipsum dolor sit
                amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque
                libero quo non pariatur quaerat iure,
                nostrum, possimus vitae sequi officiis quasi dolores
                asperiores earum quis!</p>
              <hr>

              <section id="subsection2A" class=" m-4 red lighten-4">
                <h4>
                  Subsection
                  2A
                </h4>
                <p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident
                  qui doloremque
                  libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores

                  asperiores earum quis!</p>
              </section>
              <hr>
              <section id="subsection2B" class=" m-4 green lighten-4">
                <h4>
                  Subsection 2B
                </h4>
                <p>Lorem
                  ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa at provident qui doloremque
                  libero quo non pariatur
                  quaerat iure, nostrum, possimus vitae sequi officiis quasi dolores
                  asperiores earum quis!</p>
              </section>

              <hr>
              <section id="subsection2C" class=" m-4 indigo lighten-4">
                <h4>

                  Subsection 2C
                </h4>
                <p>Lorem ipsum dolor sit amet consectetur adipisicing elit. Dolorem ipsa
                  at provident qui doloremque
                  libero quo non pariatur quaerat iure, nostrum, possimus vitae sequi officiis quasi
                  dolores
                  asperiores earum quis!</p>
              </section>
            </section>


          </div>
          <!--/.Spied element-->

        </div>
        <!--Grid column-->


        <!--Grid column-->
        <div class="col-md-3 mb-4">

          <!--Scrollspy-->

          <div id="mdb-scrollspy-ex">

            <!-- Links -->
            <ul class="nav nav-pills
   default-pills smooth-scroll">
              <li class="nav-item">
                <a class="nav-link" href="#section1">Section 1</a>
                <ul class="nav ml-3">
                  <li class="nav-item">

                    <a class="nav-link" href="#subsection1A">Subsection 1A</a>
                  </li>

                  <li class="nav-item">
                    <a class="nav-link" href="#subsection1B">Subsection
                      1B</a>
                  </li>
                  <li class="nav-item">
                    <a class="nav-link" href="#subsection1C">Subsection 1C</a>
                  </li>
                </ul>
              </li>

              <li class="nav-item">
                <a class="nav-link" href="#section1">Section 2</a>

                <ul class="nav ml-3">
                  <li class="nav-item">
                    <a class="nav-link" href="#subsection2A">Subsection 2A</a>
                  </li>
                  <li class="nav-item">

                    <a class="nav-link" href="#subsection2B">Subsection 2B</a>
                  </li>

                  <li class="nav-item">
                    <a class="nav-link" href="#subsection2C">Subsection
                      2C</a>
                  </li>
                </ul>
              </li>
            </ul>
            <!-- Links
   -->

          </div>
          <!--Scrollspy-->

        </div>
        <!--Grid
   column-->

      </div>
      <!--Grid row-->

    


      #mdb-scrollspy-ex .nav-item {
      width: 100%;
      }

      #mdb-scrollspy-ex a {
      font-size: .8rem;
      font-weight: 400;
      line-height: 1.1rem;
      padding: 0 5px;
      margin-top: 3px;
      margin-bottom: 3px;
      color: black;
      }

      #mdb-scrollspy-ex li .active {
      font-weight: 600;
      }

      .mdb-scrollspy-ex-example {
      height: 200px;
      }

    

Dotted Scrollspy

Making the navigation more informative and intuitive is still a challenge to most of the developers.

Thanks to dotted ScrollSpy, this issue is simply resolved with a use of a sticking elements that indicate on which part of the page your users are and how much longer they can expect the website to be.

Another invaluable option coming with dotted ScrollSpy is the ability to swiftly switch between desired parts of your webpage with just one click.

Live Demo


        <section id="one"></section>
        <section id="two"></section>
        <section id="three"></section>
        <section id="four"></section>
        <section id="five"></section>
        <section id="six"></section>

        <!-- Scrollspy -->
        <div class="dotted-scrollspy">
          <ul class="nav smooth-scroll clearfix d-none d-sm-flex flex-column">
            <li class="nav-item"><a class="nav-link" href="#one"><span></span></a></li>
            <li class="nav-item"><a class="nav-link" href="#two"><span></span></a></li>
            <li class="nav-item"><a class="nav-link" href="#three"><span></span></a></li>
            <li class="nav-item"><a class="nav-link" href="#four"><span></span></a></li>
            <li class="nav-item"><a class="nav-link" href="#five"><span></span></a></li>
            <li class="nav-item"><a class="nav-link" href="#six"><span></span></a></li>
          </ul>
        </div>

      


        $('body').scrollspy({
        target: '.dotted-scrollspy'
        });
      

Usage


Via data attributes

To easily add scrollspy behavior to your topbar navigation, add data-spy="scroll" to the element you want to spy on (most typically this would be the <body>). Then add the data-target attribute with the ID or class of the parent element of any Bootstrap .nav component.



        <body data-spy="scroll" data-target="#navbar-example">
          ...
          <div id="navbar-example">
            <ul class="nav nav-tabs" role="tablist">
              ...
            </ul>
          </div>
          ...
        </body>
      

        body {
        position: relative;
        }
      

Via JavaScript


        $('body').scrollspy({ target: '#navbar-example' })
      

Resolvable ID targets required

Navbar links must have resolvable id targets. For example, a <a href="#home">home</a> must correspond to something in the DOM like <div id="home"></div>.

Non- :visible target elements ignored

Target elements that are not :visible according to jQuery will be ignored and their corresponding nav items will never be highlighted.

Methods

.scrollspy('refresh')

When using scrollspy in conjunction with adding or removing of elements from the DOM, you’ll need to call the refresh method like so:


        $('[data-spy="scroll"]').each(function () {
        var $spy = $(this).scrollspy('refresh')
        })
      
.scrollspy('dispose')

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-offset="".

Name Type Default Description
offset number 10 Pixels to offset from the top when calculating the position of scroll.

Events

Event Type Description
activate.bs.scrollspy This event fires whenever a new item becomes activated by the scrollspy.

    $('#myScrollspy').on('activate.bs.scrollspy', function () {
    // do something…
    })
  

Getting started : download & setup


Download

All the components and features are part of MDBootstrap package.

MDBootstrap (Material Design for Bootstrap) is a free (MIT Licensed) framework combining Material Design and the newest Bootstrap 4.

Click the button below to go to Download Page, where you can download MDBootstrap package.

MDBootstrap Download MDBootstrap About

MDB Pro

Using components and features labeled as MDB Pro component requires MDB Pro package.

Click the button below to learn more about MDBbootstrap Pro package

MDBootstrap Pro

Tutorials

If you need additional help to start, use our "5 min Quick Start" or "Full tutorial" resources.

5 min Quick Start Full Tutorial

Compilation

To reduce a weight of MDBootstrap package, you can compile your own, custom package containing only components and features you need.

Map of dependencies of SCSS files in MDBootstrap:


    Legend:

    '-->' means 'required'

    All free and pro files require files from 'core' catalog

    'none' means 'this component doesn't require anything except core files'

    A file wrapped by `< >` means that this file make the base component prettier but it isn't necessary for the proper working

    All PRO components require 'pro/_variables.scss' file

    scss/
    |
    |-- core/
    |   |
    |   |-- bootstrap/
    |   |	|-- _functions.scss
    |   |	|-- _variables.scss
    |   |
    |   |-- _colors.scss
    |   |-- _global.scss
    |   |-- _helpers.scss
    |   |-- _masks.scss
    |   |-- _mixins.scss
    |   |-- _typography.scss
    |   |-- _variables.scss
    |   |-- _waves.scss
    |
    |-- free/
    |   |-- _animations-basic.scss --> none
    |   |-- _animations-extended.scss --> _animations-basic.scss
    |   |-- _buttons.scss --> none
    |   |-- _cards.scss --> none <_buttons.scss>
    |   |-- _dropdowns.scss --> none <_buttons.scss>
    |   |-- _input-group.scss --> _forms.scss, _buttons.scss, _dropdowns.scss
    |   |-- _navbars.scss --> none <_buttons.scss, _forms.scss, _input-group.scss>
    |   |-- _pagination.scss --> none
    |   |-- _badges.scss --> none
    |   |-- _modals.scss --> _buttons.scss, _forms.scss (PRO --> _tabs.scss)
    |   |-- _carousels.scss --> <_buttons.scss>
    |   |-- _forms.scss --> none
    |   |-- _msc.scss --> none <_buttons.scss, _forms.scss, _cards.scss>
    |   |-- _footers.scss none <_buttons.scss> (PRO: )
    |   |-- _list-group.scss --> none
    |   |-- _tables.scss --> none (PRO: _material-select.scss, pro/_forms.scss, _checkbox.scss, pro/_buttons.scss, pro/_cards.scss, _pagination.scss, pro/_msc.scss)
    |   |-- _depreciated.scss
    |
    |-- pro/
    |   |
    |   |-- picker/
    |   |   |-- _default.scss --> none
    |   |   |-- _default-time.scss --> _default.scss, free/_forms.scss, free/_buttons.scss, pro/_buttons.scss, free/_cards.scss
    |   |   |-- _default-date.scss --> _default.scss, free/_forms.scss
    |   |
    |   |-- sections/
    |   |   |-- _templates.scss --> _sidenav.scss
    |   |   |-- _social.scss --> free/_cards.scss, free/ _forms.scss, free/_buttons.scss, pro/_buttons.scss,
    |   |   |-- _team.scss --> free/_buttons.scss, pro/_buttons.scss, free/_cards.scss, pro/_cards.scss
    |   |   |-- _testimonials.scss --> free/_carousels.scss, pro/_carousels.scss, free/_buttons.scss, pro/_buttons.scss
    |   |   |-- _magazine.scss --> _badges.scss
    |   |   |-- _pricing.scss --> free/_buttons.scss, pro/_buttons.scss
    |   |   |-- _contacts.scss --> free/_forms.scss, pro/_forms.scss, free/_buttons.scss, pro/_buttons.scss
    |   |
    |   |-- _variables.scss
    |   |-- _buttons.scss --> free/_buttons.scss, pro/_msc.scss, _checkbox.scss, _radio.scss
    |   |-- _social-buttons.scss --> free/_buttons.scss, pro/_buttons.scss
    |   |-- _tabs.scss --> _cards.scss
    |   |-- _cards.scss --> free/_cards.scss <_buttons.scss, _social-buttons.scss>
    |   |-- _dropdowns.scss --> free/_dropdowns.scss, free/_buttons.scss
    |   |-- _navbars.scss --> free/_navbars.scss  (PRO: )
    |   |-- _scrollspy.scss --> none
    |   |-- _lightbox.scss --> none
    |   |-- _chips.scss --> none
    |   |-- _msc.scss --> none
    |   |-- _forms.scss --> none
    |   |-- _radio.scss --> none
    |   |-- _checkbox.scss --> none
    |   |-- _material-select.scss --> none
    |   |-- _switch.scss --> none
    |   |-- _file-input.scss --> free/_forms.scss, free/_buttons.scss
    |   |-- _range.scss --> none
    |   |-- _input-group.scss --> free/_input-group.scss and the same what free input group, _checkbox.scss, _radio.scss
    |   |-- _autocomplete.scss --> free/_forms.scss
    |   |-- _accordion.scss --> pro/_animations.scss, free/_cards.scss
    |   |-- _parallax.scss --> none
    |   |-- _sidenav.scss --> free/_forms.scss, pro/_animations.scss, sections/_templates.scss
    |   |-- _ecommerce.scss --> free/_cards.scss, pro/_cards.scss, free/_buttons.scss, pro/_buttons.scss, pro/_msc.scss
    |   |-- _carousels.scss --> free/_carousels.scss, free/_cards.scss, free/_buttons.scss 
    |   |-- _steppers.scss --> free/_buttons.scss
    |   |-- _blog.scss --> none
    |   |-- _toasts.scss --> free/_buttons.scss
    |   |-- _animations.scss --> none
    |   |-- _charts.scss --> none
    |   |-- _progress.scss --> none
    |   |-- _scrollbar.scss --> none
    |   |-- _skins.scss --> none
    |   |-- _depreciated.scss
    |
    `-- _custom-skin.scss
    `-- _custom-styles.scss
    `-- _custom-variables.scss
    `-- mdb.scss

  

Map of dependencies of JavaScript modules in MDBootstrap:


    Legend:

    '-->' means 'required'

    All files require jQuery and bootstrap.js

    js/
    ├── dist/
    │   ├── buttons.js
    │   ├── cards.js
    │   ├── character-counter.js
    │   ├── chips.js
    │   ├── collapsible.js --> vendor/velocity.js
    │   ├── dropdown.js --> Popper.js, jquery.easing.js
    │   ├── file-input.js
    │   ├── forms-free.js
    │   ├── material-select.js --> dropdown.js
    │   ├── mdb-autocomplete.js
    │   ├── preloading.js
    │   ├── range-input.js --> vendor/velocity.js
    │   ├── scrolling-navbar.js
    │   ├── sidenav.js --> vendor/velocity.js, vendor/hammer.js, vendor/jquery.hammer.js
    │   └── smooth-scroll.js
    ├── _intro-mdb-pro.js
    ├── modules.js
    ├── src/
    │   ├── buttons.js
    │   ├── cards.js
    │   ├── character-counter.js
    │   ├── chips.js
    │   ├── collapsible.js --> vendor/velocity.js
    │   ├── dropdown.js --> Popper.js, jquery.easing.js
    │   ├── file-input.js
    │   ├── forms-free.js
    │   ├── material-select.js --> dropdown.js
    │   ├── mdb-autocomplete.js
    │   ├── preloading.js
    │   ├── range-input.js --> vendor/velocity.js
    │   ├── scrolling-navbar.js
    │   ├── sidenav.js --> vendor/velocity.js, vendor/hammer.js, vendor/jquery.hammer.js
    │   └── smooth-scroll.js
    └── vendor/
        ├── addons/
        │   ├── datatables.js
        │   └── datatables.min.js
        ├── chart.js
        ├── enhanced-modals.js
        ├── hammer.js
        ├── jarallax.js
        ├── jarallax-video.js --> vendor/jarallax.js
        ├── jquery.easing.js
        ├── jquery.easypiechart.js
        ├── jquery.hammer.js --> vendor/hammer.js
        ├── jquery.sticky.js
        ├── lightbox.js
        ├── picker-date.js --> vendor/picker.js
        ├── picker.js
        ├── picker-time.js --> vendor/picker.js
        ├── scrollbar.js
        ├── scrolling-navbar.js
        ├── toastr.js
        ├── velocity.js
        ├── waves.js
        └── wow.js
  

Compilation & Customization tutorial

If you need additional help to compile your custom package, use our Compilation & Customization tutorial

Compilation & Customization tutorial

Integrations with Angular, React or Vue

Apart from standard Bootstrap integration with jQuery, MDBootstrap provides integrations with Angular, React and Vue.

About MDB Angular About MDB React About MDB Vue