javascript.html 90.6 KB
Newer Older
Jacob Thornton's avatar
Jacob Thornton committed
1
2
3
4
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
5
    <title>Javascript · Bootstrap</title>
Raul Riera's avatar
Raul Riera committed
6
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
Jacob Thornton's avatar
Jacob Thornton committed
7
8
9
    <meta name="description" content="">
    <meta name="author" content="">

10
    <!-- Bootstrap core CSS -->
11
    <link href="assets/css/bootstrap.css" rel="stylesheet">
12
13

    <!-- Documentation extras -->
14
    <link href="assets/css/docs.css" rel="stylesheet">
Jacob Thornton's avatar
Jacob Thornton committed
15
    <link href="assets/js/google-code-prettify/prettify.css" rel="stylesheet">
Jacob Thornton's avatar
Jacob Thornton committed
16

17
    <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
Mark Otto's avatar
Mark Otto committed
18
    <!--[if lt IE 9]>
19
      <script src="assets/js/html5shiv.js"></script>
20
      <script src="assets/js/respond/respond.min.js"></script>
Mark Otto's avatar
Mark Otto committed
21
22
    <![endif]-->

23
    <!-- Favicons -->
Mark Otto's avatar
Mark Otto committed
24
    <link rel="apple-touch-icon-precomposed" sizes="144x144" href="assets/ico/apple-touch-icon-144-precomposed.png">
25
    <link rel="apple-touch-icon-precomposed" sizes="114x114" href="assets/ico/apple-touch-icon-114-precomposed.png">
Mark Otto's avatar
Mark Otto committed
26
27
      <link rel="apple-touch-icon-precomposed" sizes="72x72" href="assets/ico/apple-touch-icon-72-precomposed.png">
                    <link rel="apple-touch-icon-precomposed" href="assets/ico/apple-touch-icon-57-precomposed.png">
28
                                   <link rel="shortcut icon" href="assets/ico/favicon.png">
29

Jacob Thornton's avatar
Jacob Thornton committed
30
31
  </head>

32
  <body data-spy="scroll" data-target=".bs-docs-sidebar">
33

Mark Otto's avatar
Mark Otto committed
34
35
    <!-- Navbar
    ================================================== -->
36
    <div class="navbar navbar-inverse navbar-fixed-top">
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
      <div class="container">
        <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="brand" href="./index.html">Bootstrap</a>
        <div class="nav-collapse collapse">
          <ul class="nav">
            <li class="">
              <a href="./index.html">Home</a>
            </li>
            <li class="">
              <a href="./getting-started.html">Get started</a>
            </li>
            <li class="">
53
              <a href="./css.html">CSS</a>
54
55
56
57
58
59
60
61
62
63
64
            </li>
            <li class="">
              <a href="./components.html">Components</a>
            </li>
            <li class="active">
              <a href="./javascript.html">JavaScript</a>
            </li>
            <li class="">
              <a href="./customize.html">Customize</a>
            </li>
          </ul>
Mark Otto's avatar
Mark Otto committed
65
66
67
68
        </div>
      </div>
    </div>

69
<!-- Subhead
70
================================================== -->
71
<header class="bs-docs-jumbotron subhead">
72
  <div class="container">
73
    <h1>JavaScript</h1>
74
    <p class="lead">Bring Bootstrap's components to life&mdash;now with 13 custom jQuery plugins.
75
  </div>
76
77
</header>

78
  <div class="container">
79

80
81
82
83
    <!-- Docs nav
    ================================================== -->
    <div class="row">
      <div class="span3 bs-docs-sidebar">
84
        <ul class="nav nav-list bs-docs-sidenav">
Mark Otto's avatar
Mark Otto committed
85
86
87
88
89
90
91
92
93
94
95
96
97
98
          <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>
99
100
101
        </ul>
      </div>
      <div class="span9">
102

Jacob Thornton's avatar
Jacob Thornton committed
103

104
105
106
107
        <!-- Overview
        ================================================== -->
        <section id="overview">
          <div class="page-header">
Mark Otto's avatar
Mark Otto committed
108
            <h1>JavaScript in Bootstrap</h1>
109
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
110

