javascript.html 73.9 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 · Twitter 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
10
    <meta name="description" content="">
    <meta name="author" content="">

    <!-- Le styles -->
11
12
    <link href="assets/css/bootstrap.css" rel="stylesheet">
    <link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
13
    <link href="assets/css/docs.css" rel="stylesheet">
Jacob Thornton's avatar
Jacob Thornton committed
14
    <link href="assets/js/google-code-prettify/prettify.css" rel="stylesheet">
Jacob Thornton's avatar
Jacob Thornton committed
15

Mark Otto's avatar
Mark Otto committed
16
17
18
19
20
    <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
    <!--[if lt IE 9]>
      <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->

Jacob Thornton's avatar
Jacob Thornton committed
21
    <!-- Le fav and touch icons -->
Mark Otto's avatar
Mark Otto committed
22
    <link rel="shortcut icon" href="assets/ico/favicon.ico">
Mark Otto's avatar
Mark Otto committed
23
    <link rel="apple-touch-icon-precomposed" sizes="144x144" href="assets/ico/apple-touch-icon-144-precomposed.png">
24
    <link rel="apple-touch-icon-precomposed" sizes="114x114" href="assets/ico/apple-touch-icon-114-precomposed.png">
25
26
    <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">
Jacob Thornton's avatar
Jacob Thornton committed
27
28
  </head>

Jacob Thornton's avatar
Jacob Thornton committed
29
  <body data-spy="scroll" data-target=".subnav" data-offset="50">
30
31


Jacob Thornton's avatar
Jacob Thornton committed
32
  <!-- Navbar
Jacob Thornton's avatar
Jacob Thornton committed
33
    ================================================== -->
34
    <div class="navbar navbar-fixed-top">
35
36
      <div class="navbar-inner">
        <div class="container">
37
          <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
Mark Otto's avatar
Mark Otto committed
38
39
40
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
41
          </a>
42
          <a class="brand" href="./index.html">Bootstrap</a>
Jacob Thornton's avatar
Jacob Thornton committed
43
          <div class="nav-collapse collapse">
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
            <ul class="nav">
              <li class="">
                <a href="./index.html">Overview</a>
              </li>
              <li class="">
                <a href="./scaffolding.html">Scaffolding</a>
              </li>
              <li class="">
                <a href="./base-css.html">Base CSS</a>
              </li>
              <li class="">
                <a href="./components.html">Components</a>
              </li>
              <li class="active">
                <a href="./javascript.html">Javascript plugins</a>
              </li>
              <li class="">
                <a href="./less.html">Using LESS</a>
              </li>
63
              <li class="divider-vertical"></li>
64
65
66
              <li class="">
                <a href="./download.html">Customize</a>
              </li>
67
68
69
              <li class="">
                <a href="./examples.html">Examples</a>
              </li>
70
71
            </ul>
          </div>
72
73
74
75
76
        </div>
      </div>
    </div>

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

78
79
80
81
      <!-- Masthead
      ================================================== -->
      <header class="jumbotron subhead" id="overview">
        <h1>Javascript for Bootstrap</h1>
82
        <p class="lead">Bring Bootstrap's components to life&mdash;now with 12 custom <a href="http://jquery.com/" target="_blank">jQuery</a> plugins.
Mark Otto's avatar
Mark Otto committed
83
        <div class="subnav">
84
          <ul class="nav nav-pills">
85
            <li><a href="#javascript">All plugins</a></li>
86
87
88
89
90
91
92
93
94
95
96
            <li><a href="#modals">Modal</a></li>
            <li><a href="#dropdowns">Dropdown</a></li>
            <li><a href="#scrollspy">Scrollspy</a></li>
            <li><a href="#tabs">Tab</a></li>
            <li><a href="#tooltips">Tooltip</a></li>
            <li><a href="#popovers">Popover</a></li>
            <li><a href="#alerts">Alert</a></li>
            <li><a href="#buttons">Button</a></li>
            <li><a href="#collapse">Collapse</a></li>
            <li><a href="#carousel">Carousel</a></li>
            <li><a href="#typeahead">Typeahead</a></li>
Mark Otto's avatar
Mark Otto committed
97
98
          </ul>
        </div>
99
100
101
      </header>


Jacob Thornton's avatar
Jacob Thornton committed
102
103
104
105
106
      <!-- Using Javascript w/ Bootstrap
      ================================================== -->
      <section id="javascript">
        <div class="page-header">
          <h1>jQuery plugins <small>A dozen Bootstrap plugins to get you started</small></h1>
107
        </div>
Jacob Thornton's avatar
Jacob Thornton committed
108
109
      <div class="row">
        <div class="span3">
