javascript.mustache 81.9 KB
Newer Older
1
<!-- Subhead
2
================================================== -->
3
<header class="bs-docs-jumbotron subhead">
4
  <div class="container">
5
6
    <h1>JavaScript</h1>
    <p class="lead">Bring Bootstrap's components to life&mdash;now with 13 custom jQuery plugins.
7
  </div>
8
9
</header>

10
  <div class="container">
Jacob Thornton's avatar
Jacob Thornton committed
11

12
13
14
15
    <!-- Docs nav
    ================================================== -->
    <div class="row">
      <div class="span3 bs-docs-sidebar">
16
        <ul class="nav nav-list bs-docs-sidenav">
17
18
19
20
21
22
23
24
25
26
27
28
29
30
          <li><a href="#overview"><i class="glyphicon-chevron-right"></i> Overview</a></li>
          <li><a href="#transitions"><i class="glyphicon-chevron-right"></i> Transitions</a></li>
          <li><a href="#modals"><i class="glyphicon-chevron-right"></i> Modal</a></li>
          <li><a href="#dropdowns"><i class="glyphicon-chevron-right"></i> Dropdown</a></li>
          <li><a href="#scrollspy"><i class="glyphicon-chevron-right"></i> Scrollspy</a></li>
          <li><a href="#tabs"><i class="glyphicon-chevron-right"></i> Tab</a></li>
          <li><a href="#tooltips"><i class="glyphicon-chevron-right"></i> Tooltip</a></li>
          <li><a href="#popovers"><i class="glyphicon-chevron-right"></i> Popover</a></li>
          <li><a href="#alerts"><i class="glyphicon-chevron-right"></i> Alert</a></li>
          <li><a href="#buttons"><i class="glyphicon-chevron-right"></i> Button</a></li>
          <li><a href="#collapse"><i class="glyphicon-chevron-right"></i> Collapse</a></li>
          <li><a href="#carousel"><i class="glyphicon-chevron-right"></i> Carousel</a></li>
          <li><a href="#typeahead"><i class="glyphicon-chevron-right"></i> Typeahead</a></li>
          <li><a href="#affix"><i class="glyphicon-chevron-right"></i> Affix</a></li>
31
        </ul>
32
33
      </div>
      <div class="span9">
Jacob Thornton's avatar
Jacob Thornton committed
34
35


36
37
38
39
        <!-- Overview
        ================================================== -->
        <section id="overview">
          <div class="page-header">
40
            <h1>JavaScript in Bootstrap</h1>
41
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
42

43
44
          <h3>Individual or compiled</h3>
          <p>Plugins can be included individually (though some have required dependencies), or all at once. Both <strong>bootstrap.js</strong> and <strong>bootstrap.min.js</strong> contain all plugins in a single file.</p>
45

46
47
          <h3>Data attributes</h3>
          <p>You can use all Bootstrap plugins purely through the markup API without writing a single line of JavaScript. This is Bootstrap's first class API and should be your first consideration when using a plugin.</p>
Jacob Thornton's avatar
Jacob Thornton committed
48

49
          <p>That said, in some situations it may be desirable to turn this functionality off. Therefore, we also provide the ability to disable the data attribute API by unbinding all events on the body namespaced with `'data-api'`. This looks like this:
50
          <pre class="prettyprint linenums">$('body').off('.data-api')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
51

52
          <p>Alternatively, to target a specific plugin, just include the plugin's name as a namespace along with the data-api namespace like this:</p>
53
          <pre class="prettyprint linenums">$('body').off('.alert.data-api')</pre>
54

55
56
          <h3>Programmatic API</h3>
          <p>We also believe you should be able to use all Bootstrap plugins purely through the JavaScript API. All public APIs are single, chainable methods, and return the collection acted upon.</p>
57
          <pre class="prettyprint linenums">$(".btn.danger").button("toggle").addClass("fat")</pre>
58
          <p>All methods should accept an optional options object, a string which targets a particular method, or nothing (which initiates a plugin with default behavior):</p>
Jacob Thornton's avatar
Jacob Thornton committed
59
<pre class="prettyprint linenums">
60
61
62
$("#myModal").modal()                       // initialized with defaults
$("#myModal").modal({ keyboard: false })   // initialized with no keyboard
$("#myModal").modal('show')                // initializes and invokes show immediately</p>
Jacob Thornton's avatar
Jacob Thornton committed
63
</pre>
64
          <p>Each plugin also exposes its raw constructor on a `Constructor` property: <code>$.fn.popover.Constructor</code>. If you'd like to get a particular plugin instance, retrieve it directly from an element: <code>$('[rel=popover]').data('popover')</code>.</p>
65

66
          <h3>No conflict</h3>
Mark Otto's avatar
Mark Otto committed
67
          <p>Sometimes it is necessary to use Bootstrap plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call <code>.noConflict</code> on the plugin you wish to revert the value of.</p>
68
69
70
71
72
73

<pre class="prettyprint linenums">
var bootstrapButton = $.fn.button.noConflict() // return $.fn.button to previously assigned value
$.fn.bootstrapBtn = bootstrapButton            // give $().bootstrapBtn the bootstrap functionality
</pre>

74
75
          <h3>Events</h3>
          <p>Bootstrap provides custom events for most plugin's unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex. <code>show</code>) is triggered at the start of an event, and its past participle form (ex. <code>shown</code>) is trigger on the completion of an action.</p>
76
          <p>All infinitive events provide <code>preventDefault</code> functionality. This provides the ability to stop the execution of an action before it starts.</p>
Jacob Thornton's avatar
Jacob Thornton committed
77
<pre class="prettyprint linenums">
78
79
80
$('#myModal').on('show', function (e) {
    if (!data) return e.preventDefault() // stops modal from being shown
})
Jacob Thornton's avatar
Jacob Thornton committed
81
</pre>
82
        </section>
83
84
85



86
87
88
89
        <!-- Transitions
        ================================================== -->
        <section id="transitions">
          <div class="page-header">
90
            <h1>Transitions <small>bootstrap-transition.js</small></h1>
91
          </div>
92
93
94
95
          <h3>About transitions</h3>
          <p>For simple transition effects, include bootstrap-transition.js once alongside the other JS files. If you're using the compiled (or minified) bootstrap.js, there is no need to include this&mdash;it's already there.</p>
          <h3>Use cases</h3>
          <p>A few examples of the transition plugin:</p>
96
          <ul>
97
98
99
100
            <li>Sliding or fading in modals</li>
            <li>Fading out tabs</li>
            <li>Fading out alerts</li>
            <li>Sliding carousel panes</li>
101
          </ul>
102

103
104
          {{! Ideas: include docs for .fade.in, .slide.in, etc }}
        </section>
105

106
107


Mark Otto's avatar
Mark Otto committed
108
109
110
111
        <!-- Modal
        ================================================== -->
        <section id="modals">
          <div class="page-header">
112
            <h1>Modals <small>bootstrap-modal.js</small></h1>
Mark Otto's avatar
Mark Otto committed
113
          </div>
114

115

116
117
          <h2>Examples</h2>
          <p>Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.</p>
118

119
120
          <h3>Static example</h3>
          <p>A rendered modal with header, body, and set of actions in the footer.</p>
Mark Otto's avatar
Mark Otto committed
121
          <div class="bs-docs-example" style="background-color: #f5f5f5;">
122
            <div class="modal" style="position: relative; top: auto; left: auto; right: auto; margin: 0 auto 20px; z-index: 1; max-width: 100%;">
Mark Otto's avatar
Mark Otto committed
123
              <div class="modal-header">
124
                <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
125
                <h3>Modal header</h3>
126
              </div>
Mark Otto's avatar
Mark Otto committed
127
              <div class="modal-body">
128
                <p>One fine body&hellip;</p>
Mark Otto's avatar
Mark Otto committed
129
130
              </div>
              <div class="modal-footer">
131
132
                <a href="#" class="btn">Close</a>
                <a href="#" class="btn btn-primary">Save changes</a>
Mark Otto's avatar
Mark Otto committed
133
134
135
              </div>
            </div>
          </div>{{! /example }}
136
137
138
<pre class="prettyprint linenums">
&lt;div class="modal hide fade"&gt;
  &lt;div class="modal-header"&gt;
139
    &lt;button type="button" class="close" data-dismiss="modal" aria-hidden="true"&gt;&amp;times;&lt;/button&gt;
140
    &lt;h3&gt;Modal header&lt;/h3&gt;
141
142
  &lt;/div&gt;
  &lt;div class="modal-body"&gt;
143
    &lt;p&gt;One fine body&hellip;&lt;/p&gt;
144
145
  &lt;/div&gt;
  &lt;div class="modal-footer"&gt;
146
147
    &lt;a href="#" class="btn"&gt;Close&lt;/a&gt;
    &lt;a href="#" class="btn btn-primary"&gt;Save changes&lt;/a&gt;
148
149
150
151
  &lt;/div&gt;
&lt;/div&gt;
</pre>

152
153
          <h3>Live demo</h3>
          <p>Toggle a modal via JavaScript by clicking the button below. It will slide down and fade in from the top of the page.</p>
Mark Otto's avatar
Mark Otto committed
154
          <!-- sample modal content -->
155
          <div id="myModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
Mark Otto's avatar
Mark Otto committed
156
            <div class="modal-header">
157
              <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
158
              <h3 id="myModalLabel">Modal Heading</h3>
Mark Otto's avatar
Mark Otto committed
159
160
            </div>
            <div class="modal-body">
161
              <h4>Text in a modal</h4>
Mark Otto's avatar
Mark Otto committed
162
163
              <p>Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem.</p>

164
165
              <h4>Popover in a modal</h4>
              <p>This <a href="#" role="button" class="btn popover-test" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">button</a> should trigger a popover on click.</p>
Mark Otto's avatar
Mark Otto committed
166

167
168
              <h4>Tooltips in a modal</h4>
              <p><a href="#" class="tooltip-test" title="Tooltip">This link</a> and <a href="#" class="tooltip-test" title="Tooltip">that link</a> should have tooltips on hover.</p>
Mark Otto's avatar
Mark Otto committed
169
170
171

              <hr>

