javascript.mustache 81.2 KB
Newer Older
1
<!-- Subhead
2
================================================== -->
3
<header class="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
67
68
          <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>
          <p>All infinitive events provide preventDefault functionality. This provides the ability to stop the execution of an action before it starts.</p>
Jacob Thornton's avatar
Jacob Thornton committed
69
<pre class="prettyprint linenums">
70
71
72
$('#myModal').on('show', function (e) {
    if (!data) return e.preventDefault() // stops modal from being shown
})
Jacob Thornton's avatar
Jacob Thornton committed
73
</pre>
74
        </section>
75
76
77



78
79
80
81
        <!-- Transitions
        ================================================== -->
        <section id="transitions">
          <div class="page-header">
82
            <h1>Transitions <small>bootstrap-transition.js</small></h1>
83
          </div>
84
85
86
87
          <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>
88
          <ul>
89
90
91
92
            <li>Sliding or fading in modals</li>
            <li>Fading out tabs</li>
            <li>Fading out alerts</li>
            <li>Sliding carousel panes</li>
93
          </ul>
94

95
96
          {{! Ideas: include docs for .fade.in, .slide.in, etc }}
        </section>
97

98
99


Mark Otto's avatar
Mark Otto committed
100
101
102
103
        <!-- Modal
        ================================================== -->
        <section id="modals">
          <div class="page-header">
104
            <h1>Modals <small>bootstrap-modal.js</small></h1>
Mark Otto's avatar
Mark Otto committed
105
          </div>
106

107

108
109
          <h2>Examples</h2>
          <p>Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.</p>
110

111
112
          <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
113
          <div class="bs-docs-example" style="background-color: #f5f5f5;">
114
            <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
115
              <div class="modal-header">
116
                <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
117
                <h3>Modal header</h3>
118
              </div>
Mark Otto's avatar
Mark Otto committed
119
              <div class="modal-body">
120
                <p>One fine body&hellip;</p>
Mark Otto's avatar
Mark Otto committed
121
122
              </div>
              <div class="modal-footer">
123
124
                <a href="#" class="btn">Close</a>
                <a href="#" class="btn btn-primary">Save changes</a>
Mark Otto's avatar
Mark Otto committed
125
126
127
              </div>
            </div>
          </div>{{! /example }}
128
129
130
<pre class="prettyprint linenums">
&lt;div class="modal hide fade"&gt;
  &lt;div class="modal-header"&gt;
131
    &lt;button type="button" class="close" data-dismiss="modal" aria-hidden="true"&gt;&amp;times;&lt;/button&gt;
132
    &lt;h3&gt;Modal header&lt;/h3&gt;
133
134
  &lt;/div&gt;
  &lt;div class="modal-body"&gt;
135
    &lt;p&gt;One fine body&hellip;&lt;/p&gt;
136
137
  &lt;/div&gt;
  &lt;div class="modal-footer"&gt;
138
139
    &lt;a href="#" class="btn"&gt;Close&lt;/a&gt;
    &lt;a href="#" class="btn btn-primary"&gt;Save changes&lt;/a&gt;
140
141
142
143
  &lt;/div&gt;
&lt;/div&gt;
</pre>

144
145
          <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
146
          <!-- sample modal content -->
147
          <div id="myModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
Mark Otto's avatar
Mark Otto committed
148
            <div class="modal-header">
149
              <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
150
              <h3 id="myModalLabel">Modal Heading</h3>
Mark Otto's avatar
Mark Otto committed
151
152
            </div>
            <div class="modal-body">
153
              <h4>Text in a modal</h4>
Mark Otto's avatar
Mark Otto committed
154
155
              <p>Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem.</p>

156
157
              <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
158

159
160
              <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
161
162
163

              <hr>

164
165
              <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
166
167
168
169
170
171
              <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>
172
            </div>
Mark Otto's avatar
Mark Otto committed
173
            <div class="modal-footer">
174
175
              <button class="btn" data-dismiss="modal">Close</button>
              <button class="btn btn-primary">Save changes</button>
