aboutsummaryrefslogtreecommitdiff
path: root/docs/javascript.html
diff options
context:
space:
mode:
authorJacob Thornton <[email protected]>2012-01-21 21:35:20 -0800
committerJacob Thornton <[email protected]>2012-01-21 21:35:20 -0800
commit2187e0838f522c102a8b5104970a9f129cdd001a (patch)
tree7d429062295f5142ddac443967ef8093d83be416 /docs/javascript.html
parent719713ca8730d92d3510e6d4a7cc542fd57fdeef (diff)
downloadbootstrap-2187e0838f522c102a8b5104970a9f129cdd001a.tar.xz
bootstrap-2187e0838f522c102a8b5104970a9f129cdd001a.zip
change scrollspy offset to be option + fix typo in scrollspy
Diffstat (limited to 'docs/javascript.html')
-rw-r--r--docs/javascript.html23
1 files changed, 21 insertions, 2 deletions
diff --git a/docs/javascript.html b/docs/javascript.html
index fb854d281..1b8af662a 100644
--- a/docs/javascript.html
+++ b/docs/javascript.html
@@ -549,7 +549,7 @@ $('#myModal').on('hidden', function () {
</div>
</div>
</div>
- <div data-spy="scroll" data-target="#navbarExample" class="scrollspy-example">
+ <div data-spy="scroll" data-target="#navbarExample" data-offset="0" class="scrollspy-example">
<h4 id="fat">@fat</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.
@@ -576,11 +576,30 @@ $('#myModal').on('hidden', function () {
<hr>
<h2>Using bootstrap-scrollspy.js</h2>
<p>Call the scrollspy via javascript:</p>
- <pre class="prettyprint linenums">$('#navbar').dropdown()</pre>
+ <pre class="prettyprint linenums">$('#navbar').scrollspy()</pre>
<h3>Markup</h3>
<p>To easily add scrollspy behavior to your topbar navigation, just add <code>data-spy="scroll"</code> to the element you want to spy on (most typically this would be the body).
<pre class="prettyprint linenums">&lt;body data-spy="scroll" &gt;...&lt;/body&gt;</pre>
<p><span class="label notice">Notice</span> Navbar anchor tags 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>.
+ <h3>Options</h3>
+ <table class="table table-bordered table-striped">
+ <thead>
+ <tr>
+ <th style="width: 100px;">Name</th>
+ <th style="width: 100px;">type</th>
+ <th style="width: 50px;">default</th>
+ <th>description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>offset</td>
+ <td>number</td>
+ <td>10</td>
+ <td>Pixels to offset from top when calculating position of scroll.</td>
+ </tr>
+ </tbody>
+ </table>
</div>
</div>
</section>