172
173
              <h4>Overflowing text to show optional scrollbar</h4>
              <p>We set a fixed <code>max-height</code> on the <code>.modal-body</code>. Watch it overflow with all this extra lorem ipsum text we've included.</p>
Mark Otto's avatar
Mark Otto committed
174
175
176
177
178
179
              <p>Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.</p>
              <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.</p>
              <p>Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.</p>
              <p>Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.</p>
              <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.</p>
              <p>Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.</p>
180
            </div>
Mark Otto's avatar
Mark Otto committed
181
            <div class="modal-footer">
182
183
              <button class="btn" data-dismiss="modal">Close</button>
              <button class="btn btn-primary">Save changes</button>
Mark Otto's avatar
Mark Otto committed
184
185
186
            </div>
          </div>
          <div class="bs-docs-example" style="padding-bottom: 24px;">
187
            <a data-toggle="modal" href="#myModal" class="btn btn-primary btn-large">Launch demo modal</a>
Mark Otto's avatar
Mark Otto committed
188
          </div>{{! /example }}
189
<pre class="prettyprint linenums">
Mark Otto's avatar
Mark Otto committed
190
&lt!-- Button to trigger modal --&gt;
191
&lt;a href="#myModal" role="button" class="btn" data-toggle="modal"&gt;Launch demo modal&lt;/a&gt;
192

Mark Otto's avatar
Mark Otto committed
193
&lt!-- Modal --&gt;
194
&lt;div id="myModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true"&gt;
195
  &lt;div class="modal-header"&gt;
196
    &lt;button type="button" class="close" data-dismiss="modal" aria-hidden="true"&gt;&times;&lt;/button&gt;
197
198
199
    &lt;h3 id="myModalLabel"&gt;Modal header&lt;/h3&gt;
  &lt;/div&gt;
  &lt;div class="modal-body"&gt;
200
    &lt;p&gt;One fine body&hellip;&lt;/p&gt;
201
202
  &lt;/div&gt;
  &lt;div class="modal-footer"&gt;
203
204
    &lt;button class="btn" data-dismiss="modal" aria-hidden="true"&gt;Close&lt;/button&gt;
    &lt;button class="btn btn-primary"&gt;Save changes&lt;/button&gt;
205
206
207
  &lt;/div&gt;
&lt;/div&gt;
</pre>
208
209


Mark Otto's avatar
Mark Otto committed
210
211
212
          <hr class="bs-docs-separator">


213
          <h2>Usage</h2>
Mark Otto's avatar
Mark Otto committed
214

215
216
          <h3>Via data attributes</h3>
          <p>Activate a modal without writing JavaScript. Set <code>data-toggle="modal"</code> on a controller element, like a button, along with a <code>data-target="#foo"</code> or <code>href="#foo"</code> to target a specific modal to toggle.</p>
Mark Otto's avatar
Mark Otto committed
217
218
          <pre class="prettyprint linenums">&lt;button type="button" data-toggle="modal" data-target="#myModal"&gt;Launch modal&lt;/button&gt;</pre>

219
220
          <h3>Via JavaScript</h3>
          <p>Call a modal with id <code>myModal</code> with a single line of JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
221
222
          <pre class="prettyprint linenums">$('#myModal').modal(options)</pre>

223
224
          <h3>Options</h3>
          <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-backdrop=""</code>.</p>
Mark Otto's avatar
Mark Otto committed
225
226
227
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
228
229
230
231
               <th style="width: 100px;">Name</th>
               <th style="width: 50px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
Mark Otto's avatar
Mark Otto committed
232
233
234
235
             </tr>
            </thead>
            <tbody>
             <tr>
236
237
238
239
               <td>backdrop</td>
               <td>boolean</td>
               <td>true</td>
               <td>Includes a modal-backdrop element. Alternatively, specify <code>static</code> for a backdrop which doesn't close the modal on click.</td>
Mark Otto's avatar
Mark Otto committed
240
241
             </tr>
             <tr>
242
243
244
245
               <td>keyboard</td>
               <td>boolean</td>
               <td>true</td>
               <td>Closes the modal when escape key is pressed</td>
Mark Otto's avatar
Mark Otto committed
246
247
             </tr>
             <tr>
248
249
250
251
               <td>show</td>
               <td>boolean</td>
               <td>true</td>
               <td>Shows the modal when initialized.</td>
Mark Otto's avatar
Mark Otto committed
252
253
             </tr>
             <tr>
254
255
256
257
               <td>remote</td>
               <td>path</td>
               <td>false</td>
               <td><p>If a remote url is provided, content will be loaded via jQuery's <code>load</code> method and injected into the <code>.modal-body</code>. If you're using the data api, you may alternatively use the <code>href</code> tag to specify the remote source. An example of this is shown below:</p>
Mark Otto's avatar
Mark Otto committed
258
259
260
261
262
              <pre class="prettyprint linenums"><code>&lt;a data-toggle="modal" href="remote.html" data-target="#modal"&gt;click me&lt;/a&gt;</code></pre></td>
             </tr>
            </tbody>
          </table>

263
264
265
          <h3>Methods</h3>
          <h4>.modal(options)</h4>
          <p>Activates your content as a modal. Accepts an optional options <code>object</code>.</p>
266
267
<pre class="prettyprint linenums">
$('#myModal').modal({
Jacob Thornton's avatar
Jacob Thornton committed
268
  keyboard: false
269
270
})
</pre>
Mark Otto's avatar
Mark Otto committed
271
          <h4>.modal('toggle')</h4>
272
          <p>Manually toggles a modal.</p>
Mark Otto's avatar
Mark Otto committed
273
274
          <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre>
          <h4>.modal('show')</h4>
275
          <p>Manually opens a modal.</p>
Mark Otto's avatar
Mark Otto committed
276
277
          <pre class="prettyprint linenums">$('#myModal').modal('show')</pre>
          <h4>.modal('hide')</h4>
278
          <p>Manually hides a modal.</p>
Mark Otto's avatar
Mark Otto committed
279
          <pre class="prettyprint linenums">$('#myModal').modal('hide')</pre>
280
281
          <h3>Events</h3>
          <p>Bootstrap's modal class exposes a few events for hooking into modal functionality.</p>
Mark Otto's avatar
Mark Otto committed
282
283
284
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
285
286
               <th style="width: 150px;">Event</th>
               <th>Description</th>
Mark Otto's avatar
Mark Otto committed
287
288
289
290
             </tr>
            </thead>
            <tbody>
             <tr>
291
292
               <td>show</td>
               <td>This event fires immediately when the <code>show</code> instance method is called.</td>
Mark Otto's avatar
Mark Otto committed
293
294
             </tr>
             <tr>
295
296
               <td>shown</td>
               <td>This event is fired when the modal has been made visible to the user (will wait for css transitions to complete).</td>
Mark Otto's avatar
Mark Otto committed
297
298
             </tr>
             <tr>
299
300
               <td>hide</td>
               <td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
Mark Otto's avatar
Mark Otto committed
301
302
             </tr>
             <tr>
303
304
               <td>hidden</td>
               <td>This event is fired when the modal has finished being hidden from the user (will wait for css transitions to complete).</td>
Mark Otto's avatar
Mark Otto committed
305
306
307
             </tr>
            </tbody>
          </table>
308
309
<pre class="prettyprint linenums">
$('#myModal').on('hidden', function () {
310
  // do something…
311
312
})
</pre>
Mark Otto's avatar
Mark Otto committed
313
        </section>
314
315
316



Mark Otto's avatar
Mark Otto committed
317
        <!-- Dropdowns
Mark Otto's avatar
Mark Otto committed
318
319
320
        ================================================== -->
        <section id="dropdowns">
          <div class="page-header">
321
            <h1>Dropdowns <small>bootstrap-dropdown.js</small></h1>
Mark Otto's avatar
Mark Otto committed
322
          </div>
323
324


325
326
          <h2>Examples</h2>
          <p>Add dropdown menus to nearly anything with this simple plugin, including the navbar, tabs, and pills.</p>
Mark Otto's avatar
Mark Otto committed
327

328
          <h3>Within a navbar</h3>
Mark Otto's avatar
Mark Otto committed
329
330
331
332
          <div class="bs-docs-example">
            <div id="navbar-example" class="navbar navbar-static">
              <div class="navbar-inner">
                <div class="container" style="width: auto;">
333
                  <a class="brand" href="#">Project Name</a>
Mark Otto's avatar
Mark Otto committed
334
335
                  <ul class="nav" role="navigation">
                    <li class="dropdown">
336
                      <a id="drop1" href="#" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
Mark Otto's avatar
Mark Otto committed
337
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
338
339
340
                        <li><a tabindex="-1" href="http://google.com">Action</a></li>
                        <li><a tabindex="-1" href="#anotherAction">Another action</a></li>
                        <li><a tabindex="-1" href="#">Something else here</a></li>
Mark Otto's avatar
Mark Otto committed
341
                        <li class="divider"></li>
342
                        <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
343
344
345
                      </ul>
                    </li>
                    <li class="dropdown">
346
                      <a href="#" id="drop2" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown 2 <b class="caret"></b></a>
Mark Otto's avatar
Mark Otto committed
347
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop2">
348
349
350
                        <li><a tabindex="-1" href="#">Action</a></li>
                        <li><a tabindex="-1" href="#">Another action</a></li>
                        <li><a tabindex="-1" href="#">Something else here</a></li>
Mark Otto's avatar
Mark Otto committed
351
                        <li class="divider"></li>
352
                        <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
353
354
                      </ul>
                    </li>
355
                  </ul>
Mark Otto's avatar
Mark Otto committed
356
357
                  <ul class="nav pull-right">
                    <li id="fat-menu" class="dropdown">
358
                      <a href="#" id="drop3" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown 3 <b class="caret"></b></a>
Mark Otto's avatar
Mark Otto committed
359
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop3">
360
361
362
                        <li><a tabindex="-1" href="#">Action</a></li>
                        <li><a tabindex="-1" href="#">Another action</a></li>
                        <li><a tabindex="-1" href="#">Something else here</a></li>
Mark Otto's avatar
Mark Otto committed
363
                        <li class="divider"></li>
