document that non-:visible scrollspy targets are ignored; fixes #13394

This commit is contained in:
Chris Rebert 2014-04-21 16:42:22 -07:00
parent 9c4afc5772
commit 6161c98238
1 changed files with 4 additions and 0 deletions

View File

@ -83,6 +83,10 @@ $('body').scrollspy({ target: '.navbar-example' })
<h4>Resolvable ID targets required</h4>
<p>Navbar links must have resolvable id targets. For example, a <code>&lt;a href="#home"&gt;home&lt;/a&gt;</code> must correspond to something in the DOM like <code>&lt;div id="home"&gt;&lt;/div&gt;</code>.</p>
</div>
<div class="bs-callout bs-callout-info">
<h4>Non-<code>:visible</code> target elements ignored</h4>
<p>Target elements that are not <a href="http://api.jquery.com/visible-selector/"><code>:visible</code> according to jQuery</a> will be ignored and their corresponding nav items will never be highlighted.</p>
</div>
<h3>Methods</h3>
<h4>.scrollspy('refresh')</h4>