Mark Otto's avatar
Mark Otto committed
176
177
178
            </div>
          </div>
          <div class="bs-docs-example" style="padding-bottom: 24px;">
179
            <a data-toggle="modal" href="#myModal" class="btn btn-primary btn-large">Launch demo modal</a>
Mark Otto's avatar
Mark Otto committed
180
          </div>{{! /example }}
181
<pre class="prettyprint linenums">
Mark Otto's avatar
Mark Otto committed
182
&lt!-- Button to trigger modal --&gt;
183
&lt;a href="#myModal" role="button" class="btn" data-toggle="modal"&gt;Launch demo modal&lt;/a&gt;
184

Mark Otto's avatar
Mark Otto committed
185
&lt!-- Modal --&gt;
186
&lt;div id="myModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true"&gt;
187
  &lt;div class="modal-header"&gt;
188
    &lt;button type="button" class="close" data-dismiss="modal" aria-hidden="true"&gt;&times;&lt;/button&gt;
189
190
191
    &lt;h3 id="myModalLabel"&gt;Modal header&lt;/h3&gt;
  &lt;/div&gt;
  &lt;div class="modal-body"&gt;
192
    &lt;p&gt;One fine body&hellip;&lt;/p&gt;
193
194
  &lt;/div&gt;
  &lt;div class="modal-footer"&gt;
195
196
    &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;
197
198
199
  &lt;/div&gt;
&lt;/div&gt;
</pre>
200
201


Mark Otto's avatar
Mark Otto committed
202
203
204
          <hr class="bs-docs-separator">


205
          <h2>Usage</h2>
Mark Otto's avatar
Mark Otto committed
206

207
208
          <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
209
210
          <pre class="prettyprint linenums">&lt;button type="button" data-toggle="modal" data-target="#myModal"&gt;Launch modal&lt;/button&gt;</pre>

211
212
          <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
213
214
          <pre class="prettyprint linenums">$('#myModal').modal(options)</pre>

215
216
          <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
217
218
219
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
220
221
222
223
               <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
224
225
226
227
             </tr>
            </thead>
            <tbody>
             <tr>
228
229
230
231
               <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
232
233
             </tr>
             <tr>
234
235
236
237
               <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
238
239
             </tr>
             <tr>
240
241
242
243
               <td>show</td>
               <td>boolean</td>
               <td>true</td>
               <td>Shows the modal when initialized.</td>
Mark Otto's avatar
Mark Otto committed
244
245
             </tr>
             <tr>
246
247
248
249
               <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
250
251
252
253
254
              <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>

255
256
257
          <h3>Methods</h3>
          <h4>.modal(options)</h4>
          <p>Activates your content as a modal. Accepts an optional options <code>object</code>.</p>
258
259
<pre class="prettyprint linenums">
$('#myModal').modal({
Jacob Thornton's avatar
Jacob Thornton committed
260
  keyboard: false
261
262
})
</pre>
Mark Otto's avatar
Mark Otto committed
263
          <h4>.modal('toggle')</h4>
264
          <p>Manually toggles a modal.</p>
Mark Otto's avatar
Mark Otto committed
265
266
          <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre>
          <h4>.modal('show')</h4>
267
          <p>Manually opens a modal.</p>
Mark Otto's avatar
Mark Otto committed
268
269
          <pre class="prettyprint linenums">$('#myModal').modal('show')</pre>
          <h4>.modal('hide')</h4>
270
          <p>Manually hides a modal.</p>
Mark Otto's avatar
Mark Otto committed
271
          <pre class="prettyprint linenums">$('#myModal').modal('hide')</pre>
272
273
          <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
274
275
276
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
277
278
               <th style="width: 150px;">Event</th>
               <th>Description</th>
Mark Otto's avatar
Mark Otto committed
279
280
281
282
             </tr>
            </thead>
            <tbody>
             <tr>
283
284
               <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
285
286
             </tr>
             <tr>
287
288
               <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
289
290
             </tr>
             <tr>
291
292
               <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
293
294
             </tr>
             <tr>
295
296
               <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