364
                        <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
365
366
                      </ul>
                    </li>
367
                  </ul>
Mark Otto's avatar
Mark Otto committed
368
369
370
371
372
                </div>
              </div>
            </div> <!-- /navbar-example -->
          </div> {{! /example }}

373
          <h3>Within tabs</h3>
Mark Otto's avatar
Mark Otto committed
374
375
          <div class="bs-docs-example">
            <ul class="nav nav-pills">
376
              <li class="active"><a href="#">Regular link</a></li>
Mark Otto's avatar
Mark Otto committed
377
              <li class="dropdown">
378
                <a class="dropdown-toggle" id="drop4" role="button" data-toggle="dropdown" href="#">Dropdown <b class="caret"></b></a>
Mark Otto's avatar
Mark Otto committed
379
                <ul id="menu1" class="dropdown-menu" role="menu" aria-labelledby="drop4">
380
381
382
                  <li><a tabindex="-1" href="#">Action</a></li>
                  <li><a tabindex="-1" href="#">Another action</a></li>
                  <li><a tabindex="-1" href="#">Something else here</a></li>
Mark Otto's avatar
Mark Otto committed
383
                  <li class="divider"></li>
384
                  <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
385
386
387
                </ul>
              </li>
              <li class="dropdown">
388
                <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">Dropdown 2 <b class="caret"></b></a>
Mark Otto's avatar
Mark Otto committed
389
                <ul id="menu2" class="dropdown-menu" role="menu" aria-labelledby="drop5">
390
391
392
                  <li><a tabindex="-1" href="#">Action</a></li>
                  <li><a tabindex="-1" href="#">Another action</a></li>
                  <li><a tabindex="-1" href="#">Something else here</a></li>
Mark Otto's avatar
Mark Otto committed
393
                  <li class="divider"></li>
394
                  <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
395
396
397
                </ul>
              </li>
              <li class="dropdown">
398
                <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">Dropdown 3 <b class="caret"></b></a>
Mark Otto's avatar
Mark Otto committed
399
                <ul id="menu3" class="dropdown-menu" role="menu" aria-labelledby="drop5">
400
401
402
                  <li><a tabindex="-1" href="#">Action</a></li>
                  <li><a tabindex="-1" href="#">Another action</a></li>
                  <li><a tabindex="-1" href="#">Something else here</a></li>
Mark Otto's avatar
Mark Otto committed
403
                  <li class="divider"></li>
404
                  <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
405
406
407
408
409
410
411
412
413
                </ul>
              </li>
            </ul> <!-- /tabs -->
          </div> {{! /example }}


          <hr class="bs-docs-separator">


414
          <h2>Usage</h2>
Mark Otto's avatar
Mark Otto committed
415

416
417
          <h3>Via data attributes</h3>
          <p>Add <code>data-toggle="dropdown"</code> to a link or button to toggle a dropdown.</p>
418
<pre class="prettyprint linenums">
419
&lt;div class="dropdown"&gt;
Mark Otto's avatar
Mark Otto committed
420
  &lt;a class="dropdown-toggle" data-toggle="dropdown" href="#"&gt;Dropdown trigger&lt;/a&gt;
421
422
423
424
425
  &lt;ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"&gt;
    ...
  &lt;/ul&gt;
&lt;/div&gt;
</pre>
426
          <p>To keep URLs intact, use the <code>data-target</code> attribute instead of <code>href="#"</code>.</p>
427
<pre class="prettyprint linenums">
428
429
&lt;div class="dropdown"&gt;
  &lt;a class="dropdown-toggle" id="dLabel" role="button" data-toggle="dropdown" data-target="#" href="/page.html"&gt;
430
    Dropdown
431
432
433
434
435
436
    &lt;b class="caret"&gt;&lt;/b&gt;
  &lt;/a&gt;
  &lt;ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"&gt;
    ...
  &lt;/ul&gt;
&lt;/div&gt;
437
</pre>
438

439
440
          <h3>Via JavaScript</h3>
          <p>Call the dropdowns via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
441
          <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre>
442

443
444
          <h3>Options</h3>
          <p><em>None</em></p>
445

446
          <h3>Methods</h3>
447
          <h4>$().dropdown('toggle')</h4>
448
          <p>A programmatic api for toggling menus for a given navbar or tabbed navigation.</p>
Mark Otto's avatar
Mark Otto committed
449
        </section>
450
451
452



Mark Otto's avatar
Mark Otto committed
453
454
455
456
        <!-- ScrollSpy
        ================================================== -->
        <section id="scrollspy">
          <div class="page-header">
457
            <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
Mark Otto's avatar
Mark Otto committed
458
          </div>
459
460


461
462
          <h2>Example in navbar</h2>
          <p>The ScrollSpy plugin is for automatically updating nav targets based on scroll position. Scroll the area below the navbar and watch the active class change. The dropdown sub items will be highlighted as well.</p>
Mark Otto's avatar
Mark Otto committed
463
464
465
466
          <div class="bs-docs-example">
            <div id="navbarExample" class="navbar navbar-static">
              <div class="navbar-inner">
                <div class="container" style="width: auto;">
467
                  <a class="brand" href="#">Project Name</a>
Mark Otto's avatar
Mark Otto committed
468
469
470
471
                  <ul class="nav">
                    <li><a href="#fat">@fat</a></li>
                    <li><a href="#mdo">@mdo</a></li>
                    <li class="dropdown">
472
                      <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
Mark Otto's avatar
Mark Otto committed
473
                      <ul class="dropdown-menu">
474
475
                        <li><a href="#one">one</a></li>
                        <li><a href="#two">two</a></li>
Mark Otto's avatar
Mark Otto committed
476
                        <li class="divider"></li>
477
                        <li><a href="#three">three</a></li>
Mark Otto's avatar
Mark Otto committed
478
479
480
                      </ul>
                    </li>
                  </ul>
481
                </div>
482
              </div>
Mark Otto's avatar
Mark Otto committed
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
            </div>
            <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.</p>
              <h4 id="mdo">@mdo</h4>
              <p>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.</p>
              <h4 id="one">one</h4>
              <p>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.</p>
              <h4 id="two">two</h4>
              <p>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.</p>
              <h4 id="three">three</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.</p>
              <p>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.
              </p>
            </div>
          </div>{{! /example }}
499

500

Mark Otto's avatar
Mark Otto committed
501
          <hr class="bs-docs-separator">
502
503


504
          <h2>Usage</h2>
505

506
507
          <h3>Via data attributes</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) and <code>data-target=".navbar"</code> to select which nav to use. You'll want to use scrollspy with a <code>.nav</code> component.</p>
Mark Otto's avatar
Mark Otto committed
508
          <pre class="prettyprint linenums">&lt;body data-spy="scroll" data-target=".navbar"&gt;...&lt;/body&gt;</pre>
509

510
511
          <h3>Via JavaScript</h3>
          <p>Call the scrollspy via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
512
          <pre class="prettyprint linenums">$('#navbar').scrollspy()</pre>
513

Mark Otto's avatar
Mark Otto committed
514
          <div class="alert alert-info">
515
516
            <strong>Heads up!</strong>
            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>.
Mark Otto's avatar
Mark Otto committed
517
          </div>
518

519
          <h3>Methods</h3>
Mark Otto's avatar
Mark Otto committed
520
          <h4>.scrollspy('refresh')</h4>
521
          <p>When using scrollspy in conjunction with adding or removing of elements from the DOM, you'll need to call the refresh method like so:</p>
522
523
524
525
526
<pre class="prettyprint linenums">
$('[data-spy="scroll"]').each(function () {
  var $spy = $(this).scrollspy('refresh')
});
</pre>
527

528
529
          <h3>Options</h3>
          <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-offset=""</code>.</p>
Mark Otto's avatar
Mark Otto committed
530
531
532
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
533
534
535
536
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
Mark Otto's avatar
Mark Otto committed
537
538
539
540
             </tr>
            </thead>
            <tbody>
             <tr>
541
542
543
544
               <td>offset</td>
               <td>number</td>
               <td>10</td>
               <td>Pixels to offset from top when calculating position of scroll.</td>
Mark Otto's avatar
Mark Otto committed
545
546
547
             </tr>
            </tbody>
          </table>
548

549
          <h3>Events</h3>
Mark Otto's avatar
Mark Otto committed
550
551
552
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
553
554
               <th style="width: 150px;">Event</th>
               <th>Description</th>
Mark Otto's avatar
Mark Otto committed
555
556
557
558
             </tr>
            </thead>
            <tbody>
             <tr>
559
560
               <td>activate</td>
               <td>This event fires whenever a new item becomes activated by the scrollspy.</td>
Mark Otto's avatar
Mark Otto committed
561
562
563
564
            </tr>
            </tbody>
          </table>
        </section>
565

Mark Otto's avatar
Mark Otto committed
566
567
568
569
570
571


        <!-- Tabs
        ================================================== -->
        <section id="tabs">
          <div class="page-header">
572
            <h1>Togglable tabs <small>bootstrap-tab.js</small></h1>
Mark Otto's avatar
Mark Otto committed
573
574
575
          </div>


576
577
          <h2>Example tabs</h2>
          <p>Add quick, dynamic tab functionality to transition through panes of local content, even via dropdown menus.</p>
Mark Otto's avatar
Mark Otto committed
578
579
          <div class="bs-docs-example">
            <ul id="myTab" class="nav nav-tabs">
580
581
              <li class="active"><a href="#home" data-toggle="tab">Home</a></li>
              <li><a href="#profile" data-toggle="tab">Profile</a></li>
Mark Otto's avatar
Mark Otto committed
582
              <li class="dropdown">
583
                <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
Mark Otto's avatar
Mark Otto committed
584
585
586
587
588
589
590
591
592
593
594
595
                <ul class="dropdown-menu">
                  <li><a href="#dropdown1" data-toggle="tab">@fat</a></li>
                  <li><a href="#dropdown2" data-toggle="tab">@mdo</a></li>
                </ul>
              </li>
            </ul>
            <div id="myTabContent" class="tab-content">
              <div class="tab-pane fade in active" id="home">
                <p>Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.</p>
              </div>
              <div class="tab-pane fade" id="profile">
                <p>Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid. Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero sint qui sapiente accusamus tattooed echo park.</p>