110
111
          <h3><a href="./javascript.html#modals">Modals</a></h3>
          <p>A streamlined, but flexible, take on the traditional javascript modal plugin with only the minimum required functionality and smart defaults.</p>
112
        </div>
Jacob Thornton's avatar
Jacob Thornton committed
113
        <div class="span3">
114
115
          <h3><a href="./javascript.html#dropdowns">Dropdowns</a></h3>
          <p>Add dropdown menus to nearly anything in Bootstrap with this simple plugin. Bootstrap features full dropdown menu support on in the navbar, tabs, and pills.</p>
Jacob Thornton's avatar
Jacob Thornton committed
116
117
        </div>
        <div class="span3">
118
119
          <h3><a href="./javascript.html#scrollspy">Scrollspy</a></h3>
          <p>Use scrollspy to automatically update the links in your navbar to show the current active link based on scroll position.</p>
Jacob Thornton's avatar
Jacob Thornton committed
120
121
        </div>
        <div class="span3">
122
123
          <h3><a href="./javascript.html#tabs">Togglable tabs</a></h3>
          <p>Use this plugin to make tabs and pills more useful by allowing them to toggle through tabbable panes of local content.</p>
Jacob Thornton's avatar
Jacob Thornton committed
124
125
126
127
        </div>
      </div> <!-- /row -->
      <div class="row">
        <div class="span3">
128
129
          <h3><a href="./javascript.html#tooltips">Tooltips</a></h3>
          <p>A new take on the jQuery Tipsy plugin, Tooltips don't rely on images&mdash;they use CSS3 for animations and data-attributes for local title storage.</p>
Jacob Thornton's avatar
Jacob Thornton committed
130
131
        </div>
        <div class="span3">
132
133
134
          <h3><a href="./javascript.html#popovers">Popovers</a> <small class="muted">*</small></h3>
          <p>Add small overlays of content, like those on the iPad, to any element for housing secondary information.</p>
          <p class="muted"><strong>*</strong> Requires <a href="#tooltips">Tooltips</a> to be included</p>
Jacob Thornton's avatar
Jacob Thornton committed
135
136
        </div>
        <div class="span3">
137
138
          <h3><a href="./javascript.html#alerts">Alert messages</a></h3>
          <p>The alert plugin is a tiny class for adding close functionality to alerts.</p>
Jacob Thornton's avatar
Jacob Thornton committed
139
140
        </div>
        <div class="span3">
141
142
          <h3><a href="./javascript.html#buttons">Buttons</a></h3>
          <p>Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p>
Jacob Thornton's avatar
Jacob Thornton committed
143
144
        </div>
      </div> <!-- /row -->
145
      <div class="row" style="margin-bottom: 9px;">
Jacob Thornton's avatar
Jacob Thornton committed
146
        <div class="span3">
147
148
          <h3><a href="./javascript.html#collapse">Collapse</a></h3>
          <p>Get base styles and flexible support for collapsible components like accordions and navigation.</p>
Jacob Thornton's avatar
Jacob Thornton committed
149
150
        </div>
        <div class="span3">
151
152
          <h3><a href="./javascript.html#carousel">Carousel</a></h3>
          <p>Create a merry-go-round of any content you wish to provide an interactive slideshow of content.</p>
Jacob Thornton's avatar
Jacob Thornton committed
153
154
        </div>
        <div class="span3">
155
156
          <h3><a href="./javascript.html#typeahead">Typeahead</a></h3>
          <p>A basic, easily extended plugin for quickly creating elegant typeaheads with any form text input.</p>
Jacob Thornton's avatar
Jacob Thornton committed
157
        </div>
Jacob Thornton's avatar
Jacob Thornton committed
158
        <div class="span3">
159
160
161
          <h3>Transitions <small class="muted">*</small></h3>
          <p>For simple transition effects, include bootstrap-transition.js once to slide in modals or fade out alerts.</p>
          <p class="muted"><strong>*</strong> Required for animation in plugins</p>
Jacob Thornton's avatar
Jacob Thornton committed
162
163
        </div>
      </div> <!-- /row -->
164
      <div class="alert alert-info"><strong>Heads up!</strong> All javascript plugins require the latest version of jQuery.</div>
Jacob Thornton's avatar
Jacob Thornton committed
165
166
167
168
169
170
171
172
173
174
175
176
177
178
    </section>



    <!-- Modal
    ================================================== -->
    <section id="modals">
      <div class="page-header">
        <h1>Modals <small>bootstrap-modal.js</small></h1>
      </div>
      <div class="row">
        <div class="span3 columns">
          <h3>About modals</h3>
          <p>A streamlined, but flexible, take on the traditional javascript modal plugin with only the minimum required functionality and smart defaults.</p>