297
298
299
             </tr>
            </tbody>
          </table>
300
301
<pre class="prettyprint linenums">
$('#myModal').on('hidden', function () {
302
  // do something…
303
304
})
</pre>
Mark Otto's avatar
Mark Otto committed
305
        </section>
306
307
308



Mark Otto's avatar
Mark Otto committed
309
        <!-- Dropdowns
Mark Otto's avatar
Mark Otto committed
310
311
312
        ================================================== -->
        <section id="dropdowns">
          <div class="page-header">
313
            <h1>Dropdowns <small>bootstrap-dropdown.js</small></h1>
Mark Otto's avatar
Mark Otto committed
314
          </div>
315
316


317
318
          <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
319

320
          <h3>Within a navbar</h3>
Mark Otto's avatar
Mark Otto committed
321
322
323
324
          <div class="bs-docs-example">
            <div id="navbar-example" class="navbar navbar-static">
              <div class="navbar-inner">
                <div class="container" style="width: auto;">
325
                  <a class="brand" href="#">Project Name</a>
Mark Otto's avatar
Mark Otto committed
326
327
                  <ul class="nav" role="navigation">
                    <li class="dropdown">
328
                      <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
329
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
330
331
332
                        <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
333
                        <li class="divider"></li>
334
                        <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
335
336
337
                      </ul>
                    </li>
                    <li class="dropdown">
338
                      <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
339
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop2">
340
341
342
                        <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
343
                        <li class="divider"></li>
344
                        <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
345
346
                      </ul>
                    </li>
347
                  </ul>
Mark Otto's avatar
Mark Otto committed
348
349
                  <ul class="nav pull-right">
                    <li id="fat-menu" class="dropdown">
350
                      <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
351
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop3">
352
353
354
                        <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
355
                        <li class="divider"></li>
356
                        <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
357
358
                      </ul>
                    </li>
359
                  </ul>
Mark Otto's avatar
Mark Otto committed
360
361
362
363
364
                </div>
              </div>
            </div> <!-- /navbar-example -->
          </div> {{! /example }}

365
          <h3>Within tabs</h3>
Mark Otto's avatar
Mark Otto committed
366
367
          <div class="bs-docs-example">
            <ul class="nav nav-pills">
368
              <li class="active"><a href="#">Regular link</a></li>
Mark Otto's avatar
Mark Otto committed
369
              <li class="dropdown">
370
                <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
371
                <ul id="menu1" class="dropdown-menu" role="menu" aria-labelledby="drop4">
372
373
374
                  <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
375
                  <li class="divider"></li>
376
                  <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
377
378
379
                </ul>
              </li>
              <li class="dropdown">
380
                <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
381
                <ul id="menu2" class="dropdown-menu" role="menu" aria-labelledby="drop5">
382
383
384
                  <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
385
                  <li class="divider"></li>
386
                  <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
387
388
389
                </ul>
              </li>
              <li class="dropdown">
390
                <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
391
                <ul id="menu3" class="dropdown-menu" role="menu" aria-labelledby="drop5">
392
393
394
                  <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
395
                  <li class="divider"></li>
396
                  <li><a tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
397
398
399
400
401
402
403
404
405
                </ul>
              </li>
            </ul> <!-- /tabs -->
          </div> {{! /example }}


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


406
          <h2>Usage</h2>
Mark Otto's avatar
Mark Otto committed
407

408
409
          <h3>Via data attributes</h3>
          <p>Add <code>data-toggle="dropdown"</code> to a link or button to toggle a dropdown.</p>
410
<pre class="prettyprint linenums">
411
&lt;div class="dropdown"&gt;
Mark Otto's avatar
Mark Otto committed
412
  &lt;a class="dropdown-toggle" data-toggle="dropdown" href="#"&gt;Dropdown trigger&lt;/a&gt;
413
414
415
416
417
  &lt;ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"&gt;
    ...
  &lt;/ul&gt;
&lt;/div&gt;
</pre>
418
          <p>To keep URLs intact, use the <code>data-target</code> attribute instead of <code>href="#"</code>.</p>