596
              </div>
Mark Otto's avatar
Mark Otto committed
597
598
599
600
601
602
603
604
              <div class="tab-pane fade" id="dropdown1">
                <p>Etsy mixtape wayfarers, ethical wes anderson tofu before they sold out mcsweeney's organic lomo retro fanny pack lo-fi farm-to-table readymade. Messenger bag gentrify pitchfork tattooed craft beer, iphone skateboard locavore carles etsy salvia banksy hoodie helvetica. DIY synth PBR banksy irony. Leggings gentrify squid 8-bit cred pitchfork. Williamsburg banh mi whatever gluten-free, carles pitchfork biodiesel fixie etsy retro mlkshk vice blog. Scenester cred you probably haven't heard of them, vinyl craft beer blog stumptown. Pitchfork sustainable tofu synth chambray yr.</p>
              </div>
              <div class="tab-pane fade" id="dropdown2">
                <p>Trust fund seitan letterpress, keytar raw denim keffiyeh etsy art party before they sold out master cleanse gluten-free squid scenester freegan cosby sweater. Fanny pack portland seitan DIY, art party locavore wolf cliche high life echo park Austin. Cred vinyl keffiyeh DIY salvia PBR, banh mi before they sold out farm-to-table VHS viral locavore cosby sweater. Lomo wolf viral, mustache readymade thundercats keffiyeh craft beer marfa ethical. Wolf salvia freegan, sartorial keffiyeh echo park vegan.</p>
              </div>
            </div>
          </div>{{! /example }}
605
606


Mark Otto's avatar
Mark Otto committed
607
          <hr class="bs-docs-separator">
608
609


610
611
          <h2>Usage</h2>
          <p>Enable tabbable tabs via JavaScript (each tab needs to be activated individually):</p>
612
<pre class="prettyprint linenums">
613
614
615
616
$('#myTab a').click(function (e) {
  e.preventDefault();
  $(this).tab('show');
})</pre>
617
          <p>You can activate individual tabs in several ways:</p>
618
<pre class="prettyprint linenums">
Mark Otto's avatar
Mark Otto committed
619
620
621
622
$('#myTab a[href="#profile"]').tab('show'); // Select tab by name
$('#myTab a:first').tab('show'); // Select first tab
$('#myTab a:last').tab('show'); // Select last tab
$('#myTab li:eq(2) a').tab('show'); // Select third tab (0-indexed)
623
</pre>
624

625
626
          <h3>Markup</h3>
          <p>You can activate a tab or pill navigation without writing any JavaScript by simply specifying <code>data-toggle="tab"</code> or <code>data-toggle="pill"</code> on an element. Adding the <code>nav</code> and <code>nav-tabs</code> classes to the tab <code>ul</code> will apply the Bootstrap tab styling.</p>
627
<pre class="prettyprint linenums">
628
&lt;ul class="nav nav-tabs"&gt;
629
630
631
632
  &lt;li&gt;&lt;a href="#home" data-toggle="tab"&gt;Home&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#profile" data-toggle="tab"&gt;Profile&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#messages" data-toggle="tab"&gt;Messages&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#settings" data-toggle="tab"&gt;Settings&lt;/a&gt;&lt;/li&gt;
633
&lt;/ul&gt;</pre>
634
          <p>To make tabs fade in, add <code>.fade</code> to each <code>.tab-pane</code>.</p>
635

636
          <h3>Methods</h3>
Mark Otto's avatar
Mark Otto committed
637
638
          <h4>$().tab</h4>
          <p>
639
            Activates a tab element and content container. Tab should have either a <code>data-target</code> or an <code>href</code> targeting a container node in the DOM.
Mark Otto's avatar
Mark Otto committed
640
          </p>
641
<pre class="prettyprint linenums">
642
&lt;ul class="nav nav-tabs" id="myTab"&gt;
643
644
645
646
  &lt;li class="active"&gt;&lt;a href="#home"&gt;Home&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#profile"&gt;Profile&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#messages"&gt;Messages&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#settings"&gt;Settings&lt;/a&gt;&lt;/li&gt;
647
648
649
&lt;/ul&gt;

&lt;div class="tab-content"&gt;
Mark Otto's avatar
Mark Otto committed
650
651
652
653
  &lt;div class="tab-pane active" id="home"&gt;...&lt;/div&gt;
  &lt;div class="tab-pane" id="profile"&gt;...&lt;/div&gt;
  &lt;div class="tab-pane" id="messages"&gt;...&lt;/div&gt;
  &lt;div class="tab-pane" id="settings"&gt;...&lt;/div&gt;
654
655
656
&lt;/div&gt;

&lt;script&gt;
Jacob Thornton's avatar
Jacob Thornton committed
657
  $(function () {
Mark Otto's avatar
Mark Otto committed
658
    $('#myTab a:last').tab('show');
Jacob Thornton's avatar
Jacob Thornton committed
659
  })
660
661
&lt;/script&gt;
</pre>
662

663
          <h3>Events</h3>
Mark Otto's avatar
Mark Otto committed
664
665
666
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
667
668
               <th style="width: 150px;">Event</th>
               <th>Description</th>
Mark Otto's avatar
Mark Otto committed
669
670
671
672
             </tr>
            </thead>
            <tbody>
             <tr>
673
674
               <td>show</td>
               <td>This event fires on tab show, but before the new tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.</td>
Mark Otto's avatar
Mark Otto committed
675
676
            </tr>
            <tr>
677
678
               <td>shown</td>
               <td>This event fires on tab show after a tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.</td>
Mark Otto's avatar
Mark Otto committed
679
680
681
             </tr>
            </tbody>
          </table>
682
<pre class="prettyprint linenums">
683
$('a[data-toggle="tab"]').on('shown', function (e) {
Jacob Thornton's avatar
Jacob Thornton committed
684
685
  e.target // activated tab
  e.relatedTarget // previous tab
686
687
})
</pre>
688
        </section>
689
690


691
692
693
694
        <!-- Tooltips
        ================================================== -->
        <section id="tooltips">
          <div class="page-header">
695
            <h1>Tooltips <small>bootstrap-tooltip.js</small></h1>
696
          </div>
697

698

699
700
701
          <h2>Examples</h2>
          <p>Inspired by the excellent jQuery.tipsy plugin written by Jason Frame; Tooltips are an updated version, which don't rely on images, use CSS3 for animations, and data-attributes for local title storage.</p>
          <p>Hover over the links below to see tooltips:</p>
702
          <div class="bs-docs-example tooltip-demo">
703
            <p class="muted" style="margin-bottom: 0;">Tight pants next level keffiyeh <a href="#" rel="tooltip" title="Default tooltip">you probably</a> haven't heard of them. Photo booth beard raw denim letterpress vegan messenger bag stumptown. Farm-to-table seitan, mcsweeney's fixie sustainable quinoa 8-bit american apparel <a href="#" rel="tooltip" title="Another tooltip">have a</a> terry richardson vinyl chambray. Beard stumptown, cardigans banh mi lomo thundercats. Tofu biodiesel williamsburg marfa, four loko mcsweeney's cleanse vegan chambray. A really ironic artisan <a href="#" rel="tooltip" title="Another one here too">whatever keytar</a>, scenester farm-to-table banksy Austin <a href="#" rel="tooltip" title="The last tip!">twitter handle</a> freegan cred raw denim single-origin coffee viral.
704
705
706
            </p>
          </div>{{! /example }}

707
          <h3>Four directions</h3>
708
709
710
711
712
713
714
715
716
717
718
719
720
          <div class="bs-docs-example tooltip-demo">
            <ul class="bs-docs-tooltip-examples">
              <li><a href="#" rel="tooltip" data-placement="top" title="Tooltip on top">Tooltip on top</a></li>
              <li><a href="#" rel="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</a></li>
              <li><a href="#" rel="tooltip" data-placement="bottom" title="Tooltip on bottom">Tooltip on bottom</a></li>
              <li><a href="#" rel="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</a></li>
            </ul>
          </div>{{! /example }}


          <hr class="bs-docs-separator">


721
722
723
          <h2>Usage</h2>
          <p>Trigger the tooltip via JavaScript:</p>
          <pre class="prettyprint linenums">$('#example').tooltip(options)</pre>
724

725
726
          <h3>Options</h3>
          <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-animation=""</code>.</p>
727
728
729
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
730
731
732
733
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
734
735
736
737
             </tr>
            </thead>
            <tbody>
             <tr>
738
739
               <td>animation</td>
               <td>boolean</td>
740
               <td>true</td>
741
               <td>apply a css fade transition to the tooltip</td>
742
743
             </tr>
             <tr>
744
745
               <td>html</td>
               <td>boolean</td>
746
               <td>false</td>
747
               <td>Insert html into the tooltip. If false, jquery's <code>text</code> method will be used to insert content into the dom. Use text if you're worried about XSS attacks.</td>
748
749
             </tr>
             <tr>
750
751
               <td>placement</td>
               <td>string|function</td>
752
               <td>'top'</td>
753
               <td>how to position the tooltip - top | bottom | left | right</td>
754
755
             </tr>
             <tr>
756
757
               <td>selector</td>
               <td>string</td>
758
               <td>false</td>
759
               <td>If a selector is provided, tooltip objects will be delegated to the specified targets.</td>
760
761
             </tr>
             <tr>
762
763
               <td>title</td>
               <td>string | function</td>
764
               <td>''</td>
765
               <td>default title value if `title` tag isn't present</td>
766
767
             </tr>
             <tr>
768
769
               <td>trigger</td>
               <td>string</td>
770
               <td>'hover'</td>
771
               <td>how tooltip is triggered - click | hover | focus | manual</td>
772
773
             </tr>
             <tr>
774
775
               <td>delay</td>
               <td>number | object</td>
776
777
               <td>0</td>
               <td>
778
779
780
                <p>delay showing and hiding the tooltip (ms) - does not apply to manual trigger type</p>
                <p>If a number is supplied, delay is applied to both hide/show</p>
                <p>Object structure is: <code>delay: { show: 500, hide: 100 }</code></p>