111
          <h3>Individual or compiled</h3>
112
          <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>
Jacob Thornton's avatar
Jacob Thornton committed
113

114
          <h3>Data attributes</h3>
115
          <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
116

117
118
          <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:
          <pre class="prettyprint linenums">$('body').off('.data-api')</pre>
119

Mark Otto's avatar
Mark Otto committed
120
          <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>
121
          <pre class="prettyprint linenums">$('body').off('.alert.data-api')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
122

123
124
125
126
          <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>
          <pre class="prettyprint linenums">$(".btn.danger").button("toggle").addClass("fat")</pre>
          <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
127
<pre class="prettyprint linenums">
128
129
130
$("#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
131
</pre>
Mark Otto's avatar
Mark Otto committed
132
          <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>
Jacob Thornton's avatar
Jacob Thornton committed
133

134
          <h3>No conflict</h3>
Mark Otto's avatar
Mark Otto committed
135
          <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>
136
137
138
139
140
141

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

142
          <h3>Events</h3>
Mark Otto's avatar
Mark Otto committed
143
          <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>
144
          <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
145
<pre class="prettyprint linenums">
146
147
148
$('#myModal').on('show', function (e) {
    if (!data) return e.preventDefault() // stops modal from being shown
})
Jacob Thornton's avatar
Jacob Thornton committed
149
</pre>
150
        </section>
151
152
153



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
        <!-- Transitions
        ================================================== -->
        <section id="transitions">
          <div class="page-header">
            <h1>Transitions <small>bootstrap-transition.js</small></h1>
          </div>
          <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>
          <ul>
            <li>Sliding or fading in modals</li>
            <li>Fading out tabs</li>
            <li>Fading out alerts</li>
            <li>Sliding carousel panes</li>
          </ul>
170

171
        </section>
172

Jacob Thornton's avatar
Jacob Thornton committed
173
174


Mark Otto's avatar
Mark Otto committed
175
176
177
178
179
180
        <!-- Modal
        ================================================== -->
        <section id="modals">
          <div class="page-header">
            <h1>Modals <small>bootstrap-modal.js</small></h1>
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
181

182

Mark Otto's avatar
Mark Otto committed
183
184
          <h2>Examples</h2>
          <p>Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.</p>
185

Mark Otto's avatar
Mark Otto committed
186
187
          <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
188
189
190
191
192
193
194
          <div class="bs-docs-example bs-docs-example-modal">

            <div class="modal">
              <div class="modal-dialog">
                <div class="modal-content">
                  <div class="modal-header">
                    <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
Mark Otto's avatar
Mark Otto committed
195
                    <h4 class="modal-title">Modal title</h4>
Mark Otto's avatar
Mark Otto committed
196
197
198
199
200
201
202
203
204
205
206
207
                  </div>
                  <div class="modal-body">
                    <p>One fine body&hellip;</p>
                  </div>
                  <div class="modal-footer">
                    <a href="#" class="btn">Close</a>
                    <a href="#" class="btn btn-primary">Save changes</a>
                  </div>
                </div><!-- /.modal-content -->
              </div><!-- /.modal-dalog -->
            </div><!-- /.modal -->

Mark Otto's avatar
Mark Otto committed
208
          </div>
209
<pre class="prettyprint linenums">
210
&lt;div class="modal fade"&gt;
Mark Otto's avatar
Mark Otto committed
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
  &lt;div class="modal-dialog"&gt;
    &lt;div class="modal-content"&gt;

      &lt;div class="modal-header"&gt;
        &lt;button type="button" class="close" data-dismiss="modal" aria-hidden="true"&gt;&amp;times;&lt;/button&gt;
        &lt;h4 class="modal-title"&gt;Modal title&lt;/h4&gt;
      &lt;/div&gt;
      &lt;div class="modal-body"&gt;
        &lt;p&gt;One fine body&hellip;&lt;/p&gt;
      &lt;/div&gt;
      &lt;div class="modal-footer"&gt;
        &lt;a href="#" class="btn"&gt;Close&lt;/a&gt;
        &lt;a href="#" class="btn btn-primary"&gt;Save changes&lt;/a&gt;
      &lt;/div&gt;

    &lt;/div&gt;
227
228
229
230
  &lt;/div&gt;
&lt;/div&gt;
</pre>

Mark Otto's avatar
Mark Otto committed
231
          <h3>Live demo</h3>
Mark Otto's avatar
Mark Otto committed
232
          <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
233
          <!-- sample modal content -->
234
          <div id="myModal" class="modal fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
Mark Otto's avatar
Mark Otto committed
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272

            <div class="modal-dialog">
              <div class="modal-content">

                <div class="modal-header">
                  <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
                  <h4 class="modal-title" id="myModalLabel">Modal Heading</h4>
                </div>
                <div class="modal-body">
                  <h4>Text in a modal</h4>
                  <p>Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem.</p>

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

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

                  <hr>

                  <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>
                  <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>
                </div>
                <div class="modal-footer">
                  <button class="btn" data-dismiss="modal">Close</button>
                  <button class="btn btn-primary">Save changes</button>
                </div>

              </div><!-- /.modal-content -->
            </div><!-- /.modal-dalog -->
          </div><!-- /.modal -->

Mark Otto's avatar
Mark Otto committed
273
274
275
          <div class="bs-docs-example" style="padding-bottom: 24px;">
            <a data-toggle="modal" href="#myModal" class="btn btn-primary btn-large">Launch demo modal</a>
          </div>
276
<pre class="prettyprint linenums">
Mark Otto's avatar
Mark Otto committed
277
&lt!-- Button to trigger modal --&gt;
278
279
&lt;a href="#myModal" role="button" class="btn" data-toggle="modal"&gt;Launch demo modal&lt;/a&gt;

Mark Otto's avatar
Mark Otto committed
280
&lt!-- Modal --&gt;
281
&lt;div id="myModal" class="modal fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true"&gt;
282
  &lt;div class="modal-header"&gt;
283
    &lt;button type="button" class="close" data-dismiss="modal" aria-hidden="true"&gt;&times;&lt;/button&gt;
284
285
286
    &lt;h3 id="myModalLabel"&gt;Modal header&lt;/h3&gt;
  &lt;/div&gt;
  &lt;div class="modal-body"&gt;
Mark Otto's avatar
Mark Otto committed
287
    &lt;p&gt;One fine body&hellip;&lt;/p&gt;
288
289
  &lt;/div&gt;
  &lt;div class="modal-footer"&gt;
290
    &lt;button class="btn" data-dismiss="modal" aria-hidden="true"&gt;Close&lt;/button&gt;
291
    &lt;button class="btn btn-primary"&gt;Save changes&lt;/button&gt;
292
293
294
  &lt;/div&gt;
&lt;/div&gt;
</pre>
295
296


Mark Otto's avatar
Mark Otto committed
297
298
299
300
301
302
          <hr class="bs-docs-separator">


          <h2>Usage</h2>

          <h3>Via data attributes</h3>
Mark Otto's avatar
Mark Otto committed
303
          <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
304
305
          <pre class="prettyprint linenums">&lt;button type="button" data-toggle="modal" data-target="#myModal"&gt;Launch modal&lt;/button&gt;</pre>

Mark Otto's avatar
Mark Otto committed
306
307
          <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
308
309
310
          <pre class="prettyprint linenums">$('#myModal').modal(options)</pre>

          <h3>Options</h3>
Mark Otto's avatar
Mark Otto committed
311
          <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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 50px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <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>
             </tr>
             <tr>
               <td>keyboard</td>
               <td>boolean</td>
               <td>true</td>
               <td>Closes the modal when escape key is pressed</td>
             </tr>
             <tr>
               <td>show</td>
               <td>boolean</td>
               <td>true</td>
               <td>Shows the modal when initialized.</td>
             </tr>
             <tr>
               <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>
              <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>

          <h3>Methods</h3>
          <h4>.modal(options)</h4>
          <p>Activates your content as a modal. Accepts an optional options <code>object</code>.</p>
Jacob Thornton's avatar
Jacob Thornton committed
353
<pre class="prettyprint linenums">
354
$('#myModal').modal({
Jacob Thornton's avatar
Jacob Thornton committed
355
  keyboard: false
356
357
})
</pre>
Mark Otto's avatar
Mark Otto committed
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
          <h4>.modal('toggle')</h4>
          <p>Manually toggles a modal.</p>
          <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre>
          <h4>.modal('show')</h4>
          <p>Manually opens a modal.</p>
          <pre class="prettyprint linenums">$('#myModal').modal('show')</pre>
          <h4>.modal('hide')</h4>
          <p>Manually hides a modal.</p>
          <pre class="prettyprint linenums">$('#myModal').modal('hide')</pre>
          <h3>Events</h3>
          <p>Bootstrap's modal class exposes a few events for hooking into modal functionality.</p>
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 150px;">Event</th>
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>show</td>
               <td>This event fires immediately when the <code>show</code> instance method is called.</td>
             </tr>
             <tr>
               <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>
             </tr>
             <tr>
               <td>hide</td>
               <td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
             </tr>
             <tr>
               <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>
             </tr>
            </tbody>
          </table>
395
<pre class="prettyprint linenums">
396
$('#myModal').on('hidden', function () {
397
  // do something…
398
399
})
</pre>
Mark Otto's avatar
Mark Otto committed
400
        </section>
Jacob Thornton's avatar
Jacob Thornton committed
401
402
403



Mark Otto's avatar
Mark Otto committed
404
        <!-- Dropdowns
Mark Otto's avatar
Mark Otto committed
405
406
407
408
409
        ================================================== -->
        <section id="dropdowns">
          <div class="page-header">
            <h1>Dropdowns <small>bootstrap-dropdown.js</small></h1>
          </div>
410
411


Mark Otto's avatar
Mark Otto committed
412
413
414
415
416
417
418
419
420
421
422
423
424
          <h2>Examples</h2>
          <p>Add dropdown menus to nearly anything with this simple plugin, including the navbar, tabs, and pills.</p>

          <h3>Within a navbar</h3>
          <div class="bs-docs-example">
            <div id="navbar-example" class="navbar navbar-static">
              <div class="navbar-inner">
                <div class="container" style="width: auto;">
                  <a class="brand" href="#">Project Name</a>
                  <ul class="nav" role="navigation">
                    <li class="dropdown">
                      <a id="drop1" href="#" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
425
426
427
428
429
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="http://google.com">Action</a></li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="#anotherAction">Another action</a></li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Something else here</a></li>
                        <li role="presentation" class="divider"></li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
430
431
432
433
434
                      </ul>
                    </li>
                    <li class="dropdown">
                      <a href="#" id="drop2" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown 2 <b class="caret"></b></a>
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop2">
435
436
437
438
439
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Action</a></li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Another action</a></li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Something else here</a></li>
                        <li role="presentation" class="divider"></li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
440
441
                      </ul>
                    </li>
442
                  </ul>
Mark Otto's avatar
Mark Otto committed
443
444
445
446
                  <ul class="nav pull-right">
                    <li id="fat-menu" class="dropdown">
                      <a href="#" id="drop3" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown 3 <b class="caret"></b></a>
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop3">
447
448
449
450
451
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Action</a></li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Another action</a></li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Something else here</a></li>
                        <li role="presentation" class="divider"></li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
452
453
                      </ul>
                    </li>
454
                  </ul>
Mark Otto's avatar
Mark Otto committed
455
456
457
458
459
460
461
462
463
464
465
466
                </div>
              </div>
            </div> <!-- /navbar-example -->
          </div> 

          <h3>Within tabs</h3>
          <div class="bs-docs-example">
            <ul class="nav nav-pills">
              <li class="active"><a href="#">Regular link</a></li>
              <li class="dropdown">
                <a class="dropdown-toggle" id="drop4" role="button" data-toggle="dropdown" href="#">Dropdown <b class="caret"></b></a>
                <ul id="menu1" class="dropdown-menu" role="menu" aria-labelledby="drop4">
467
468
469
470
471
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Action</a></li>
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Another action</a></li>
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Something else here</a></li>
                  <li role="presentation" class="divider"></li>
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
472
473
474
475
476
                </ul>
              </li>
              <li class="dropdown">
                <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">Dropdown 2 <b class="caret"></b></a>
                <ul id="menu2" class="dropdown-menu" role="menu" aria-labelledby="drop5">
477
478
479
480
481
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Action</a></li>
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Another action</a></li>
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Something else here</a></li>
                  <li role="presentation" class="divider"></li>
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
482
483
484
485
486
                </ul>
              </li>
              <li class="dropdown">
                <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">Dropdown 3 <b class="caret"></b></a>
                <ul id="menu3" class="dropdown-menu" role="menu" aria-labelledby="drop5">
487
488
489
490
491
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Action</a></li>
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Another action</a></li>
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Something else here</a></li>
                  <li role="presentation" class="divider"></li>
                  <li role="presentation"><a role="menuitem" tabindex="-1" href="#">Separated link</a></li>
Mark Otto's avatar
Mark Otto committed
492
493
494
495
                </ul>
              </li>
            </ul> <!-- /tabs -->
          </div> 
496
497


Mark Otto's avatar
Mark Otto committed
498
          <hr class="bs-docs-separator">
499
500


Mark Otto's avatar
Mark Otto committed
501
          <h2>Usage</h2>
502

Mark Otto's avatar
Mark Otto committed
503
504
          <h3>Via data attributes</h3>
          <p>Add <code>data-toggle="dropdown"</code> to a link or button to toggle a dropdown.</p>
505
<pre class="prettyprint linenums">
506
&lt;div class="dropdown"&gt;
Mark Otto's avatar
Mark Otto committed
507
  &lt;a class="dropdown-toggle" data-toggle="dropdown" href="#"&gt;Dropdown trigger&lt;/a&gt;
508
509
510
511
512
  &lt;ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"&gt;
    ...
  &lt;/ul&gt;
&lt;/div&gt;
</pre>
Mark Otto's avatar
Mark Otto committed
513
          <p>To keep URLs intact, use the <code>data-target</code> attribute instead of <code>href="#"</code>.</p>
514
<pre class="prettyprint linenums">
515
516
517
518
519
520
521
522
523
&lt;div class="dropdown"&gt;
  &lt;a class="dropdown-toggle" id="dLabel" role="button" data-toggle="dropdown" data-target="#" href="/page.html"&gt;
    Dropdown
    &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;
524
</pre>
525

Mark Otto's avatar
Mark Otto committed
526
527
          <h3>Via JavaScript</h3>
          <p>Call the dropdowns via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
528
          <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre>
529

Mark Otto's avatar
Mark Otto committed
530
531
          <h3>Options</h3>
          <p><em>None</em></p>
532

Mark Otto's avatar
Mark Otto committed
533
          <h3>Methods</h3>
534
          <h4>$().dropdown('toggle')</h4>
535
          <p>A programmatic api for toggling menus for a given navbar or tabbed navigation.</p>
Mark Otto's avatar
Mark Otto committed
536
        </section>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
537

538
539


Mark Otto's avatar
Mark Otto committed
540
541
542
543
544
545
        <!-- ScrollSpy
        ================================================== -->
        <section id="scrollspy">
          <div class="page-header">
            <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
          </div>
546
547


Mark Otto's avatar
Mark Otto committed
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
          <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>
          <div class="bs-docs-example">
            <div id="navbarExample" class="navbar navbar-static">
              <div class="navbar-inner">
                <div class="container" style="width: auto;">
                  <a class="brand" href="#">Project Name</a>
                  <ul class="nav">
                    <li><a href="#fat">@fat</a></li>
                    <li><a href="#mdo">@mdo</a></li>
                    <li class="dropdown">
                      <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
                      <ul class="dropdown-menu">
                        <li><a href="#one">one</a></li>
                        <li><a href="#two">two</a></li>
                        <li class="divider"></li>
                        <li><a href="#three">three</a></li>
                      </ul>
                    </li>
                  </ul>
568
                </div>
569
              </div>
570
            </div>
Mark Otto's avatar
Mark Otto committed
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
            <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>
586

587

Mark Otto's avatar
Mark Otto committed
588
          <hr class="bs-docs-separator">
589
590


Mark Otto's avatar
Mark Otto committed
591
          <h2>Usage</h2>
592

Mark Otto's avatar
Mark Otto committed
593
          <h3>Via data attributes</h3>
594
          <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
595
          <pre class="prettyprint linenums">&lt;body data-spy="scroll" data-target=".navbar"&gt;...&lt;/body&gt;</pre>
596

Mark Otto's avatar
Mark Otto committed
597
598
          <h3>Via JavaScript</h3>
          <p>Call the scrollspy via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
599
          <pre class="prettyprint linenums">$('#navbar').scrollspy()</pre>
600

Mark Otto's avatar
Mark Otto committed
601
602
603
604
          <div class="alert alert-info">
            <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>.
          </div>
605

Mark Otto's avatar
Mark Otto committed
606
607
608
          <h3>Methods</h3>
          <h4>.scrollspy('refresh')</h4>
          <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>
609
610
611
612
613
<pre class="prettyprint linenums">
$('[data-spy="scroll"]').each(function () {
  var $spy = $(this).scrollspy('refresh')
});
</pre>
614

Mark Otto's avatar
Mark Otto committed
615
          <h3>Options</h3>
Mark Otto's avatar
Mark Otto committed
616
          <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
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>offset</td>
               <td>number</td>
               <td>10</td>
               <td>Pixels to offset from top when calculating position of scroll.</td>
             </tr>
            </tbody>
          </table>

          <h3>Events</h3>
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 150px;">Event</th>
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>activate</td>
               <td>This event fires whenever a new item becomes activated by the scrollspy.</td>
            </tr>
            </tbody>
          </table>
        </section>
652
653


Mark Otto's avatar
Mark Otto committed
654
655
656
657
658
659
660
661
662
663

        <!-- Tabs
        ================================================== -->
        <section id="tabs">
          <div class="page-header">
            <h1>Togglable tabs <small>bootstrap-tab.js</small></h1>
          </div>


          <h2>Example tabs</h2>
664
          <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
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
          <div class="bs-docs-example">
            <ul id="myTab" class="nav nav-tabs">
              <li class="active"><a href="#home" data-toggle="tab">Home</a></li>
              <li><a href="#profile" data-toggle="tab">Profile</a></li>
              <li class="dropdown">
                <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
                <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>
              </div>
              <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>
689
              </div>
690
            </div>
Mark Otto's avatar
Mark Otto committed
691
          </div>
692

693

Mark Otto's avatar
Mark Otto committed
694
          <hr class="bs-docs-separator">
695
696


Mark Otto's avatar
Mark Otto committed
697
          <h2>Usage</h2>
Mark Otto's avatar
Mark Otto committed
698
          <p>Enable tabbable tabs via JavaScript (each tab needs to be activated individually):</p>
699
<pre class="prettyprint linenums">
700
701
702
703
$('#myTab a').click(function (e) {
  e.preventDefault();
  $(this).tab('show');
})</pre>
Mark Otto's avatar
Mark Otto committed
704
          <p>You can activate individual tabs in several ways:</p>
705
<pre class="prettyprint linenums">
706
707
708
709
$('#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)
710
</pre>
711

Mark Otto's avatar
Mark Otto committed
712
          <h3>Markup</h3>
Mark Otto's avatar
Mark Otto committed
713
          <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>
714
<pre class="prettyprint linenums">
715
&lt;ul class="nav nav-tabs"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
716
717
718
  &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;
Kyle Robinson Young's avatar
Kyle Robinson Young committed
719
  &lt;li&gt;&lt;a href="#settings" data-toggle="tab"&gt;Settings&lt;/a&gt;&lt;/li&gt;
720
&lt;/ul&gt;</pre>
721
          <p>To make tabs fade in, add <code>.fade</code> to each <code>.tab-pane</code>.</p>
722

Mark Otto's avatar
Mark Otto committed
723
724
725
726
727
          <h3>Methods</h3>
          <h4>$().tab</h4>
          <p>
            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.
          </p>
728
<pre class="prettyprint linenums">
729
&lt;ul class="nav nav-tabs" id="myTab"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
730
731
732
733
  &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;
734
735
&lt;/ul&gt;

736
&lt;div class="tab-content"&gt;
Mark Otto's avatar
Mark Otto committed
737
738
739
740
  &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;
741
&lt;/div&gt;
742
743

&lt;script&gt;
Jacob Thornton's avatar
Jacob Thornton committed
744
  $(function () {
745
    $('#myTab a:last').tab('show');
Jacob Thornton's avatar
Jacob Thornton committed
746
  })
747
748
&lt;/script&gt;
</pre>
749

Mark Otto's avatar
Mark Otto committed
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
          <h3>Events</h3>
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 150px;">Event</th>
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <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>
            </tr>
            <tr>
               <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>
             </tr>
            </tbody>
          </table>
769
<pre class="prettyprint linenums">
770
$('a[data-toggle="tab"]').on('shown', function (e) {
Jacob Thornton's avatar
Jacob Thornton committed
771
772
  e.target // activated tab
  e.relatedTarget // previous tab
773
774
})
</pre>
775
        </section>
Jacob Thornton's avatar
Jacob Thornton committed
776
777


778
779
780
781
782
783
        <!-- Tooltips
        ================================================== -->
        <section id="tooltips">
          <div class="page-header">
            <h1>Tooltips <small>bootstrap-tooltip.js</small></h1>
          </div>
784
785


786
787
788
789
          <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>
          <div class="bs-docs-example tooltip-demo">
790
            <p class="muted" style="margin-bottom: 0;">Tight pants next level keffiyeh <a href="#" data-toggle="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="#" data-toggle="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="#" data-toggle="tooltip" title="Another one here too">whatever keytar</a>, scenester farm-to-table banksy Austin <a href="#" data-toggle="tooltip" title="The last tip!">twitter handle</a> freegan cred raw denim single-origin coffee viral.
791
792
            </p>
          </div>
793

794
795
796
          <h3>Four directions</h3>
          <div class="bs-docs-example tooltip-demo">
            <ul class="bs-docs-tooltip-examples">
797
798
799
800
              <li><a href="#" data-toggle="tooltip" data-placement="top" title="Tooltip on top">Tooltip on top</a></li>
              <li><a href="#" data-toggle="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</a></li>
              <li><a href="#" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">Tooltip on bottom</a></li>
              <li><a href="#" data-toggle="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</a></li>
801
802
            </ul>
          </div>
803
804


805
806
807
808
          <hr class="bs-docs-separator">


          <h2>Usage</h2>
Mark Otto's avatar
Mark Otto committed
809
          <p>Trigger the tooltip via JavaScript:</p>
810
811
812
          <pre class="prettyprint linenums">$('#example').tooltip(options)</pre>

          <h3>Options</h3>
Mark Otto's avatar
Mark Otto committed
813
          <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>
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>animation</td>
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
               <td>html</td>
               <td>boolean</td>
833
               <td>false</td>
834
835
836
837
               <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>
             </tr>
             <tr>
               <td>placement</td>
838
               <td>string | function</td>
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
               <td>'top'</td>
               <td>how to position the tooltip - top | bottom | left | right</td>
             </tr>
             <tr>
               <td>selector</td>
               <td>string</td>
               <td>false</td>
               <td>If a selector is provided, tooltip objects will be delegated to the specified targets.</td>
             </tr>
             <tr>
               <td>title</td>
               <td>string | function</td>
               <td>''</td>
               <td>default title value if `title` tag isn't present</td>
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
857
               <td>'hover focus'</td>
fat's avatar
fat committed
858
               <td>how tooltip is triggered - click | hover | focus | manual. Note you case pass trigger mutliple, space seperated, trigger types.</td>
859
860
861
862
863
864
865
866
867
868
869
             </tr>
             <tr>
               <td>delay</td>
               <td>number | object</td>
               <td>0</td>
               <td>
                <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>
               </td>
             </tr>
Yohn's avatar
Yohn committed
870
871
             <tr>
               <td>container</td>
Yohn's avatar
Yohn committed
872
873
               <td>string | false</td>
               <td>false</td>
Yohn's avatar
Yohn committed
874
               <td>
Yohn's avatar
Yohn committed
875
                <p>Appends the tooltip to a specific element <code>container: 'body'</code></p>
Yohn's avatar
Yohn committed
876
877
               </td>
             </tr>
878
879
880
881
882
883
            </tbody>
          </table>
          <div class="alert alert-info">
            <strong>Heads up!</strong>
            Options for individual tooltips can alternatively be specified through the use of data attributes.
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
884

885
          <h3>Markup</h3>
886
          <pre class="prettyprint linenums">&lt;a href="#" data-toggle="tooltip" title="first tooltip"&gt;hover over me&lt;/a&gt;</pre>
Jacob Thornton's avatar
Jacob Thornton committed
887

888
889
890
891
892
893
894
895
896
897
898
899
900
          <h3>Methods</h3>
          <h4>$().tooltip(options)</h4>
          <p>Attaches a tooltip handler to an element collection.</p>
          <h4>.tooltip('show')</h4>
          <p>Reveals an element's tooltip.</p>
          <pre class="prettyprint linenums">$('#element').tooltip('show')</pre>
          <h4>.tooltip('hide')</h4>
          <p>Hides an element's tooltip.</p>
          <pre class="prettyprint linenums">$('#element').tooltip('hide')</pre>
          <h4>.tooltip('toggle')</h4>
          <p>Toggles an element's tooltip.</p>
          <pre class="prettyprint linenums">$('#element').tooltip('toggle')</pre>
          <h4>.tooltip('destroy')</h4>
901
          <p>Hides and destroys an element's tooltip.</p>
902
903
          <pre class="prettyprint linenums">$('#element').tooltip('destroy')</pre>
        </section>
904
905
906
907
908
909
910
911



      <!-- Popovers
      ================================================== -->
      <section id="popovers">
        <div class="page-header">
          <h1>Popovers <small>bootstrap-popover.js</small></h1>
912
        </div>
Jacob Thornton's avatar
Jacob Thornton committed
913

914
915
916
917
918
919
920
921
922
923
924
925
        <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>

        <h3>Static popover</h3>
        <p>Four options are available: top, right, bottom, and left aligned.</p>
        <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>
926
          </div>
927

Mark Otto's avatar
Mark Otto committed
928
929
930
931
932
          <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>
933
            </div>
Mark Otto's avatar
Mark Otto committed
934
          </div>
935

Mark Otto's avatar
Mark Otto committed
936
937
938
939
940
          <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>
941
942
            </div>
          </div>
943

Mark Otto's avatar
Mark Otto committed
944
945
946
947
948
949
          <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>
950
          </div>
951

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

Mark Otto's avatar
Mark Otto committed
956
957
        <h3>Live demo</h3>
        <div class="bs-docs-example" style="padding-bottom: 24px;">
958
          <a href="#" class="btn btn-large btn-danger" data-toggle="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
959
        </div>
960

961
962
963
        <h4>Four directions</h4>
        <div class="bs-docs-example tooltip-demo">
          <ul class="bs-docs-tooltip-examples">
964
965
966
967
            <li><a href="#" class="btn" data-toggle="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" data-toggle="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" data-toggle="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" data-toggle="popover" data-placement="left" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus." title="Popover on left">Popover on left</a></li>
968
969
970
          </ul>
        </div>

971

Mark Otto's avatar
Mark Otto committed
972
973
974
975
        <hr class="bs-docs-separator">


        <h2>Usage</h2>
Mark Otto's avatar
Mark Otto committed
976
        <p>Enable popovers via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
977
978
979
        <pre class="prettyprint linenums">$('#example').popover(options)</pre>

        <h3>Options</h3>
Mark Otto's avatar
Mark Otto committed
980
        <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
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
        <table class="table table-bordered table-striped">
          <thead>
           <tr>
             <th style="width: 100px;">Name</th>
             <th style="width: 100px;">type</th>
             <th style="width: 50px;">default</th>
             <th>description</th>
           </tr>
          </thead>
          <tbody>
           <tr>
             <td>animation</td>
             <td>boolean</td>
             <td>true</td>
             <td>apply a css fade transition to the tooltip</td>
           </tr>
           <tr>
             <td>html</td>
             <td>boolean</td>
1000
             <td>false</td>
For faster browsing, not all history is shown. View entire blame