diff --git a/docs/_includes/js/scrollspy.html b/docs/_includes/js/scrollspy.html index 25f5671c4f..dc89006861 100644 --- a/docs/_includes/js/scrollspy.html +++ b/docs/_includes/js/scrollspy.html @@ -55,6 +55,14 @@

Requires Bootstrap nav

Scrollspy currently requires the use of a Bootstrap nav component for proper highlighting of active links.

+
+

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.

+

Requires relative positioning

No matter the implementation method, scrollspy requires the use of position: relative; on the element you're spying on. In most cases this is the <body>.

@@ -84,14 +92,6 @@ body { $('body').scrollspy({ target: '.navbar-example' }) {% endhighlight %} -
-

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')