Mark Otto's avatar
Mark Otto committed
179
          <a href="assets/js/bootstrap-modal.js" target="_blank" class="btn">Download file</a>
Jacob Thornton's avatar
Jacob Thornton committed
180
181
182
183
        </div>
        <div class="span9 columns">
          <h2>Static example</h2>
          <p>Below is a statically rendered modal.</p>
184
          <div class="well modal-example" style="background-color: #888; border: none;">
Mark Otto's avatar
Mark Otto committed
185
            <div class="modal" style="position: relative; top: auto; left: auto; margin: 0 auto; z-index: 1; max-width: 100%;">
Jacob Thornton's avatar
Jacob Thornton committed
186
              <div class="modal-header">
187
                <button type="button" class="close" data-dismiss="modal">&times;</button>
Jacob Thornton's avatar
Jacob Thornton committed
188
189
190
191
192
193
194
                <h3>Modal header</h3>
              </div>
              <div class="modal-body">
                <p>One fine body…</p>
              </div>
              <div class="modal-footer">
                <a href="#" class="btn">Close</a>
195
                <a href="#" class="btn btn-primary">Save changes</a>
Jacob Thornton's avatar
Jacob Thornton committed
196
197
198
199
200
201
              </div>
            </div>
          </div> <!-- /well -->

          <h2>Live demo</h2>
          <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>
202

Jacob Thornton's avatar
Jacob Thornton committed
203
          <!-- sample modal content -->
204
          <div id="myModal" class="modal hide fade" tabindex=0>
Jacob Thornton's avatar
Jacob Thornton committed
205
            <div class="modal-header">
206
              <button type="button" class="close" data-dismiss="modal">&times;</button>
Jacob Thornton's avatar
Jacob Thornton committed
207
208
209
210
211
              <h3>Modal Heading</h3>
            </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>
212

213
214
215
216
217
              <form class="well">
                <label>Label name</label>
                <input type="text" class="span3" placeholder="Type something…">
              </form>

Jacob Thornton's avatar
Jacob Thornton committed
218
              <h4>Popover in a modal</h4>
219
              <p>This <a href="#" 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 hover.</p>
Jacob Thornton's avatar
Jacob Thornton committed
220
221
222

              <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>
223
224
225
226
227
228
229
230
231
232
233

              <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>
Jacob Thornton's avatar
Jacob Thornton committed
234
235
236
            </div>
            <div class="modal-footer">
              <a href="#" class="btn" data-dismiss="modal" >Close</a>
237
              <a href="#" class="btn btn-primary">Save changes</a>
Jacob Thornton's avatar
Jacob Thornton committed
238
239
            </div>
          </div>
240
          <a data-toggle="modal" href="#myModal" class="btn btn-primary btn-large">Launch demo modal</a>
Jacob Thornton's avatar
Jacob Thornton committed
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261

          <hr>

          <h2>Using bootstrap-modal</h2>
          <p>Call the modal via javascript:</p>
          <pre class="prettyprint linenums">$('#myModal').modal(options)</pre>
          <h3>Options</h3>
          <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>
262
               <td>Includes a modal-backdrop element. Alternatively, specify <code>static</code> for a backdrop which doesn't close the modal on click.</td>
Jacob Thornton's avatar
Jacob Thornton committed
263
264
265
266
267
268
269
             </tr>
             <tr>
               <td>keyboard</td>
               <td>boolean</td>
               <td>true</td>
               <td>Closes the modal when escape key is pressed</td>
             </tr>
270
271
272
273
274
275
             <tr>
               <td>show</td>
               <td>boolean</td>
               <td>true</td>
               <td>Shows the modal when initialized.</td>
             </tr>
Jacob Thornton's avatar
Jacob Thornton committed
276
277
278
279
280
            </tbody>
          </table>
          <h3>Markup</h3>
          <p>You can activate modals on your page easily without having to write a single line of javascript. Just set <code>data-toggle="modal"</code> on a controller element with a <code>data-target="#foo"</code> or <code>href="#foo"</code> which corresponds to a modal element id, and when clicked, it will launch your modal.</p>
          <p>Also, to add options to your modal instance, just include them as additional data attributes on either the control element or the modal markup itself.</p>
281
<pre class="prettyprint linenums">
282
&lt;a class="btn" data-toggle="modal" href="#myModal" &gt;Launch Modal&lt;/a&gt;
283
284
285
</pre>

<pre class="prettyprint linenums">
286
&lt;div class="modal" id="myModal"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
287
  &lt;div class="modal-header"&gt;
288
    &lt;button type="button" class="close" data-dismiss="modal"&gt;&times;&lt;/button&gt;
