Scrollspy
Bootstrap scrollspy
Note: We are transitioning MDB4 to a legacy version and focusing on developing MDB5.
While we'll continue to support for the transition period, we encourage you to migrate to
MDB5. We're offering a huge discount on MDB5 PRO to help with your transition,
enabling you to leverage the full potential of the latest version. You can find more information here.
upgrade with discount
Scrollspy allows you to automatically update Bootstrap navigation or list group components based on the 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 aheight
set andoverflow-y: scroll
applied. - Anchors (
<a>
) are required and must point to an element with thatid
.
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 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 MDB Pro component
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 MDB Pro component
Making the navigation more informative and intuitive is still a challenge to most developers.
Thanks to dotted ScrollSpy, this issue is simply resolved with the use of sticking elements that indicate on which part of the page your users are, and how much longer they can expect the website to be loading.
Another invaluable option that comes with dotted ScrollSpy is the ability to swiftly switch between desired parts of your webpage with just one click.
<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 are 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 are ignoredTarget 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 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')
Destroys an element’s scrollspy.
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. |
method | string | auto | Finds which section the spied element is in. auto will choose the best method to get the scroll
coordinates. offset will use the jQuery offset method to get the scroll coordinates.
position will use the jQuery position method to get the scroll coordinates. |
target | string | Specifies the element to apply the Scrollspy plugin to. |
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…
})