781
782
783
784
785
               </td>
             </tr>
            </tbody>
          </table>
          <div class="alert alert-info">
786
787
            <strong>Heads up!</strong>
            Options for individual tooltips can alternatively be specified through the use of data attributes.
788
          </div>
789

790
791
792
          <h3>Markup</h3>
          <p>For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a selector option.</p>
          <pre class="prettyprint linenums">&lt;a href="#" rel="tooltip" title="first tooltip"&gt;hover over me&lt;/a&gt;</pre>
793

794
795
796
          <h3>Methods</h3>
          <h4>$().tooltip(options)</h4>
          <p>Attaches a tooltip handler to an element collection.</p>
797
          <h4>.tooltip('show')</h4>
798
          <p>Reveals an element's tooltip.</p>
799
800
          <pre class="prettyprint linenums">$('#element').tooltip('show')</pre>
          <h4>.tooltip('hide')</h4>
801
          <p>Hides an element's tooltip.</p>
802
803
          <pre class="prettyprint linenums">$('#element').tooltip('hide')</pre>
          <h4>.tooltip('toggle')</h4>
804
          <p>Toggles an element's tooltip.</p>
805
806
          <pre class="prettyprint linenums">$('#element').tooltip('toggle')</pre>
          <h4>.tooltip('destroy')</h4>
807
          <p>Hides and destroys an element's tooltip.</p>
808
809
          <pre class="prettyprint linenums">$('#element').tooltip('destroy')</pre>
        </section>
810
811
812
813
814
815
816



      <!-- Popovers
      ================================================== -->
      <section id="popovers">
        <div class="page-header">
817
          <h1>Popovers <small>bootstrap-popover.js</small></h1>
818
        </div>
819

820
821
        <h2>Examples</h2>
        <p>Add small overlays of content, like those on the iPad, to any element for housing secondary information. Hover over the button to trigger the popover. <strong>Requires <a href="#tooltips">Tooltip</a> to be included.</strong></p>
822

823
824
        <h3>Static popover</h3>
        <p>Four options are available: top, right, bottom, and left aligned.</p>
825
826
827
828
829
830
831
832
833
        <div class="bs-docs-example bs-docs-example-popover">
          <div class="popover top">
            <div class="arrow"></div>
            <h3 class="popover-title">Popover top</h3>
            <div class="popover-content">
              <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
            </div>
          </div>

Mark Otto's avatar
Mark Otto committed
834
835
836
837
838
          <div class="popover right">
            <div class="arrow"></div>
            <h3 class="popover-title">Popover right</h3>
            <div class="popover-content">
              <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
839
            </div>
Mark Otto's avatar
Mark Otto committed
840
          </div>
841

Mark Otto's avatar
Mark Otto committed
842
843
844
845
846
          <div class="popover bottom">
            <div class="arrow"></div>
            <h3 class="popover-title">Popover bottom</h3>
            <div class="popover-content">
              <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
847
848
849
            </div>
          </div>

Mark Otto's avatar
Mark Otto committed
850
851
852
853
854
855
          <div class="popover left">
            <div class="arrow"></div>
            <h3 class="popover-title">Popover left</h3>
            <div class="popover-content">
              <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
            </div>
856
          </div>
857

Mark Otto's avatar
Mark Otto committed
858
859
          <div class="clearfix"></div>
        </div>
860
        <p>No markup shown as popovers are generated from JavaScript and content within a <code>data</code> attribute.</p>
861

Mark Otto's avatar
Mark Otto committed
862
863
        <h3>Live demo</h3>
        <div class="bs-docs-example" style="padding-bottom: 24px;">
864
          <a href="#" class="btn btn-large btn-danger" rel="popover" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">Click to toggle popover</a>
Mark Otto's avatar
Mark Otto committed
865
        </div>
866

867
        <h4>Four directions</h4>
868
869
870
871
872
873
874
875
876
        <div class="bs-docs-example tooltip-demo">
          <ul class="bs-docs-tooltip-examples">
            <li><a href="#" class="btn" rel="popover" data-placement="top" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus." title="Popover on top">Popover on top</a></li>
            <li><a href="#" class="btn" rel="popover" data-placement="right" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus." title="Popover on right">Popover on right</a></li>
            <li><a href="#" class="btn" rel="popover" data-placement="bottom" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus." title="Popover on bottom">Popover on bottom</a></li>
            <li><a href="#" class="btn" rel="popover" data-placement="left" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus." title="Popover on left">Popover on left</a></li>
          </ul>
        </div>{{! /example }}

877

Mark Otto's avatar
Mark Otto committed
878
879
880
        <hr class="bs-docs-separator">


881
882
883
        <h2>Usage</h2>
        <p>Enable popovers via JavaScript:</p>
        <pre class="prettyprint linenums">$('#example').popover(options)</pre>
Mark Otto's avatar
Mark Otto committed
884

885
886
        <h3>Options</h3>
        <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-animation=""</code>.</p>
Mark Otto's avatar
Mark Otto committed
887
888
889
        <table class="table table-bordered table-striped">
          <thead>
           <tr>
890
891
892
893
             <th style="width: 100px;">Name</th>
             <th style="width: 100px;">type</th>
             <th style="width: 50px;">default</th>
             <th>description</th>
Mark Otto's avatar
Mark Otto committed
894
895
896
897
           </tr>
          </thead>
          <tbody>
           <tr>
898
899
             <td>animation</td>
             <td>boolean</td>
Mark Otto's avatar
Mark Otto committed
900
             <td>true</td>
901
             <td>apply a css fade transition to the tooltip</td>
Mark Otto's avatar
Mark Otto committed
902
903
           </tr>
           <tr>
904
905
             <td>html</td>
             <td>boolean</td>
906
             <td>false</td>
907
             <td>Insert html into the popover. If false, jquery's <code>text</code> method will be used to insert content into the dom. Use text if you're worried about XSS attacks.</td>
Mark Otto's avatar
Mark Otto committed
908
909
           </tr>
           <tr>
910
911
             <td>placement</td>
             <td>string|function</td>
Mark Otto's avatar
Mark Otto committed
912
             <td>'right'</td>
913
             <td>how to position the popover - top | bottom | left | right</td>
Mark Otto's avatar
Mark Otto committed
914
915
           </tr>
           <tr>
916
917
             <td>selector</td>
             <td>string</td>
Mark Otto's avatar
Mark Otto committed
918
             <td>false</td>
919
             <td>if a selector is provided, tooltip objects will be delegated to the specified targets</td>
Mark Otto's avatar
Mark Otto committed
920
921
           </tr>
           <tr>
922
923
             <td>trigger</td>
             <td>string</td>
924
             <td>'click'</td>
925
             <td>how popover is triggered - click | hover | focus | manual</td>
Mark Otto's avatar
Mark Otto committed
926
927
           </tr>
           <tr>
928
929
             <td>title</td>
             <td>string | function</td>
Mark Otto's avatar
Mark Otto committed
930
             <td>''</td>
931
             <td>default title value if `title` attribute isn't present</td>
Mark Otto's avatar
Mark Otto committed
932
933
           </tr>
           <tr>
934
935
             <td>content</td>
             <td>string | function</td>
Mark Otto's avatar
Mark Otto committed
936
             <td>''</td>
937
             <td>default content value if `data-content` attribute isn't present</td>
Mark Otto's avatar
Mark Otto committed
938
939
           </tr>
           <tr>
940
941
             <td>delay</td>
             <td>number | object</td>
Mark Otto's avatar
Mark Otto committed
942
943
             <td>0</td>
             <td>
944
945
946
              <p>delay showing and hiding the popover (ms) - does not apply to manual trigger type</p>
              <p>If a number is supplied, delay is applied to both hide/show</p>
              <p>Object structure is: <code>delay: { show: 500, hide: 100 }</code></p>
Mark Otto's avatar
Mark Otto committed
947
948
949
950
951
             </td>
           </tr>
          </tbody>
        </table>
        <div class="alert alert-info">
952
953
          <strong>Heads up!</strong>
          Options for individual popovers can alternatively be specified through the use of data attributes.
Mark Otto's avatar
Mark Otto committed
954
        </div>
955

956
957
        <h3>Markup</h3>
        <p>For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a selector option.</p>
Mark Otto's avatar
Mark Otto committed
958

959
960
961
        <h3>Methods</h3>
        <h4>$().popover(options)</h4>
        <p>Initializes popovers for an element collection.</p>
Mark Otto's avatar
Mark Otto committed
962
        <h4>.popover('show')</h4>
963
        <p>Reveals an elements popover.</p>
Mark Otto's avatar
Mark Otto committed
964
965
        <pre class="prettyprint linenums">$('#element').popover('show')</pre>
        <h4>.popover('hide')</h4>
966
        <p>Hides an elements popover.</p>
Mark Otto's avatar
Mark Otto committed
967
968
        <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
        <h4>.popover('toggle')</h4>
969
        <p>Toggles an elements popover.</p>
Mark Otto's avatar
Mark Otto committed
970
971
        <pre class="prettyprint linenums">$('#element').popover('toggle')</pre>
        <h4>.popover('destroy')</h4>
972
        <p>Hides and destroys an element's popover.</p>
Mark Otto's avatar
Mark Otto committed
973
974
975
976
977
978
979
980
981
        <pre class="prettyprint linenums">$('#element').popover('destroy')</pre>
      </section>



      <!-- Alert
      ================================================== -->
      <section id="alerts">
        <div class="page-header">
982
          <h1>Alert messages <small>bootstrap-alert.js</small></h1>
Mark Otto's avatar
Mark Otto committed
983
        </div>
984
985


986
987
        <h2>Example alerts</h2>
        <p>Add dismiss functionality to all alert messages with this plugin.</p>
Mark Otto's avatar
Mark Otto committed
988
989
990
        <div class="bs-docs-example">
          <div class="alert fade in">
            <button type="button" class="close" data-dismiss="alert">&times;</button>
991
            <strong>Holy guacamole!</strong> Best check yo self, you're not looking too good.
992
          </div>