Jacob Thornton's avatar
Jacob Thornton committed
289
290
291
292
293
294
295
    &lt;h3&gt;Modal header&lt;/h3&gt;
  &lt;/div&gt;
  &lt;div class="modal-body"&gt;
    &lt;p&gt;One fine body…&lt;/p&gt;
  &lt;/div&gt;
  &lt;div class="modal-footer"&gt;
    &lt;a href="#" class="btn"&gt;Close&lt;/a&gt;
296
    &lt;a href="#" class="btn btn-primary"&gt;Save changes&lt;/a&gt;
Jacob Thornton's avatar
Jacob Thornton committed
297
  &lt;/div&gt;
298
&lt;/div&gt;
299
</pre>
300
301
302
          <div class="alert alert-info">
            <strong>Heads up!</strong> If you want your modal to animate in and out, just add a <code>.fade</code> class to the <code>.modal</code> element (refer to the demo to see this in action) and include bootstrap-transition.js.
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
303
304
          <h3>Methods</h3>
          <h4>.modal(options)</h4>
305
          <p>Activates your content as a modal. Accepts an optional options <code>object</code>.</p>
Jacob Thornton's avatar
Jacob Thornton committed
306
<pre class="prettyprint linenums">
307
$('#myModal').modal({
Jacob Thornton's avatar
Jacob Thornton committed
308
  keyboard: false
309
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
310
311
312
313
314
315
316
317
318
319
          <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>
320
          <p>Bootstrap's modal class exposes a few events for hooking into modal functionality.</p>
Jacob Thornton's avatar
Jacob Thornton committed
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
          <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>
347

348
<pre class="prettyprint linenums">
349
$('#myModal').on('hidden', function () {
350
  // do something…
351
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
        </div>
      </div>
    </section>



    <!-- Dropdown
    ================================================== -->
    <section id="dropdowns">
      <div class="page-header">
        <h1>Dropdowns <small>bootstrap-dropdown.js</small></h1>
      </div>
      <div class="row">
        <div class="span3 columns">
          <h3>About dropdowns</h3>
          <p>Add dropdown menus to nearly anything in Bootstrap with this simple plugin. Bootstrap features full dropdown menu support on in the navbar, tabs, and pills.</p>
Mark Otto's avatar
Mark Otto committed
368
          <a href="assets/js/bootstrap-dropdown.js" target="_blank" class="btn">Download file</a>
Jacob Thornton's avatar
Jacob Thornton committed
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
395
396
397
        </div>
        <div class="span9 columns">
          <h2>Examples</h2>
          <p>Click on the dropdown nav links in the navbar and pills below to test dropdowns.</p>
          <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">
                  <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
                    <ul class="dropdown-menu">
                      <li><a href="#">Action</a></li>
                      <li><a href="#">Another action</a></li>
                      <li><a href="#">Something else here</a></li>
                      <li class="divider"></li>
                      <li><a href="#">Separated link</a></li>
                    </ul>
                  </li>
                  <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown 2 <b class="caret"></b></a>
                    <ul class="dropdown-menu">
                      <li><a href="#">Action</a></li>
                      <li><a href="#">Another action</a></li>
                      <li><a href="#">Something else here</a></li>
                      <li class="divider"></li>
                      <li><a href="#">Separated link</a></li>
                    </ul>
                  </li>
398
                </ul>
Jacob Thornton's avatar
Jacob Thornton committed
399
400
401
402
403
404
405
406
407
408
409
                <ul class="nav pull-right">
                  <li id="fat-menu" class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown 3 <b class="caret"></b></a>
                    <ul class="dropdown-menu">
                      <li><a href="#">Action</a></li>
                      <li><a href="#">Another action</a></li>
                      <li><a href="#">Something else here</a></li>
                      <li class="divider"></li>
                      <li><a href="#">Separated link</a></li>
                    </ul>
                  </li>
410
                </ul>
Jacob Thornton's avatar
Jacob Thornton committed
411
412
413
414
              </div>
            </div>
          </div> <!-- /navbar-example -->

415
          <ul class="nav nav-pills">
Jacob Thornton's avatar
Jacob Thornton committed
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
            <li class="active"><a href="#">Regular link</a></li>
            <li class="dropdown">
              <a class="dropdown-toggle" data-toggle="dropdown" href="#">Dropdown <b class="caret"></b></a>
              <ul id="menu1" class="dropdown-menu">
                <li><a href="#">Action</a></li>
                <li><a href="#">Another action</a></li>
                <li><a href="#">Something else here</a></li>
                <li class="divider"></li>
                <li><a href="#">Separated link</a></li>
              </ul>
            </li>
            <li class="dropdown">
              <a class="dropdown-toggle" data-toggle="dropdown" href="#">Dropdown 2 <b class="caret"></b></a>
              <ul id="menu2" class="dropdown-menu">
                <li><a href="#">Action</a></li>
                <li><a href="#">Another action</a></li>
                <li><a href="#">Something else here</a></li>
                <li class="divider"></li>
                <li><a href="#">Separated link</a></li>
              </ul>
            </li>
            <li class="dropdown">
              <a class="dropdown-toggle" data-toggle="dropdown" href="#">Dropdown 3 <b class="caret"></b></a>
              <ul id="menu3" class="dropdown-menu">
                <li><a href="#">Action</a></li>
                <li><a href="#">Another action</a></li>
                <li><a href="#">Something else here</a></li>
                <li class="divider"></li>
                <li><a href="#">Separated link</a></li>
              </ul>
            </li>
          </ul> <!-- /tabs -->
448

Jacob Thornton's avatar
Jacob Thornton committed
449
          <hr>
450

Jacob Thornton's avatar
Jacob Thornton committed
451
452
453
454
455
          <h2>Using bootstrap-dropdown.js</h2>
          <p>Call the dropdowns via javascript:</p>
          <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre>
          <h3>Markup</h3>
          <p>To quickly add dropdown functionality to any element just add <code>data-toggle="dropdown"</code> and any valid bootstrap dropdown will automatically be activated.</p>
456
457
458
          <div class="alert alert-info">
            <strong>Heads up!</strong> You may optionally target a specific dropdown by using <code>data-target="#fat"</code> or <code>href="#fat"</code>.
          </div>
459
460

<pre class="prettyprint linenums">
461
&lt;ul class="nav nav-pills"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
  &lt;li class="active"&gt;&lt;a href="#"&gt;Regular link&lt;/a&gt;&lt;/li&gt;
  &lt;li class="dropdown" id="menu1"&gt;
    &lt;a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"&gt;
      Dropdown
      &lt;b class="caret"&gt;&lt;/b&gt;
    &lt;/a&gt;
    &lt;ul class="dropdown-menu"&gt;
      &lt;li&gt;&lt;a href="#"&gt;Action&lt;/a&gt;&lt;/li&gt;
      &lt;li&gt;&lt;a href="#"&gt;Another action&lt;/a&gt;&lt;/li&gt;
      &lt;li&gt;&lt;a href="#"&gt;Something else here&lt;/a&gt;&lt;/li&gt;
      &lt;li class="divider"&gt;&lt;/li&gt;
      &lt;li&gt;&lt;a href="#"&gt;Separated link&lt;/a&gt;&lt;/li&gt;
    &lt;/ul&gt;
  &lt;/li&gt;
  ...
477
&lt;/ul&gt;</pre>
478
479
480
481
482
483
484
485
486
487
488
489
490
491
          <p>To keep URLs intact, use the <code>data-target</code> attribute instead of <code>href="#"</code>.</p>
<pre class="prettyprint linenums">
&lt;ul class="nav nav-pills"&gt;
  &lt;li class="dropdown"&gt;
    &lt;a class="dropdown-toggle" data-toggle="dropdown" data-target="#" href="path/to/page.html"&gt;
      Dropdown
      &lt;b class="caret"&gt;&lt;/b&gt;
    &lt;/a&gt;
    &lt;ul class="dropdown-menu"&gt;
      ...
    &lt;/ul&gt;
  &lt;/li&gt;
&lt;/ul&gt;
</pre>
Jacob Thornton's avatar
Jacob Thornton committed
492
493
          <h3>Methods</h3>
          <h4>$().dropdown()</h4>
494
          <p>A programatic api for activating menus for a given navbar or tabbed navigation.</p>
Jacob Thornton's avatar
Jacob Thornton committed
495
496
497
        </div>
      </div>
    </section>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
498

499
500


Jacob Thornton's avatar
Jacob Thornton committed
501
502
503
504
505
506
507
508
509
   <!-- ScrollSpy
    ================================================== -->
    <section id="scrollspy">
      <div class="page-header">
        <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
      </div>
      <div class="row">
        <div class="span3 columns">
          <p>The ScrollSpy plugin is for automatically updating nav targets based on scroll position.</p>
Mark Otto's avatar
Mark Otto committed
510
          <a href="assets/js/bootstrap-scrollspy.js" target="_blank" class="btn">Download file</a>
Jacob Thornton's avatar
Jacob Thornton committed
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
        </div>
        <div class="span9 columns">
          <h2>Example navbar with scrollspy</h2>
          <p>Scroll the area below and watch the navigation update. The dropdown sub items will be highlighted as well. Try it!</p>
          <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>
531
                </ul>
Jacob Thornton's avatar
Jacob Thornton committed
532
533
              </div>
            </div>
534
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
          <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>
          <hr>
          <h2>Using bootstrap-scrollspy.js</h2>
          <p>Call the scrollspy via javascript:</p>
          <pre class="prettyprint linenums">$('#navbar').scrollspy()</pre>
          <h3>Markup</h3>
564
          <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).</p>
Jacob Thornton's avatar
Jacob Thornton committed
565
          <pre class="prettyprint linenums">&lt;body data-spy="scroll" &gt;...&lt;/body&gt;</pre>
566
567
568
569
          <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>
570
571
572
573
574
575
576
577
          <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>
<pre class="prettyprint linenums">
$('[data-spy="scroll"]').each(function () {
  var $spy = $(this).scrollspy('refresh')
});
</pre>
Jacob Thornton's avatar
Jacob Thornton committed
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
          <h3>Options</h3>
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>offset</td>
               <td>number</td>
               <td>10</td>
               <td>Pixels to offset from top when calculating position of scroll.</td>
             </tr>
            </tbody>
          </table>
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
           <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>
Jacob Thornton's avatar
Jacob Thornton committed
612
613
        </div>
      </div>
Jacob Thornton's avatar
Jacob Thornton committed
614
    </section>
Jacob Thornton's avatar
Jacob Thornton committed
615

616
617


Jacob Thornton's avatar
Jacob Thornton committed
618
619
620
621
622
    <!-- Tabs
    ================================================== -->
    <section id="tabs">
      <div class="page-header">
        <h1>Togglable tabs <small>bootstrap-tab.js</small></h1>
623
      </div>
Jacob Thornton's avatar
Jacob Thornton committed
624
625
626
      <div class="row">
        <div class="span3 columns">
          <p>This plugin adds quick, dynamic tab and pill functionality for transitioning through local content.</p>
Mark Otto's avatar
Mark Otto committed
627
          <a href="assets/js/bootstrap-tab.js" target="_blank" class="btn">Download file</a>
Jacob Thornton's avatar
Jacob Thornton committed
628
629
630
631
        </div>
        <div class="span9 columns">
          <h2>Example tabs</h2>
          <p>Click the tabs below to toggle between hidden panes, even via dropdown menus.</p>
632
          <ul id="myTab" class="nav nav-tabs">
Jacob Thornton's avatar
Jacob Thornton committed
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
            <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>
            </div>
          </div>
          <hr>
          <h2>Using bootstrap-tab.js</h2>
659
660
661
662
663
664
665
          <p>Enable tabbable tabs via javascript (each tab needs to be activated individually):</p>
          <pre class="prettyprint linenums">
$('#myTab a').click(function (e) {
  e.preventDefault();
  $(this).tab('show');
})</pre>
          <p>You can activate individual tabs in several ways:</p>
666
<pre class="prettyprint linenums">
667
668
669
670
$('#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)
671
</pre>
Jacob Thornton's avatar
Jacob Thornton committed
672
          <h3>Markup</h3>
Marcus Bointon's avatar
Marcus Bointon committed
673
          <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>
674
<pre class="prettyprint linenums">
675
&lt;ul class="nav nav-tabs"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
676
677
678
  &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
679
  &lt;li&gt;&lt;a href="#settings" data-toggle="tab"&gt;Settings&lt;/a&gt;&lt;/li&gt;
680
&lt;/ul&gt;</pre>
Jacob Thornton's avatar
Jacob Thornton committed
681
682
683
          <h3>Methods</h3>
          <h4>$().tab</h4>
          <p>
684
            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.
Jacob Thornton's avatar
Jacob Thornton committed
685
          </p>
686
<pre class="prettyprint linenums">
687
&lt;ul class="nav nav-tabs" id="myTab"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
688
689
690
691
  &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;
692
693
&lt;/ul&gt;

694
&lt;div class="tab-content"&gt;
Mark Otto's avatar
Mark Otto committed
695
696
697
698
  &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;
699
&lt;/div&gt;
700
701

&lt;script&gt;
Jacob Thornton's avatar
Jacob Thornton committed
702
  $(function () {
703
    $('#myTab a:last').tab('show');
Jacob Thornton's avatar
Jacob Thornton committed
704
  })
705
&lt;/script&gt;</pre>
Jacob Thornton's avatar
Jacob Thornton committed
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
          <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>

          <pre class="prettyprint linenums">
727
$('a[data-toggle="tab"]').on('shown', function (e) {
Jacob Thornton's avatar
Jacob Thornton committed
728
729
  e.target // activated tab
  e.relatedTarget // previous tab
730
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
731
       </div>
732
      </div>
Jacob Thornton's avatar
Jacob Thornton committed
733
734
735
736
737
738
739
740
    </section>


    <!-- Tooltips
    ================================================== -->
    <section id="tooltips">
      <div class="page-header">
        <h1>Tooltips <small>bootstrap-tooltip.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
741
      </div>
Jacob Thornton's avatar
Jacob Thornton committed
742
743
744
      <div class="row">
        <div class="span3 columns">
          <h3>About Tooltips</h3>
745
          <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>
Mark Otto's avatar
Mark Otto committed
746
          <a href="assets/js/bootstrap-tooltip.js" target="_blank" class="btn">Download file</a>
Jacob Thornton's avatar
Jacob Thornton committed
747
748
749
750
751
        </div>
        <div class="span9 columns">
          <h2>Example use of Tooltips</h2>
          <p>Hover over the links below to see tooltips:</p>
          <div class="tooltip-demo well">
Mark Otto's avatar
Mark Otto committed
752
            <p class="muted" style="margin-bottom: 0;">Tight pants next level keffiyeh <a href="#" rel="tooltip" title="first 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.
Jacob Thornton's avatar
Jacob Thornton committed
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
            </p>
          </div>
          <hr>
          <h2>Using bootstrap-tooltip.js</h2>
          <p>Trigger the tooltip via javascript:</p>
          <pre class="prettyprint linenums">$('#example').tooltip(options)</pre>
          <h3>Options</h3>
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>animation</td>
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
               <td>placement</td>
778
               <td>string|function</td>
Jacob Thornton's avatar
Jacob Thornton committed
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
               <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>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
             <tr>
               <td>delay</td>
               <td>number | object</td>
               <td>0</td>
               <td>
805
                <p>delay showing and hiding the tooltip (ms) - does not apply to manual trigger type</p>
Jacob Thornton's avatar
Jacob Thornton committed
806
807
808
809
810
811
                <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>
            </tbody>
          </table>
812
813
814
815
          <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
816
817
          <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>
818
819
820
<pre class="prettyprint linenums">
&lt;a href="#" rel="tooltip" title="first tooltip"&gt;hover over me&lt;/a&gt;
</pre>
Jacob Thornton's avatar
Jacob Thornton committed
821
822
823
824
          <h3>Methods</h3>
          <h4>$().tooltip(options)</h4>
          <p>Attaches a tooltip handler to an element collection.</p>
          <h4>.tooltip('show')</h4>
Mark Otto's avatar
Mark Otto committed
825
          <p>Reveals an element's tooltip.</p>
Jacob Thornton's avatar
Jacob Thornton committed
826
827
          <pre class="prettyprint linenums">$('#element').tooltip('show')</pre>
          <h4>.tooltip('hide')</h4>
Mark Otto's avatar
Mark Otto committed
828
          <p>Hides an element's tooltip.</p>
Jacob Thornton's avatar
Jacob Thornton committed
829
          <pre class="prettyprint linenums">$('#element').tooltip('hide')</pre>
830
          <h4>.tooltip('toggle')</h4>
Mark Otto's avatar
Mark Otto committed
831
          <p>Toggles an element's tooltip.</p>
832
          <pre class="prettyprint linenums">$('#element').tooltip('toggle')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
833
        </div>
Jacob Thornton's avatar
Jacob Thornton committed
834
      </div>
Jacob Thornton's avatar
Jacob Thornton committed
835
836
837
838
839
840
841
842
843
    </section>



    <!-- Popovers
    ================================================== -->
    <section id="popovers">
      <div class="page-header">
        <h1>Popovers <small>bootstrap-popover.js</small></h1>
844
      </div>
Jacob Thornton's avatar
Jacob Thornton committed
845
846
847
848
      <div class="row">
        <div class="span3 columns">
          <h3>About popovers</h3>
          <p>Add small overlays of content, like those on the iPad, to any element for housing secondary information.</p>
849
          <p class="muted"><strong>*</strong> Requires <a href="#tooltips">Tooltip</a> to be included</p>
Mark Otto's avatar
Mark Otto committed
850
          <a href="assets/js/bootstrap-popover.js" target="_blank" class="btn">Download file</a>
Jacob Thornton's avatar
Jacob Thornton committed
851
852
853
854
855
        </div>
        <div class="span9 columns">
          <h2>Example hover popover</h2>
          <p>Hover over the button to trigger the popover.</p>
          <div class="well">
856
            <a href="#" class="btn btn-danger" rel="popover" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">hover for popover</a>
Jacob Thornton's avatar
Jacob Thornton committed
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
          </div>
          <hr>
          <h2>Using bootstrap-popover.js</h2>
          <p>Enable popovers via javascript:</p>
          <pre class="prettyprint linenums">$('#example').popover(options)</pre>
          <h3>Options</h3>
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>animation</td>
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
               <td>placement</td>
881
               <td>string|function</td>
Jacob Thornton's avatar
Jacob Thornton committed
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
               <td>'right'</td>
               <td>how to position the popover - 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>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
             <tr>
               <td>title</td>
               <td>string | function</td>
               <td>''</td>
               <td>default title value if `title` attribute isn't present</td>
             </tr>
             <tr>
               <td>content</td>
               <td>string | function</td>
               <td>''</td>
               <td>default content value if `data-content` attribute isn't present</td>
             </tr>
             <tr>
               <td>delay</td>
               <td>number | object</td>
               <td>0</td>
               <td>
914
                <p>delay showing and hiding the popover (ms) - does not apply to manual trigger type</p>
Jacob Thornton's avatar
Jacob Thornton committed
915
916
917
918
919
920
                <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>
            </tbody>
          </table>
921
922
923
924
          <div class="alert alert-info">
            <strong>Heads up!</strong>
            Options for individual popovers can alternatively be specified through the use of data attributes.
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
925
926
          <h3>Markup</h3>
          <p>
Marcus Bointon's avatar
Marcus Bointon committed
927
          For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a selector option.
Jacob Thornton's avatar
Jacob Thornton committed
928
929
930
931
932
933
934
935
936
937
          </p>
          <h3>Methods</h3>
          <h4>$().popover(options)</h4>
          <p>Initializes popovers for an element collection.</p>
          <h4>.popover('show')</h4>
          <p>Reveals an elements popover.</p>
          <pre class="prettyprint linenums">$('#element').popover('show')</pre>
          <h4>.popover('hide')</h4>
          <p>Hides an elements popover.</p>
          <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
938
939
940
          <h4>.popover('toggle')</h4>
          <p>Toggles an elements popover.</p>
          <pre class="prettyprint linenums">$('#element').popover('toggle')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
        </div>
      </div>
    </section>



    <!-- Alert
    ================================================== -->
    <section id="alerts">
      <div class="page-header">
        <h1>Alert messages <small>bootstrap-alert.js</small></h1>
      </div>
      <div class="row">
        <div class="span3 columns">
          <h3>About alerts</h3>
          <p>The alert plugin is a tiny class for adding close functionality to alerts.</p>
Mark Otto's avatar
Mark Otto committed
957
          <a href="assets/js/bootstrap-alert.js" target="_blank" class="btn">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
958
959
960
961
962
        </div>
        <div class="span9 columns">
          <h2>Example alerts</h2>
          <p>The alerts plugin works on regular alert messages, and block messages.</p>
          <div class="alert fade in">
963
            <button type="button" class="close" data-dismiss="alert">&times;</button>
Mark Otto's avatar
Mark Otto committed
964
            <strong>Holy guacamole!</strong> Best check yo self, you're not looking too good.
Jacob Thornton's avatar
Jacob Thornton committed
965
966
          </div>
          <div class="alert alert-block alert-error fade in">
967
            <button type="button" class="close" data-dismiss="alert">&times;</button>
Jacob Thornton's avatar
Jacob Thornton committed
968
969
970
            <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>
            <p>
Jacob Thornton's avatar
Jacob Thornton committed
971
              <a class="btn btn-danger" href="#">Take this action</a> <a class="btn" href="#">Or do this</a>
Jacob Thornton's avatar
Jacob Thornton committed
972
973
974
            </p>
          </div>
          <hr>
975
          <h2>Using bootstrap-alert.js</h2>
Jacob Thornton's avatar
Jacob Thornton committed
976
          <p>Enable dismissal of an alert via javascript:</p>
977
          <pre class="prettyprint linenums">$(".alert").alert()</pre>
Jacob Thornton's avatar
Jacob Thornton committed
978
979
980
981
982
983
984
985
          <h3>Markup</h3>
          <p>Just add <code>data-dismiss="alert"</code> to your close button to automatically give an alert close functionality.</p>
          <pre class="prettyprint linenums">&lt;a class="close" data-dismiss="alert" href="#"&gt;&amp;times;&lt;/a&gt;</pre>
          <h3>Methods</h3>
          <h4>$().alert()</h4>
          <p>Wraps all alerts with close functionality. To have your alerts animate out when closed, make sure they have the <code>.fade</code> and <code>.in</code> class already applied to them.</p>
          <h4>.alert('close')</h4>
          <p>Closes an alert.</p>
986
          <pre class="prettyprint linenums">$(".alert").alert('close')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
987
          <h3>Events</h3>
988
          <p>Bootstrap's alert class exposes a few events for hooking into alert functionality.</p>
Jacob Thornton's avatar
Jacob Thornton committed
989
990
991
992
993
994
995
996
997
998
999
1000
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 150px;">Event</th>
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>close</td>
               <td>This event fires immediately when the <code>close</code> instance method is called.</td>
             </tr>
For faster browsing, not all history is shown. View entire blame