419
<pre class="prettyprint linenums">
420
421
&lt;div class="dropdown"&gt;
  &lt;a class="dropdown-toggle" id="dLabel" role="button" data-toggle="dropdown" data-target="#" href="/page.html"&gt;
422
    Dropdown
423
424
425
426
427
428
    &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;
429
</pre>
430

431
432
          <h3>Via JavaScript</h3>
          <p>Call the dropdowns via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
433
          <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre>
434

435
436
          <h3>Options</h3>
          <p><em>None</em></p>
437

438
          <h3>Methods</h3>
439
          <h4>$().dropdown('toggle')</h4>
440
          <p>A programmatic api for toggling menus for a given navbar or tabbed navigation.</p>
Mark Otto's avatar
Mark Otto committed
441
        </section>
442
443
444



Mark Otto's avatar
Mark Otto committed
445
446
447
448
        <!-- ScrollSpy
        ================================================== -->
        <section id="scrollspy">
          <div class="page-header">
449
            <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
Mark Otto's avatar
Mark Otto committed
450
          </div>
451
452


453
454
          <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
455
456
457
458
          <div class="bs-docs-example">
            <div id="navbarExample" class="navbar navbar-static">
              <div class="navbar-inner">
                <div class="container" style="width: auto;">
459
                  <a class="brand" href="#">Project Name</a>
Mark Otto's avatar
Mark Otto committed
460
461
462
463
                  <ul class="nav">
                    <li><a href="#fat">@fat</a></li>
                    <li><a href="#mdo">@mdo</a></li>
                    <li class="dropdown">
464
                      <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
Mark Otto's avatar
Mark Otto committed
465
                      <ul class="dropdown-menu">
466
467
                        <li><a href="#one">one</a></li>
                        <li><a href="#two">two</a></li>
Mark Otto's avatar
Mark Otto committed
468
                        <li class="divider"></li>
469
                        <li><a href="#three">three</a></li>
Mark Otto's avatar
Mark Otto committed
470
471
472
                      </ul>
                    </li>
                  </ul>
473
                </div>
474
              </div>
Mark Otto's avatar
Mark Otto committed
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
            </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 }}
491

492

Mark Otto's avatar
Mark Otto committed
493
          <hr class="bs-docs-separator">
494
495


496
          <h2>Usage</h2>
497

498
499
          <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
500
          <pre class="prettyprint linenums">&lt;body data-spy="scroll" data-target=".navbar"&gt;...&lt;/body&gt;</pre>
501

502
503
          <h3>Via JavaScript</h3>
          <p>Call the scrollspy via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
504
          <pre class="prettyprint linenums">$('#navbar').scrollspy()</pre>
505

Mark Otto's avatar
Mark Otto committed
506
          <div class="alert alert-info">
507
508
            <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
509
          </div>
510

511
          <h3>Methods</h3>
Mark Otto's avatar
Mark Otto committed
512
          <h4>.scrollspy('refresh')</h4>
513
          <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>
514
515
516
517
518
<pre class="prettyprint linenums">
$('[data-spy="scroll"]').each(function () {
  var $spy = $(this).scrollspy('refresh')
});
</pre>
519

520
521
          <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
522
523
524
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
525
526
527
528
               <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
529
530
531
532
             </tr>
            </thead>
            <tbody>
             <tr>
533
534
535
536
               <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
537
538
539
             </tr>
            </tbody>
          </table>
540

541
          <h3>Events</h3>
Mark Otto's avatar
Mark Otto committed
542
543
544
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
545
546
               <th style="width: 150px;">Event</th>
               <th>Description</th>
Mark Otto's avatar
Mark Otto committed
547
548
549
550
             </tr>
            </thead>
            <tbody>
             <tr>
551
552
               <td>activate</td>
               <td>This event fires whenever a new item becomes activated by the scrollspy.</td>
Mark Otto's avatar
Mark Otto committed
553
554
555
556
            </tr>
            </tbody>
          </table>
        </section>
557