Mark Otto's avatar
Mark Otto committed
993
994
995
996
997
        </div>{{! /example }}

        <div class="bs-docs-example">
          <div class="alert alert-block alert-error fade in">
            <button type="button" class="close" data-dismiss="alert">&times;</button>
998
999
            <h4 class="alert-heading">Oh snap! You got an error!</h4>
            <p>Change this and that and try again. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum.</p>
Mark Otto's avatar
Mark Otto committed
1000
            <p>
1001
              <a class="btn btn-danger" href="#">Take this action</a> <a class="btn" href="#">Or do this</a>
Mark Otto's avatar
Mark Otto committed
1002
1003
1004
1005
1006
1007
1008
1009
            </p>
          </div>
        </div>{{! /example }}


        <hr class="bs-docs-separator">


1010
1011
        <h2>Usage</h2>
        <p>Enable dismissal of an alert via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
1012
1013
        <pre class="prettyprint linenums">$(".alert").alert()</pre>

1014
1015
        <h3>Markup</h3>
        <p>Just add <code>data-dismiss="alert"</code> to your close button to automatically give an alert close functionality.</p>
Mark Otto's avatar
Mark Otto committed
1016
1017
        <pre class="prettyprint linenums">&lt;a class="close" data-dismiss="alert" href="#"&gt;&amp;times;&lt;/a&gt;</pre>

1018
        <h3>Methods</h3>
Mark Otto's avatar
Mark Otto committed
1019
        <h4>$().alert()</h4>
1020
        <p>Wraps all alerts with close functionality. To have your alerts animate out when closed, make sure they have the <code>.fade</code> and <code>.in</code> class already applied to them.</p>
Mark Otto's avatar
Mark Otto committed
1021
        <h4>.alert('close')</h4>
1022
        <p>Closes an alert.</p>
Mark Otto's avatar
Mark Otto committed
1023
1024
1025
        <pre class="prettyprint linenums">$(".alert").alert('close')</pre>


1026
1027
        <h3>Events</h3>
        <p>Bootstrap's alert class exposes a few events for hooking into alert functionality.</p>
Mark Otto's avatar
Mark Otto committed
1028
1029
1030
        <table class="table table-bordered table-striped">
          <thead>
           <tr>
1031
1032
             <th style="width: 150px;">Event</th>
             <th>Description</th>
Mark Otto's avatar
Mark Otto committed
1033
1034
1035
1036
           </tr>
          </thead>
          <tbody>
           <tr>
1037
1038
             <td>close</td>
             <td>This event fires immediately when the <code>close</code> instance method is called.</td>
Mark Otto's avatar
Mark Otto committed
1039
1040
           </tr>
           <tr>
1041
1042
             <td>closed</td>
             <td>This event is fired when the alert has been closed (will wait for css transitions to complete).</td>
Mark Otto's avatar
Mark Otto committed
1043
1044
1045
           </tr>
          </tbody>
        </table>
1046
1047
<pre class="prettyprint linenums">
$('#my-alert').bind('closed', function () {
1048
  // do something…
1049
1050
})
</pre>
Mark Otto's avatar
Mark Otto committed
1051
      </section>
1052
1053


1054

1055
1056
1057
1058
          <!-- Buttons
          ================================================== -->
          <section id="buttons">
            <div class="page-header">
1059
              <h1>Buttons <small>bootstrap-button.js</small></h1>
1060
            </div>
1061

1062
1063
            <h2>Example uses</h2>
            <p>Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p>
1064

1065
            <h4>Stateful</h4>
1066
            <p>Add <code>data-loading-text="Loading..."</code> to use a loading state on a button.</p>
1067
1068
            <div class="bs-docs-example" style="padding-bottom: 24px;">
              <button type="button" id="fat-btn" data-loading-text="loading..." class="btn btn-primary">
1069
                Loading state
1070
1071
1072
1073
              </button>
            </div>{{! /example }}
            <pre class="prettyprint linenums">&lt;button type="button" class="btn btn-primary" data-loading-text="Loading..."&gt;Loading state&lt;/button&gt;</pre>

1074
            <h4>Single toggle</h4>
1075
            <p>Add <code>data-toggle="button"</code> to activate toggling on a single button.</p>
1076
            <div class="bs-docs-example" style="padding-bottom: 24px;">
1077
              <button type="button" class="btn btn-primary" data-toggle="button">Single Toggle</button>
1078
            </div>{{! /example }}
1079
            <pre class="prettyprint linenums">&lt;button type="button" class="btn btn-primary" data-toggle="button"&gt;Single Toggle&lt;/button&gt;</pre>
1080

1081
            <h4>Checkbox</h4>
1082
            <p>Add <code>data-toggle="buttons-checkbox"</code> for checkbox style toggling on btn-group.</p>
1083
1084
            <div class="bs-docs-example" style="padding-bottom: 24px;">
              <div class="btn-group" data-toggle="buttons-checkbox">
1085
1086
1087
                <button type="button" class="btn btn-primary">Left</button>
                <button type="button" class="btn btn-primary">Middle</button>
                <button type="button" class="btn btn-primary">Right</button>
1088
1089
              </div>
            </div>{{! /example }}
1090
1091
<pre class="prettyprint linenums">
&lt;div class="btn-group" data-toggle="buttons-checkbox"&gt;
1092
1093
1094
  &lt;button type="button" class="btn btn-primary"&gt;Left&lt;/button&gt;
  &lt;button type="button" class="btn btn-primary"&gt;Middle&lt;/button&gt;
  &lt;button type="button" class="btn btn-primary"&gt;Right&lt;/button&gt;
1095
1096
&lt;/div&gt;
</pre>
1097

1098
            <h4>Radio</h4>
1099
            <p>Add <code>data-toggle="buttons-radio"</code> for radio style toggling on btn-group.</p>
1100
1101
            <div class="bs-docs-example" style="padding-bottom: 24px;">
              <div class="btn-group" data-toggle="buttons-radio">
1102
1103
1104
                <button type="button" class="btn btn-primary">Left</button>
                <button type="button" class="btn btn-primary">Middle</button>
                <button type="button" class="btn btn-primary">Right</button>
1105
1106
              </div>
            </div>{{! /example }}
1107
1108
<pre class="prettyprint linenums">
&lt;div class="btn-group" data-toggle="buttons-radio"&gt;
1109
1110
1111
  &lt;button type="button" class="btn btn-primary"&gt;Left&lt;/button&gt;
  &lt;button type="button" class="btn btn-primary"&gt;Middle&lt;/button&gt;
  &lt;button type="button" class="btn btn-primary"&gt;Right&lt;/button&gt;
1112
1113
&lt;/div&gt;
</pre>
1114

1115

1116
            <hr class="bs-docs-separator">
1117
1118


1119
1120
            <h2>Usage</h2>
            <p>Enable buttons via JavaScript:</p>
1121
            <pre class="prettyprint linenums">$('.nav-tabs').button()</pre>
1122

1123
1124
            <h3>Markup</h3>
            <p>Data attributes are integral to the button plugin. Check out the example code below for the various markup types.</p>
1125

1126
1127
            <h3>Options</h3>
            <p><em>None</em></p>
1128

1129
            <h3>Methods</h3>
1130
            <h4>$().button('toggle')</h4>
1131
            <p>Toggles push state. Gives the button the appearance that it has been activated.</p>
1132
            <div class="alert alert-info">
1133
1134
              <strong>Heads up!</strong>
              You can enable auto toggling of a button by using the <code>data-toggle</code> attribute.
1135
1136
1137
            </div>
            <pre class="prettyprint linenums">&lt;button type="button" class="btn" data-toggle="button" &gt;&lt;/button&gt;</pre>
            <h4>$().button('loading')</h4>
1138
            <p>Sets button state to loading - disables button and swaps text to loading text. Loading text should be defined on the button element using the data attribute <code>data-loading-text</code>.
1139
1140
1141
            </p>
            <pre class="prettyprint linenums">&lt;button type="button" class="btn" data-loading-text="loading stuff..." &gt;...&lt;/button&gt;</pre>
            <div class="alert alert-info">
1142
1143
              <strong>Heads up!</strong>
              <a href="https://github.com/twitter/bootstrap/issues/793">Firefox persists the disabled state across page loads</a>. A workaround for this is to use <code>autocomplete="off"</code>.
1144
1145
            </div>
            <h4>$().button('reset')</h4>
1146
            <p>Resets button state - swaps text to original text.</p>
1147
            <h4>$().button(string)</h4>
1148
            <p>Resets button state - swaps text to any data defined text state.</p>
1149
<pre class="prettyprint linenums">&lt;button type="button" class="btn" data-complete-text="finished!" &gt;...&lt;/button&gt;
1150
&lt;script&gt;
Jacob Thornton's avatar
Jacob Thornton committed
1151
  $('.btn').button('complete')
1152
1153
&lt;/script&gt;
</pre>
1154
          </section>
1155
1156
1157



1158
1159
1160
1161
          <!-- Collapse
          ================================================== -->
          <section id="collapse">
            <div class="page-header">
1162
              <h1>Collapse <small>bootstrap-collapse.js</small></h1>
1163
            </div>
1164

1165
1166
1167
            <h3>About</h3>
            <p>Get base styles and flexible support for collapsible components like accordions and navigation.</p>
            <p class="muted"><strong>*</strong> Requires the Transitions plugin to be included.</p>
1168

1169
1170
            <h2>Example accordion</h2>
            <p>Using the collapse plugin, we built a simple accordion style widget:</p>
1171

1172
1173
1174
1175
1176
            <div class="bs-docs-example">
              <div class="accordion" id="accordion2">
                <div class="accordion-group">
                  <div class="accordion-heading">
                    <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseOne">
1177
                      Collapsible Group Item #1
1178
                    </a>
1179
                  </div>
1180
1181
1182
1183
                  <div id="collapseOne" class="accordion-body collapse in">
                    <div class="accordion-inner">
                      Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
                    </div>
1184
                  </div>
1185
                </div>
1186
1187
1188
                <div class="accordion-group">
                  <div class="accordion-heading">
                    <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseTwo">
1189
                      Collapsible Group Item #2
1190
1191
1192
1193
1194
1195
1196
                    </a>
                  </div>
                  <div id="collapseTwo" class="accordion-body collapse">
                    <div class="accordion-inner">
                      Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
                    </div>
                  </div>
