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 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.
Example in navbar
Scroll the area below the navbar and watch the active class change. The dropdown items will be highlighted as well.
@fat
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.
@mdo
Veniam marfa mustache skateboard, adipisicing fugiat velit pitchfork beard. Freegan beard aliqua cupidatat mcsweeney's
vero. Cupidatat four loko nisi, ea helvetica nulla carles. Tattooed cosby sweater food truck, mcsweeney's quis
non freegan vinyl. Lo-fi wes anderson +1 sartorial. Carles non aesthetic exercitation quis gentrify. Brooklyn
adipisicing craft beer vice keytar deserunt.
one
Occaecat commodo aliqua delectus. Fap craft beer deserunt skateboard ea. Lomo bicycle rights adipisicing banh mi,
velit ea sunt next level locavore single-origin coffee in magna veniam. High life id vinyl, echo park consequat
quis aliquip banh mi pitchfork. Vero VHS est adipisicing. Consectetur nisi DIY minim messenger bag. Cred ex in,
sustainable delectus consectetur fanny pack iphone.
two
In incididunt echo park, officia deserunt mcsweeney's proident master cleanse thundercats sapiente veniam. Excepteur
VHS elit, proident shoreditch +1 biodiesel laborum craft beer. Single-origin coffee wayfarers irure four loko,
cupidatat terry richardson master cleanse. Assumenda you probably haven't heard of them art party fanny pack,
tattooed nulla cardigan tempor ad. Proident wolf nesciunt sartorial keffiyeh eu banh mi sustainable. Elit wolf
voluptate, lo-fi ea portland before they sold out four loko. Locavore enim nostrud mlkshk brooklyn nesciunt.
three
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.
Keytar twee blog, culpa messenger bag marfa whatever delectus food truck. Sapiente synth id assumenda. Locavore sed
helvetica cliche irony, thundercats you probably haven't heard of them consequat hoodie gluten-free lo-fi fap
aliquip. Labore elit placeat before they sold out, terry richardson proident brunch nesciunt quis cosby sweater
pariatur keffiyeh ut helvetica artisan. Cardigan craft beer seitan readymade velit. VHS chambray laboris tempor
veniam. Anim mollit minim commodo ullamco thundercats.
Example with nested nav
Scrollspy also works with nested
.nav
s. 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.
Example with list-group
Scrollspy also works with .list-group
s. Scroll the area next to the list group and watch the active class change.
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.
Via JavaScript
After adding position: relative;
in your CSS, call the scrollspy via JavaScript:
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
When using scrollspy in conjunction with adding or removing of elements from the DOM, you’ll need to call the refresh method like so:
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 top when calculating position of scroll. |
Events
Event Type |
Description |
activate.bs.scrollspy |
This event fires on the scroll element whenever a new item becomes activated by the scrollspy. |