Mark Otto's avatar
Mark Otto committed
558
559
560
561
562
563


        <!-- Tabs
        ================================================== -->
        <section id="tabs">
          <div class="page-header">
564
            <h1>Togglable tabs <small>bootstrap-tab.js</small></h1>
Mark Otto's avatar
Mark Otto committed
565
566
567
          </div>


568
569
          <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
570
571
          <div class="bs-docs-example">
            <ul id="myTab" class="nav nav-tabs">
572
573
              <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
574
              <li class="dropdown">
575
                <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
Mark Otto's avatar
Mark Otto committed
576
577
578
579
580
581
582
583
584
585
586
587
                <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>
588
              </div>
Mark Otto's avatar
Mark Otto committed
589
590
591
592
593
594
595
596
              <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 }}
597
598


Mark Otto's avatar
Mark Otto committed
599
          <hr class="bs-docs-separator">
600
601


602
603
          <h2>Usage</h2>
          <p>Enable tabbable tabs via JavaScript (each tab needs to be activated individually):</p>
604
<pre class="prettyprint linenums">
605
606
607
608
$('#myTab a').click(function (e) {
  e.preventDefault();
  $(this).tab('show');
})</pre>
609
          <p>You can activate individual tabs in several ways:</p>
610
<pre class="prettyprint linenums">
Mark Otto's avatar
Mark Otto committed
611
612
613
614
$('#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)
615
</pre>
616

617
618
          <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>
619
<pre class="prettyprint linenums">
620
&lt;ul class="nav nav-tabs"&gt;
621
622
623
624
  &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;
625
&lt;/ul&gt;</pre>
626
          <p>To make tabs fade in, add <code>.fade</code> to each <code>.tab-pane</code>.</p>
627

628
          <h3>Methods</h3>
Mark Otto's avatar
Mark Otto committed
629
630
          <h4>$().tab</h4>
          <p>
631
            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
632
          </p>
633
<pre class="prettyprint linenums">
634
&lt;ul class="nav nav-tabs" id="myTab"&gt;
635
636
637
638
  &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;
639
640
641
&lt;/ul&gt;

&lt;div class="tab-content"&gt;
Mark Otto's avatar
Mark Otto committed
642
643
644
645
  &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;
646
647
648
&lt;/div&gt;

&lt;script&gt;
Jacob Thornton's avatar
Jacob Thornton committed
649
  $(function () {
Mark Otto's avatar
Mark Otto committed
650
    $('#myTab a:last').tab('show');
Jacob Thornton's avatar
Jacob Thornton committed
651
  })
652
653
&lt;/script&gt;
</pre>
654

655
          <h3>Events</h3>
Mark Otto's avatar
Mark Otto committed
656
657
658
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
659
660
               <th style="width: 150px;">Event</th>
               <th>Description</th>
Mark Otto's avatar
Mark Otto committed
661
662
663
664
             </tr>
            </thead>
            <tbody>
             <tr>
665
666
               <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
667
668
            </tr>
            <tr>
669
670
               <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
671
672
673
             </tr>
            </tbody>
          </table>
674
<pre class="prettyprint linenums">
675
$('a[data-toggle="tab"]').on('shown', function (e) {
Jacob Thornton's avatar
Jacob Thornton committed
676
677
  e.target // activated tab
  e.relatedTarget // previous tab
678
679
})
</pre>
680
        </section>
681
682


683
684
685
686
        <!-- Tooltips
        ================================================== -->
        <section id="tooltips">
          <div class="page-header">
687
            <h1>Tooltips <small>bootstrap-tooltip.js</small></h1>
688
          </div>
689

690

691
692
693
          <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>
694
          <div class="bs-docs-example tooltip-demo">
695
            <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.
696
697
698
            </p>
          </div>{{! /example }}

699
          <h3>Four directions</h3>
700
701
702
703
704
705
706
707
708
709
710
711
712
          <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">


713
714
715
          <h2>Usage</h2>
          <p>Trigger the tooltip via JavaScript:</p>
          <pre class="prettyprint linenums">$('#example').tooltip(options)</pre>
716

717
718
          <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>
719
720
721
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
722
723
724
725
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
726
727
728
729
             </tr>
            </thead>
            <tbody>
             <tr>
730
731
               <td>animation</td>
               <td>boolean</td>
732
               <td>true</td>
733
               <td>apply a css fade transition to the tooltip</td>
734
735
             </tr>
             <tr>
736
737
               <td>html</td>
               <td>boolean</td>
738
               <td>false</td>
739
               <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>
740
741
             </tr>
             <tr>
742
743
               <td>placement</td>
               <td>string|function</td>
744
               <td>'top'</td>
745
               <td>how to position the tooltip - top | bottom | left | right</td>
746
747
             </tr>
             <tr>
748
749
               <td>selector</td>
               <td>string</td>
750
               <td>false</td>
751
               <td>If a selector is provided, tooltip objects will be delegated to the specified targets.</td>
752
753
             </tr>
             <tr>
754
755
               <td>title</td>
               <td>string | function</td>
756
               <td>''</td>
757
               <td>default title value if `title` tag isn't present</td>
758
759
             </tr>
             <tr>
760
761
               <td>trigger</td>
               <td>string</td>
762
               <td>'hover'</td>
763
               <td>how tooltip is triggered - click | hover | focus | manual</td>
764
765
             </tr>
             <tr>
766
767
               <td>delay</td>
               <td>number | object</td>
768
769
               <td>0</td>
               <td>
770
771
772
                <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>
773
774
775
776
777
               </td>
             </tr>
            </tbody>
          </table>
          <div class="alert alert-info">
778
779
            <strong>Heads up!</strong>
            Options for individual tooltips can alternatively be specified through the use of data attributes.
780
          </div>
781

782
783
784
          <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>
785

786
787
788
          <h3>Methods</h3>
          <h4>$().tooltip(options)</h4>
          <p>Attaches a tooltip handler to an element collection.</p>
789
          <h4>.tooltip('show')</h4>
790
          <p>Reveals an element's tooltip.</p>
791
792
          <pre class="prettyprint linenums">$('#element').tooltip('show')</pre>
          <h4>.tooltip('hide')</h4>
793
          <p>Hides an element's tooltip.</p>
794
795
          <pre class="prettyprint linenums">$('#element').tooltip('hide')</pre>
          <h4>.tooltip('toggle')</h4>
796
          <p>Toggles an element's tooltip.</p>
797
798
          <pre class="prettyprint linenums">$('#element').tooltip('toggle')</pre>
          <h4>.tooltip('destroy')</h4>
799
          <p>Hides and destroys an element's tooltip.</p>
800
801
          <pre class="prettyprint linenums">$('#element').tooltip('destroy')</pre>
        </section>
802
803
804
805
806
807
808



      <!-- Popovers
      ================================================== -->
      <section id="popovers">
        <div class="page-header">
809
          <h1>Popovers <small>bootstrap-popover.js</small></h1>
810
        </div>
811

812
813
        <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>
814

815
816
        <h3>Static popover</h3>
        <p>Four options are available: top, right, bottom, and left aligned.</p>
817
818
819
820
821
822
823
824
825
        <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
826
827
828
829
830
          <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>
831
            </div>
Mark Otto's avatar
Mark Otto committed
832
          </div>
833

Mark Otto's avatar
Mark Otto committed
834
835
836
837
838
          <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>
839
840
841
            </div>
          </div>

Mark Otto's avatar
Mark Otto committed
842
843
844
845
846
847
          <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>
848
          </div>
849

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

Mark Otto's avatar
Mark Otto committed
854
855
        <h3>Live demo</h3>
        <div class="bs-docs-example" style="padding-bottom: 24px;">
856
          <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
857
        </div>
858

859
        <h4>Four directions</h4>
860
861
862
863
864
865
866
867
868
        <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 }}