1197
                </div>
1198
1199
1200
                <div class="accordion-group">
                  <div class="accordion-heading">
                    <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseThree">
1201
                      Collapsible Group Item #3
1202
1203
1204
1205
1206
1207
                    </a>
                  </div>
                  <div id="collapseThree" class="accordion-body collapse">
                    <div class="accordion-inner">
                      Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
                    </div>
1208
                  </div>
1209
                </div>
1210
              </div>
1211
            </div>{{! /example }}
1212
<pre class="prettyprint linenums">
1213
1214
1215
1216
&lt;div class="accordion" id="accordion2"&gt;
  &lt;div class="accordion-group"&gt;
    &lt;div class="accordion-heading"&gt;
      &lt;a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseOne"&gt;
1217
        Collapsible Group Item #1
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
      &lt;/a&gt;
    &lt;/div&gt;
    &lt;div id="collapseOne" class="accordion-body collapse in"&gt;
      &lt;div class="accordion-inner"&gt;
        Anim pariatur cliche...
      &lt;/div&gt;
    &lt;/div&gt;
  &lt;/div&gt;
  &lt;div class="accordion-group"&gt;
    &lt;div class="accordion-heading"&gt;
      &lt;a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseTwo"&gt;
1229
        Collapsible Group Item #2
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
      &lt;/a&gt;
    &lt;/div&gt;
    &lt;div id="collapseTwo" class="accordion-body collapse"&gt;
      &lt;div class="accordion-inner"&gt;
        Anim pariatur cliche...
      &lt;/div&gt;
    &lt;/div&gt;
  &lt;/div&gt;
&lt;/div&gt;
...
</pre>
1241
            <p>You can also use the plugin without the accordion markup. Make a button toggle the expanding and collapsing of another element.</p>
1242
<pre class="prettyprint linenums">
1243
&lt;button type="button" class="btn btn-danger" data-toggle="collapse" data-target="#demo"&gt;
1244
  simple collapsible
1245
1246
1247
1248
&lt;/button&gt;

&lt;div id="demo" class="collapse in"&gt;&lt;/div&gt;
</pre>
1249

1250

1251
1252
1253
            <hr class="bs-docs-separator">


1254
            <h2>Usage</h2>
1255

1256
1257
1258
            <h3>Via data attributes</h3>
            <p>Just add <code>data-toggle="collapse"</code> and a <code>data-target</code> to element to automatically assign control of a collapsible element. The <code>data-target</code> attribute accepts a css selector to apply the collapse to. Be sure to add the class <code>collapse</code> to the collapsible element. If you'd like it to default open, add the additional class <code>in</code>.</p>
            <p>To add accordion-like group management to a collapsible control, add the data attribute <code>data-parent="#selector"</code>. Refer to the demo to see this in action.</p>
1259

1260
1261
            <h3>Via JavaScript</h3>
            <p>Enable manually with:</p>
1262
1263
            <pre class="prettyprint linenums">$(".collapse").collapse()</pre>

1264
1265
            <h3>Options</h3>
            <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-parent=""</code>.</p>
1266
1267
1268
            <table class="table table-bordered table-striped">
              <thead>
               <tr>
1269
1270
1271
1272
                 <th style="width: 100px;">Name</th>
                 <th style="width: 50px;">type</th>
                 <th style="width: 50px;">default</th>
                 <th>description</th>
1273
1274
1275
1276
               </tr>
              </thead>
              <tbody>
               <tr>
1277
1278
                 <td>parent</td>
                 <td>selector</td>
1279
                 <td>false</td>
1280
                 <td>If selector then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior)</td>
1281
1282
               </tr>
               <tr>
1283
1284
                 <td>toggle</td>
                 <td>boolean</td>
1285
                 <td>true</td>
1286
                 <td>Toggles the collapsible element on invocation</td>
1287
1288
1289
1290
1291
               </tr>
              </tbody>
            </table>


1292
1293
1294
            <h3>Methods</h3>
            <h4>.collapse(options)</h4>
            <p>Activates your content as a collapsible element. Accepts an optional options <code>object</code>.
1295
1296
<pre class="prettyprint linenums">
$('#myCollapsible').collapse({
Jacob Thornton's avatar
Jacob Thornton committed
1297
  toggle: false
1298
1299
})
</pre>
1300
            <h4>.collapse('toggle')</h4>
1301
            <p>Toggles a collapsible element to shown or hidden.</p>
1302
            <h4>.collapse('show')</h4>
1303
            <p>Shows a collapsible element.</p>
1304
            <h4>.collapse('hide')</h4>
1305
            <p>Hides a collapsible element.</p>
1306

1307
1308
            <h3>Events</h3>
            <p>Bootstrap's collapse class exposes a few events for hooking into collapse functionality.</p>
1309
1310
1311
            <table class="table table-bordered table-striped">
              <thead>
               <tr>
1312
1313
                 <th style="width: 150px;">Event</th>
                 <th>Description</th>
1314
1315
1316
1317
               </tr>
              </thead>
              <tbody>
               <tr>
1318
1319
                 <td>show</td>
                 <td>This event fires immediately when the <code>show</code> instance method is called.</td>
1320
1321
               </tr>
               <tr>
1322
1323
                 <td>shown</td>
                 <td>This event is fired when a collapse element has been made visible to the user (will wait for css transitions to complete).</td>
1324
1325
               </tr>
               <tr>
1326
                 <td>hide</td>
1327
                 <td>
1328
                  This event is fired immediately when the <code>hide</code> method has been called.
1329
1330
1331
                 </td>
               </tr>
               <tr>
1332
1333
                 <td>hidden</td>
                 <td>This event is fired when a collapse element has been hidden from the user (will wait for css transitions to complete).</td>
1334
1335
1336
               </tr>
              </tbody>
            </table>
1337
1338
<pre class="prettyprint linenums">
$('#myCollapsible').on('hidden', function () {
1339
  // do something…
1340
})</pre>
1341
          </section>
1342
1343
1344



1345
1346
1347
1348
           <!-- Carousel
          ================================================== -->
          <section id="carousel">
            <div class="page-header">
1349
              <h1>Carousel <small>bootstrap-carousel.js</small></h1>
1350
            </div>
1351

1352
1353
            <h2>Example carousel</h2>
            <p>The slideshow below shows a generic plugin and component for cycling through elements like a carousel.</p>
1354
1355
            <div class="bs-docs-example">
              <div id="myCarousel" class="carousel slide">
fat's avatar
fat committed
1356
1357
1358
1359
1360
                <ol class="carousel-indicators">
                  <li class="active"></li>
                  <li></li>
                  <li></li>
                </ol>
1361
1362
1363
1364
                <div class="carousel-inner">
                  <div class="item active">
                    <img src="assets/img/bootstrap-mdo-sfmoma-01.jpg" alt="">
                    <div class="carousel-caption">
1365
                      <h3>First slide label</h3>
1366
                      <p>Nulla vitae elit libero, a pharetra augue. Maecenas faucibus mollis interdum. Cum sociis natoque penatibus et magnis dis parturient montes.</p>
1367
                    </div>
1368
                  </div>
1369
1370
1371
                  <div class="item">
                    <img src="assets/img/bootstrap-mdo-sfmoma-02.jpg" alt="">
                    <div class="carousel-caption">
1372
                      <h3>Second slide label</h3>
1373
                      <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean lacinia bibendum nulla sed consectetur. Nullam quis risus eget urna mollis ornare.</p>
1374
                    </div>
1375
                  </div>
1376
1377
1378
                  <div class="item">
                    <img src="assets/img/bootstrap-mdo-sfmoma-03.jpg" alt="">
                    <div class="carousel-caption">
1379
                      <h3>Third slide label</h3>
1380
                      <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Integer posuere erat a ante venenatis dapibus posuere velit aliquet.</p>
1381
                    </div>
1382
                  </div>
1383
                </div>
Mark Otto's avatar
Mark Otto committed
1384
1385
1386
1387
1388
1389
                <a class="left carousel-control" href="#myCarousel" data-slide="prev">
                  <span class="control">&lsaquo;</span>
                </a>
                <a class="right carousel-control" href="#myCarousel" data-slide="next">
                  <span class="control">&rsaquo;</span>
                </a>
1390
              </div>
1391
            </div>{{! /example }}
1392
1393
<pre class="prettyprint linenums">
&lt;div id="myCarousel" class="carousel slide"&gt;
1394
  &lt;!-- Carousel items --&gt;
1395
1396
1397
1398
1399
  &lt;div class="carousel-inner"&gt;
    &lt;div class="active item"&gt;&lt;/div&gt;
    &lt;div class="item"&gt;&lt;/div&gt;
    &lt;div class="item"&gt;&lt;/div&gt;
  &lt;/div&gt;
1400
  &lt;!-- Carousel nav --&gt;
1401
1402
1403
1404
  &lt;a class="carousel-control left" href="#myCarousel" data-slide="prev"&gt;&amp;lsaquo;&lt;/a&gt;
  &lt;a class="carousel-control right" href="#myCarousel" data-slide="next"&gt;&amp;rsaquo;&lt;/a&gt;
&lt;/div&gt;
</pre>
1405

1406
            <div class="alert alert-warning">
1407
1408
              <strong>Heads up!</strong>
              When implementing this carousel, remove the images we have provided and replace them with your own.
1409
            </div>
1410
1411


1412
1413
1414
            <hr class="bs-docs-separator">


1415
            <h2>Usage</h2>
1416

1417
1418
            <h3>Via data attributes</h3>
            <p>...</p>
1419

1420
1421
            <h3>Via JavaScript</h3>
            <p>Call carousel manually with:</p>
1422
1423
            <pre class="prettyprint linenums">$('.carousel').carousel()</pre>

1424
1425
            <h3>Options</h3>
            <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-interval=""</code>.</p>
1426
1427
1428
            <table class="table table-bordered table-striped">
              <thead>
               <tr>
1429
1430
1431
1432
                 <th style="width: 100px;">Name</th>
                 <th style="width: 50px;">type</th>
                 <th style="width: 50px;">default</th>
                 <th>description</th>
1433
1434
1435
1436
               </tr>
              </thead>
              <tbody>
               <tr>
1437
1438
                 <td>interval</td>
                 <td>number</td>
1439
                 <td>5000</td>
1440
                 <td>The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.</td>
1441
1442
               </tr>
               <tr>
1443
1444
                 <td>pause</td>
                 <td>string</td>
1445
                 <td>"hover"</td>
1446
                 <td>Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.</td>
1447
1448
1449
1450
               </tr>
              </tbody>
            </table>

1451
1452
1453
            <h3>Methods</h3>
            <h4>.carousel(options)</h4>
            <p>Initializes the carousel with an optional options <code>object</code> and starts cycling through items.</p>
1454
<pre class="prettyprint linenums">
1455
$('.carousel').carousel({
Jacob Thornton's avatar
Jacob Thornton committed
1456
  interval: 2000
1457
1458
})
</pre>
1459
            <h4>.carousel('cycle')</h4>
1460
            <p>Cycles through the carousel items from left to right.</p>
1461
            <h4>.carousel('pause')</h4>
1462
            <p>Stops the carousel from cycling through items.</p>
1463
            <h4>.carousel(number)</h4>
1464
            <p>Cycles the carousel to a particular frame (0 based, similar to an array).</p>
1465
            <h4>.carousel('prev')</h4>
1466
            <p>Cycles to the previous item.</p>
1467
            <h4>.carousel('next')</h4>
1468
            <p>Cycles to the next item.</p>
1469

1470
1471
            <h3>Events</h3>
            <p>Bootstrap's carousel class exposes two events for hooking into carousel functionality.</p>
1472
1473
1474
            <table class="table table-bordered table-striped">
              <thead>
               <tr>
1475
1476
                 <th style="width: 150px;">Event</th>
                 <th>Description</th>
1477
1478
1479
1480
               </tr>
              </thead>
              <tbody>
               <tr>
1481
1482
                 <td>slide</td>
                 <td>This event fires immediately when the <code>slide</code> instance method is invoked.</td>
1483
1484
               </tr>
               <tr>
1485
1486
                 <td>slid</td>
                 <td>This event is fired when the carousel has completed its slide transition.</td>
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
               </tr>
              </tbody>
            </table>
          </section>



          <!-- Typeahead
          ================================================== -->
          <section id="typeahead">
            <div class="page-header">
1498
              <h1>Typeahead <small>bootstrap-typeahead.js</small></h1>
1499
            </div>
1500
1501


1502
1503
            <h2>Example</h2>
            <p>A basic, easily extended plugin for quickly creating elegant typeaheads with any form text input.</p>
1504
1505
1506
1507
1508
1509
1510
1511
1512
            <div class="bs-docs-example" style="background-color: #f5f5f5;">
              <input type="text" class="span3" style="margin: 0 auto;" data-provide="typeahead" data-items="4" data-source='["Alabama","Alaska","Arizona","Arkansas","California","Colorado","Connecticut","Delaware","Florida","Georgia","Hawaii","Idaho","Illinois","Indiana","Iowa","Kansas","Kentucky","Louisiana","Maine","Maryland","Massachusetts","Michigan","Minnesota","Mississippi","Missouri","Montana","Nebraska","Nevada","New Hampshire","New Jersey","New Mexico","New York","North Dakota","North Carolina","Ohio","Oklahoma","Oregon","Pennsylvania","Rhode Island","South Carolina","South Dakota","Tennessee","Texas","Utah","Vermont","Virginia","Washington","West Virginia","Wisconsin","Wyoming"]'>
            </div>{{! /example }}
            <pre class="prettyprint linenums">&lt;input type="text" data-provide="typeahead"&gt;</pre>


            <hr class="bs-docs-separator">


1513
            <h2>Usage</h2>
1514

1515
1516
            <h3>Via data attributes</h3>
            <p>Add data attributes to register an element with typeahead functionality as shown in the example above.</p>
1517

1518
1519
            <h3>Via JavaScript</h3>
            <p>Call the typeahead manually with:</p>
1520
1521
            <pre class="prettyprint linenums">$('.typeahead').typeahead()</pre>

1522
1523
            <h3>Options</h3>
            <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-source=""</code>.</p>
1524
1525
1526
            <table class="table table-bordered table-striped">
              <thead>
               <tr>
1527
1528
1529
1530
                 <th style="width: 100px;">Name</th>
                 <th style="width: 50px;">type</th>
                 <th style="width: 100px;">default</th>
                 <th>description</th>
1531
1532
1533
1534
               </tr>
              </thead>
              <tbody>
                <tr>
1535
1536
                 <td>source</td>
                 <td>array, function</td>
1537
                 <td>[ ]</td>
1538
                 <td>The data source to query against. May be an array of strings or a function. The function is passed two arguments, the <code>query</code> value in the input field and the <code>process</code> callback. The function may be used synchronously by returning the data source directly or asynchronously via the <code>process</code> callback's single argument.</td>
1539
1540
               </tr>
               <tr>
1541
1542
                 <td>items</td>
                 <td>number</td>
1543
                 <td>8</td>
1544
                 <td>The max number of items to display in the dropdown.</td>
1545
1546
               </tr>
               <tr>
1547
1548
1549
1550
                 <td>minLength</td>
                 <td>number</td>
                 <td>1</td>
                 <td>The minimum character length needed before triggering autocomplete suggestions</td>
1551
1552
               </tr>
               <tr>
1553
1554
1555
1556
                 <td>matcher</td>
                 <td>function</td>
                 <td>case insensitive</td>
                 <td>The method used to determine if a query matches an item. Accepts a single argument, the <code>item</code> against which to test the query. Access the current query with <code>this.query</code>. Return a boolean <code>true</code> if query is a match.</td>
1557
1558
               </tr>
               <tr>
1559
1560
1561
1562
                 <td>sorter</td>
                 <td>function</td>
                 <td>exact match,<br> case sensitive,<br> case insensitive</td>
                 <td>Method used to sort autocomplete results. Accepts a single argument <code>items</code> and has the scope of the typeahead instance. Reference the current query with <code>this.query</code>.</td>
1563
               </tr>
1564
               <tr>
1565
1566
1567
1568
                 <td>updater</td>
                 <td>function</td>
                 <td>returns selected item</td>
                 <td>The method used to return selected item. Accepts a single argument, the <code>item</code> and has the scope of the typeahead instance.</td>
1569
               </tr>
1570
               <tr>
1571
1572
1573
1574
                 <td>highlighter</td>
                 <td>function</td>
                 <td>highlights all default matches</td>
                 <td>Method used to highlight autocomplete results. Accepts a single argument <code>item</code> and has the scope of the typeahead instance. Should return html.</td>
1575
1576
1577
1578
               </tr>
              </tbody>
            </table>

1579
1580
1581
            <h3>Methods</h3>
            <h4>.typeahead(options)</h4>
            <p>Initializes an input with a typeahead.</p>
1582
1583
1584
1585
1586
1587
1588
1589
          </section>



          <!-- Affix
          ================================================== -->
          <section id="affix">
            <div class="page-header">
1590
              <h1>Affix <small>bootstrap-affix.js</small></h1>
1591
            </div>
1592

1593
1594
            <h2>Example</h2>
            <p>The subnavigation on the left is a live demo of the affix plugin.</p>
1595

1596
            <hr class="bs-docs-separator">
1597

1598
            <h2>Usage</h2>
Jacob Thornton's avatar
Jacob Thornton committed
1599

1600
1601
            <h3>Via data attributes</h3>
            <p>To easily add affix behavior to any element, just add <code>data-spy="affix"</code> to the element you want to spy on. Then use offsets to define when to toggle the pinning of an element on and off.</p>
Jacob Thornton's avatar
Jacob Thornton committed
1602

1603
            <pre class="prettyprint linenums">&lt;div data-spy="affix" data-offset-top="200"&gt;...&lt;/div&gt;</pre>
Jacob Thornton's avatar
Jacob Thornton committed
1604

1605
            <div class="alert alert-info">
1606
1607
              <strong>Heads up!</strong>
              You must manage the position of a pinned element and the behavior of its immediate parent. Position is controlled by <code>affix</code>, <code>affix-top</code>, and <code>affix-bottom</code>. Remember to check for a potentially collapsed parent when the affix kicks in as it's removing content from the normal flow of the page.
1608
            </div>
Jacob Thornton's avatar
Jacob Thornton committed
1609

1610
1611
            <h3>Via JavaScript</h3>
            <p>Call the affix plugin via JavaScript:</p>
1612
            <pre class="prettyprint linenums">$('#navbar').affix()</pre>
Jacob Thornton's avatar
Jacob Thornton committed
1613

1614
            <h3>Methods</h3>
1615
            <h4>.affix('refresh')</h4>
1616
            <p>When using affix in conjunction with adding or removing of elements from the DOM, you'll want to call the refresh method:</p>
1617
<pre class="prettyprint linenums">
Jacob Thornton's avatar
Jacob Thornton committed
1618
1619
1620
$('[data-spy="affix"]').each(function () {
  $(this).affix('refresh')
});
1621
</pre>
1622
1623
          <h3>Options</h3>
          <p>Options can be passed via data attributes or JavaScript. For data attributes, append the option name to <code>data-</code>, as in <code>data-offset-top="200"</code>.</p>
1624

1625
1626
1627
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
1628
1629
1630
1631
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
1632
1633
1634
1635
             </tr>
            </thead>
            <tbody>
             <tr>
1636
1637
1638
1639
               <td>offset</td>
               <td>number | function | object</td>
               <td>10</td>
               <td>Pixels to offset from screen when calculating position of scroll. If a single number is provided, the offset will be applied in both top and left directions. To listen for a single direction, or multiple unique offsets, just provide an object <code>offset: { x: 10 }</code>. Use a function when you need to dynamically provide an offset (useful for some responsive designs).</td>
1640
1641
1642
1643
             </tr>
            </tbody>
          </table>
        </section>
1644
1645


1646

1647
1648
      </div>{{! /span9 }}
    </div>{{! row}}
1649

1650
  </div>{{! /.container }}