869

Mark Otto's avatar
Mark Otto committed
870
871
872
        <hr class="bs-docs-separator">


873
874
875
        <h2>Usage</h2>
        <p>Enable popovers via JavaScript:</p>
        <pre class="prettyprint linenums">$('#example').popover(options)</pre>
Mark Otto's avatar
Mark Otto committed
876

877
878
        <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
879
880
881
        <table class="table table-bordered table-striped">
          <thead>
           <tr>
882
883
884
885
             <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
886
887
888
889
           </tr>
          </thead>
          <tbody>
           <tr>
890
891
             <td>animation</td>
             <td>boolean</td>
Mark Otto's avatar
Mark Otto committed
892
             <td>true</td>
893
             <td>apply a css fade transition to the tooltip</td>
Mark Otto's avatar
Mark Otto committed
894
895
           </tr>
           <tr>
896
897
             <td>html</td>
             <td>boolean</td>
898
             <td>false</td>
899
             <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
900
901
           </tr>
           <tr>
902
903
             <td>placement</td>
             <td>string|function</td>
Mark Otto's avatar
Mark Otto committed
904
             <td>'right'</td>
905
             <td>how to position the popover - top | bottom | left | right</td>
Mark Otto's avatar
Mark Otto committed
906
907
           </tr>
           <tr>
908
909
             <td>selector</td>
             <td>string</td>
Mark Otto's avatar
Mark Otto committed
910
             <td>false</td>
911
             <td>if a selector is provided, tooltip objects will be delegated to the specified targets</td>
Mark Otto's avatar
Mark Otto committed
912
913
           </tr>
           <tr>
914
915
             <td>trigger</td>
             <td>string</td>
916
             <td>'click'</td>
917
             <td>how popover is triggered - click | hover | focus | manual</td>
Mark Otto's avatar
Mark Otto committed
918
919
           </tr>
           <tr>
920
921
             <td>title</td>
             <td>string | function</td>
Mark Otto's avatar
Mark Otto committed
922
             <td>''</td>
923
             <td>default title value if `title` attribute isn't present</td>
Mark Otto's avatar
Mark Otto committed
924
925
           </tr>
           <tr>
926
927
             <td>content</td>
             <td>string | function</td>
Mark Otto's avatar
Mark Otto committed
928
             <td>''</td>
929
             <td>default content value if `data-content` attribute isn't present</td>
Mark Otto's avatar
Mark Otto committed
930
931
           </tr>
           <tr>
932
933
             <td>delay</td>
             <td>number | object</td>
Mark Otto's avatar
Mark Otto committed
934
935
             <td>0</td>
             <td>
936
937
938
              <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
939
940
941
942
943
             </td>
           </tr>
          </tbody>
        </table>
        <div class="alert alert-info">
944
945
          <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
946
        </div>
947

948
949
        <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
950

951
952
953
        <h3>Methods</h3>
        <h4>$().popover(options)</h4>
        <p>Initializes popovers for an element collection.</p>
Mark Otto's avatar
Mark Otto committed
954
        <h4>.popover('show')</h4>
955
        <p>Reveals an elements popover.</p>
Mark Otto's avatar
Mark Otto committed
956
957
        <pre class="prettyprint linenums">$('#element').popover('show')</pre>
        <h4>.popover('hide')</h4>
958
        <p>Hides an elements popover.</p>
Mark Otto's avatar
Mark Otto committed
959
960
        <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
        <h4>.popover('toggle')</h4>
961
        <p>Toggles an elements popover.</p>
Mark Otto's avatar
Mark Otto committed
962
963
        <pre class="prettyprint linenums">$('#element').popover('toggle')</pre>
        <h4>.popover('destroy')</h4>
964
        <p>Hides and destroys an element's popover.</p>
Mark Otto's avatar
Mark Otto committed
965
966
967
968
969
970
971
972
973
        <pre class="prettyprint linenums">$('#element').popover('destroy')</pre>
      </section>



      <!-- Alert
      ================================================== -->
      <section id="alerts">
        <div class="page-header">
974
          <h1>Alert messages <small>bootstrap-alert.js</small></h1>
Mark Otto's avatar
Mark Otto committed
975
        </div>
976
977


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


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

For faster browsing, not all history is shown. View entire blame