javascript.html 69.7 KB
Newer Older
Jacob Thornton's avatar
Jacob Thornton committed
1
2
3
4
5
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Bootstrap, from Twitter</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
11
12
13
14
15
    <meta name="description" content="">
    <meta name="author" content="">

    <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
    <!--[if lt IE 9]>
      <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->

    <!-- Le styles -->
16
    <link href="../bootstrap.css" rel="stylesheet">
17
    <link href="assets/css/docs.css" rel="stylesheet">
Jacob Thornton's avatar
Jacob Thornton committed
18
    <link href="assets/js/google-code-prettify/prettify.css" rel="stylesheet">
Jacob Thornton's avatar
Jacob Thornton committed
19
20
21
22
23
24

    <!-- Le fav and touch icons -->
    <link rel="shortcut icon" href="images/favicon.ico">
    <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
    <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
25

Jacob Thornton's avatar
Jacob Thornton committed
26
27
  </head>

28
  <body id="bootstrap-js">
Jacob Thornton's avatar
Jacob Thornton committed
29

30
    <!-- Navbar
Jacob Thornton's avatar
Jacob Thornton committed
31
    ================================================== -->
32
33
34
35
36
37
    <div class="navbar navbar-fixed">
      <div class="navbar-inner">
        <div class="container">
          <a class="brand" href="./index.html">Bootstrap</a>
          <ul class="nav">
            <li><a href="./index.html">Overview</a></li>
38
39
40
41
42
43
            <li class="dropdown">
              <a href="./scaffolding.html" class="dropdown-toggle" data-toggle="dropdown">
                Scaffolding
                <b class="caret"></b>
              </a>
              <ul class="dropdown-menu">
44
                <li><a href="./scaffolding.html#grid-system">Grid system</a></li>
45
46
47
48
49
50
51
52
53
54
                <li><a href="./scaffolding.html#layouts">Layouts</a></li>
                <li><a href="./scaffolding.html#responsive">Responsive design</a></li>
              </ul>
            </li>
            <li class="dropdown">
              <a href="./base-css.html" class="dropdown-toggle" data-toggle="dropdown">
                Base CSS
                <b class="caret"></b>
              </a>
              <ul class="dropdown-menu">
55
                <li><a href="./base-css.html#typography">Typography</a></li>
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
                <li><a href="./base-css.html#tables">Tables</a></li>
                <li><a href="./base-css.html#forms">Forms</a></li>
                <li><a href="./base-css.html#buttons">Buttons</a></li>
                <li><a href="./base-css.html#icons">Icons by Glyphicons</a></li>
              </ul>
            </li>
            <li class="dropdown">
              <a href="./components.html" class="dropdown-toggle" data-toggle="dropdown">
                Components
                <b class="caret"></b>
              </a>
              <ul class="dropdown-menu">
                <li><a href="./components.html#buttonGroups">Button groups</a></li>
                <li><a href="./components.html#buttonDropdowns">Split button dropdowns</a></li>
                <li><a href="./components.html#navs">Nav, tabs, pills</a></li>
                <li><a href="./components.html#navbar">Navbar</a></li>
                <li><a href="./components.html#breadcrumbs">Breadcrumbs</a></li>
                <li><a href="./components.html#pagination">Pagination</a></li>
                <li><a href="./components.html#thumbnails">Thumbnails</a></li>
                <li><a href="./components.html#alerts">Alert messages</a></li>
76
                <li><a href="./components.html#progress">Progress bars</a></li>
77
78
79
80
81
82
83
84
              </ul>
            </li>
            <li class="dropdown active">
              <a href="./javascript.html" class="dropdown-toggle" data-toggle="dropdown">
                Javascript plugins
                <b class="caret"></b>
              </a>
              <ul class="dropdown-menu">
Purwandi's avatar
Purwandi committed
85
86
87
                <li><a href="./javascript.html#transitions">Transition</a></li>
                <li><a href="./javascript.html#modals">Modal</a></li>
                <li><a href="./javascript.html#dropdowns">Dropdown</a></li>
88
                <li><a href="./javascript.html#scrollspy">Scrollspy</a></li>
Purwandi's avatar
Purwandi committed
89
90
91
                <li><a href="./javascript.html#tabs">Tab</a></li>
                <li><a href="./javascript.html#tooltips">Tooltip</a></li>
                <li><a href="./javascript.html#popovers">Popover</a></li>
92
93
94
95
96
97
98
99
100
101
102
103
                <li><a href="./javascript.html#alerts">Alert</a></li>
                <li><a href="./javascript.html#buttons">Button</a></li>
                <li><a href="./javascript.html#collapse">Collapse</a></li>
                <li><a href="./javascript.html#carousel">Carousel</a></li>
                <li><a href="./javascript.html#typeahead">Typeahead</a></li>
              </ul>
            </li>
            <li>
              <a href="./less.html">
                Using LESS
              </a>
            </li>
104
105
106
107
108
109
110
111
112
113
          </ul>
        </div>
      </div>
    </div>

    <div class="container">
      <!-- Masthead
      ================================================== -->
      <header class="jumbotron subhead" id="overview">
        <h1>Javascript for Bootstrap</h1>
114
        <p class="lead">Bring Bootstrap's components to life&mdash;now with 12 custom <a href="http://jquery.com/" target="_blank">jQuery</a> plugins.
115
116
117
      </header>


118
119
120
121
122
123
124
125
      <!-- 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>
        </div>
      <div class="row">
        <div class="span3">
126
127
128
129
          <label>
            <h3><a href="./javascript.html#modals">Modals</a><input checked="true" value="bootstrap-modal.js" type="checkbox"></h3>
            <p>A streamlined, but flexible, take on the traditional javascript modal plugin with only the minimum required functionality and smart defaults.</p>
          </label>
130
131
        </div>
        <div class="span3">
132
133
134
135
          <label>
            <h3><a href="./javascript.html#dropdowns">Dropdowns</a><input checked="true" value="bootstrap-dropdown.js" type="checkbox"></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>
          </label>
136
137
        </div>
        <div class="span3">
138
139
140
141
          <label>
            <h3><a href="./javascript.html#scrollspy">Scrollspy</a><input checked="true" value="bootstrap-scrollspy.js" type="checkbox"></h3>
            <p>Use scrollspy to automatically update the links in your navbar to show the current active link based on scroll position.</p>
          </label>
142
143
        </div>
        <div class="span3">
144
145
146
147
          <label>
            <h3><a href="./javascript.html#tabs">Togglable tabs</a><input checked="true" value="bootstrap-tab.js" type="checkbox"></h3>
            <p>Use this plugin to make tabs and pills more useful by allowing them to toggle through tabbable panes of local content.</p>
          </label>
148
        </div>
149
150
      </div> <!-- /row -->
      <div class="row">
151
        <div class="span3">
152
153
154
155
          <label>
            <h3><a href="./javascript.html#tooltips">Tooltips</a><input checked="true" value="bootstrap-tooltip.js" type="checkbox"></h3>
            <p>A new take on the jQuery Tipsy plugin, Tooltips are an updated version, which don't rely on images, uss css3 for animations, and data-attributes for local title storage.</p>
          </label>
156
157
        </div>
        <div class="span3">
158
159
160
161
162
          <label>
            <h3><a href="./javascript.html#popovers">Popovers</a> <small class="muted">*</small><input checked="true" value="bootstrap-popover.js" type="checkbox"></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>
          </label>
163
164
        </div>
        <div class="span3">
165
166
167
168
          <label>
            <h3><a href="./javascript.html#alerts">Alert messages</a><input checked="true" value="bootstrap-alert.js" type="checkbox"></h3>
            <p>The alert plugin is a tiny class for adding close functionality to alerts.</p>
          </label>
169
170
        </div>
        <div class="span3">
171
172
173
174
          <label>
            <h3><a href="./javascript.html#buttons">Buttons</a><input checked="true" value="bootstrap-button.js" type="checkbox"></h3>
            <p>Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p>
          </label>
175
        </div>
176
177
      </div> <!-- /row -->
      <div class="row">
178
        <div class="span3">
179
180
181
182
          <label>
            <h3><a href="./javascript.html#collapse">Collapse</a><input checked="true" value="bootstrap-collapse.js" type="checkbox"></h3>
            <p>Get base styles and flexible support for collapsible components like accordions and navigation.</p>
          </label>
183
184
        </div>
        <div class="span3">
185
186
187
188
          <label>
            <h3><a href="./javascript.html#carousel">Carousel</a><input checked="true" value="bootstrap-carousel.js" type="checkbox"></h3>
            <p>Create a merry-go-round of any content you wish to provide an interactive slideshow of content.</p>
          </label>
189
190
        </div>
        <div class="span3">
191
192
193
194
          <label>
            <h3><a href="./javascript.html#typeahead">Typeahead</a><input checked="true" value="bootstrap-typeahead.js" type="checkbox"></h3>
            <p>A basic, easily extended plugin for quickly creating elegant typeaheads with any form text input.</p>
          </label>
195
        </div>
196
        <div class="span3">
197
198
199
200
201
          <label>
            <h3><a href="./javascript.html#transitions">Transitions</a> <small class="muted">*</small><input value="bootstrap-transition.js" checked="true" type="checkbox"></h3>
            <p>For simple transition effects, include bootstrap-transition.js once to slide in modals or fade out alert messages.</p>
            <p class="muted"><strong>*</strong> Required for animation in plugins</p>
          </label>
202
        </div>
203
      </div> <!-- /row -->
204
205
206
207
208
209
210
211
212
213
214
215
216
217
      <div class="row">
        <div class="span5">
          <div class="btn-group" id="javascriptBuilder">
            <a id="javascriptBuild" class="btn primary large" href="#">Download Source</a>
            <a class="btn primary large dropdown-toggle" data-toggle="dropdown" href="#">
              <span class="caret"></span>
            </a>
            <ul class="dropdown-menu large">
              <li class="active"><a href="#">Compressed</a></li>
              <li><a href="#">Uncompressed</a></li>
            </ul>
          </div>
        </div>
      </div>
218
      <hr>
219
      <a id="selectAll" href="#" style="float:right">Select/Unselect All Plugins</a>
220
221
      <p class="muted"><span class="label warning">Note:</span> All plugins require the latest version of <a href="http://jquery.com/" target="_blank">jQuery</a> to be included.</p>
    </section>
222

Jacob Thornton's avatar
Jacob Thornton committed
223

224

Jacob Thornton's avatar
Jacob Thornton committed
225
226
    <!-- Modal
    ================================================== -->
227
    <section id="modals">
Jacob Thornton's avatar
Jacob Thornton committed
228
      <div class="page-header">
229
        <h1>Modals <small>bootstrap-modal.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
230
231
      </div>
      <div class="row">
232
        <div class="span3 columns">
233
234
235
          <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>
          <a href="../js/bootstrap-modal.js" target="_blank" class="btn">Download file</a>
Jacob Thornton's avatar
Jacob Thornton committed
236
        </div>
237
        <div class="span9 columns">
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
          <h2>Static example</h2>
          <p>Below is a statically rendered modal.</p>
          <div class="well" style="background-color: #888; border: none;">
            <div class="modal" style="position: relative; top: auto; left: auto; margin: 0 auto; z-index: 1">
              <div class="modal-header">
                <a href="#" class="close js-dismiss">&times;</a>
                <h3>Modal header</h3>
              </div>
              <div class="modal-body">
                <p>One fine body…</p>
              </div>
              <div class="modal-footer">
                <a href="#" class="btn primary">Save changes</a>
                <a href="#" class="btn">Close</a>
              </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>
          <!-- sample modal content -->
          <div id="myModal" class="modal hide fade">
            <div class="modal-header">
              <a href="#" class="close" data-dismiss="modal" >&times;</a>
              <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>

              <h4>Popover in a modal</h4>
              <p>This <a href="#" class="btn" rel="popover" 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>

271
272
              <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>
273
274
275
276
277
278
279
280
281
282
283
284
            </div>
            <div class="modal-footer">
              <a href="#" class="btn primary">Save changes</a>
              <a href="#" class="btn" data-dismiss="modal" >Close</a>
            </div>
          </div>
          <a data-toggle="modal" href="#myModal" class="btn primary large">Launch demo modal</a>

          <hr>

          <h2>Using bootstrap-modal</h2>
          <p>Call the modal via javascript:</p>
285
          <pre class="prettyprint linenums">$('#myModal').modal(options)</pre>
Jacob Thornton's avatar
Jacob Thornton committed
286
          <h3>Options</h3>
287
          <table class="table-bordered table-striped">
288
289
290
291
292
293
294
295
296
297
298
299
            <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>
300
               <td>true</td>
301
302
303
304
305
               <td>Includes a modal-backdrop element</td>
             </tr>
             <tr>
               <td>keyboard</td>
               <td>boolean</td>
306
               <td>true</td>
307
308
309
310
311
               <td>Closes the modal when escape key is pressed</td>
             </tr>
            </tbody>
          </table>
          <h3>Markup</h3>
312
313
          <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>
314
<pre class="prettyprint linenums">
315
&lt;a class="btn" data-toggle="modal" href="#myModal" &gt;Launch Modal&lt;/a&gt;
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
</pre>

<pre class="prettyprint linenums">
&lt;div class="modal"&gt;
  &lt;div class="modal-header"&gt;
    &lt;a href="#" class="close js-dismiss"&gt;&times;&lt;/a&gt;
    &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 primary"&gt;Save changes&lt;/a&gt;
    &lt;a href="#" class="btn"&gt;Close&lt;/a&gt;
  &lt;/div&gt;
&lt;/div&gt;
332
</pre>
333
          <p><span class="label notice">Notice</span> 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).</p>
Jacob Thornton's avatar
Jacob Thornton committed
334
          <h3>Methods</h3>
335
336
          <h4>.modal(options)</h4>
          <p>Activates your content as a modal. Accepts an optional options <code>object</code>.
Jacob Thornton's avatar
Jacob Thornton committed
337
<pre class="prettyprint linenums">
338
$('#myModal').modal({
339
  keyboard: false
340
})</pre>
341
342
          <h4>.modal('toggle')</h4>
          <p>Manually toggles a modal.</p>
343
          <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre>
344
345
          <h4>.modal('show')</h4>
          <p>Manually opens a modal.</p>
346
          <pre class="prettyprint linenums">$('#myModal').modal('show')</pre>
347
348
          <h4>.modal('hide')</h4>
          <p>Manually hides a modal.</p>
349
          <pre class="prettyprint linenums">$('#myModal').modal('hide')</pre>
350
          <h3>Events</h3>
351
          <p>Bootstrap's modal class exposes a few events for hooking into modal functionality. </p>
352
          <table class="table-bordered table-striped">
353
354
            <thead>
             <tr>
355
               <th style="width: 150px;">Event</th>
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
               <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>

379
<pre class="prettyprint linenums">
380
$('#myModal').on('hidden', function () {
381
382
  // do something ...
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
383
384
385
        </div>
      </div>
    </section>
386
387


388

Jacob Thornton's avatar
Jacob Thornton committed
389
390
    <!-- Dropdown
    ================================================== -->
391
    <section id="dropdowns">
Jacob Thornton's avatar
Jacob Thornton committed
392
      <div class="page-header">
393
        <h1>Dropdowns <small>bootstrap-dropdown.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
394
395
      </div>
      <div class="row">
396
        <div class="span3 columns">
397
398
399
          <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>
          <a href="../js/bootstrap-dropdown.js" target="_blank" class="btn">Download file</a>
Jacob Thornton's avatar
Jacob Thornton committed
400
        </div>
401
        <div class="span9 columns">
402
403
          <h2>Examples</h2>
          <p>Click on the dropdown nav links in the navbar and pills below to test dropdowns.</p>
404
          <div id="navbar-example" class="navbar navbar-static">
405
406
407
408
            <div class="navbar-inner">
              <div class="container" style="width: auto;">
                <a class="brand" href="#">Project Name</a>
                <ul class="nav">
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
                  <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>
429
                </ul>
430
                <ul class="nav pull-right">
431
                  <li id="fat-menu" class="dropdown">
432
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown 3 <b class="caret"></b></a>
433
                    <ul class="dropdown-menu">
434
435
                      <li><a href="#">Action</a></li>
                      <li><a href="#">Another action</a></li>
436
437
                      <li><a href="#">Something else here</a></li>
                      <li class="divider"></li>
438
                      <li><a href="#">Separated link</a></li>
439
440
441
                    </ul>
                  </li>
                </ul>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
442
443
              </div>
            </div>
444
445
446
447
448
          </div> <!-- /navbar-example -->

          <ul class="nav pills">
            <li class="active"><a href="#">Regular link</a></li>
            <li class="dropdown">
449
              <a class="dropdown-toggle" data-toggle="dropdown" href="#">Dropdown <b class="caret"></b></a>
450
451
452
453
454
455
456
457
458
              <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">
459
              <a class="dropdown-toggle" data-toggle="dropdown" href="#">Dropdown 2 <b class="caret"></b></a>
460
461
462
463
464
465
466
467
468
              <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">
469
              <a class="dropdown-toggle" data-toggle="dropdown" href="#">Dropdown 3 <b class="caret"></b></a>
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
              <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 -->

          <hr>

          <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>
          <p><span class="label notice">Notice</span> For added control and flexibility, optionally specify a <code>data-target="#fat"</code> or <code>href="#fat"</code> - this allows you to target specific dropdowns.</p>

<pre class="prettyprint linenums">
&lt;ul class="nav pills"&gt;
  &lt;li class="active"&gt;&lt;a href="#"&gt;Regular link&lt;/a&gt;&lt;/li&gt;
  &lt;li class="dropdown"&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 id="menu1" 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;
  ...
&lt;/ul&gt;</pre>
          <h3>Methods</h3>
          <h4>$().dropdown()</h4>
          <p>
          A programatic api for activating menus for a given navbar or tabbed navigation.
          </p>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
512
513
514
515
        </div>
      </div>
    </section>

516
517


Jacob Thornton's avatar
Jacob Thornton committed
518
519
520
521
522
523
524
   <!-- ScrollSpy
    ================================================== -->
    <section id="scrollspy">
      <div class="page-header">
        <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
      </div>
      <div class="row">
525
        <div class="span3 columns">
526
          <p>The ScrollSpy plugin is for automatically updating nav targets based on scroll position.</p>
527
          <a href="../js/bootstrap-scrollspy.js" target="_blank" class="btn">Download file</a>
Jacob Thornton's avatar
Jacob Thornton committed
528
        </div>
529
        <div class="span9 columns">
530
531
          <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>
532
          <div id="navbarExample" class="navbar navbar-static">
533
534
535
536
537
538
539
            <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">
540
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
541
542
543
544
545
546
547
548
549
550
551
                    <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>
              </div>
            </div>
          </div>
552
          <div data-spy="scroll" data-target="#navbarExample" class="scrollspy-example">
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
            <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>
576
577
578
579
580
581
582
583
          <hr>
          <h2>Using bootstrap-scrollspy.js</h2>
          <p>Call the scrollspy via javascript:</p>
          <pre class="prettyprint linenums">$('#navbar').dropdown()</pre>
          <h3>Markup</h3>
          <p>To easily add scrollspy behavior to your topbar navigation, just add <code>data-spy="scroll"</code> to the element you want to spy on (most typically this would be the body).
          <pre class="prettyprint linenums">&lt;body data-spy="scroll" &gt;...&lt;/body&gt;</pre>
           <p><span class="label notice">Notice</span> Navbar anchor tags must have resolvable id targets. For example, a <code>&lt;a href="#home"&gt;home&lt;/a&gt;</code> must correspond to something in the dom like <code>&lt;div id="home"&gt;&lt;/div&gt;</code>.
Jacob Thornton's avatar
Jacob Thornton committed
584
585
586
587
        </div>
      </div>
    </section>

588
589


Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
590
591
    <!-- Tabs
    ================================================== -->
592
    <section id="tabs">
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
593
      <div class="page-header">
594
        <h1>Togglable tabs <small>bootstrap-tab.js</small></h1>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
595
596
      </div>
      <div class="row">
597
        <div class="span3 columns">
598
          <p>This plugin adds quick, dynamic tab and pill functionality for transitioning through local content.</p>
599
          <a href="../js/bootstrap-tab.js" target="_blank" class="btn">Download file</a>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
600
        </div>
601
        <div class="span9 columns">
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
          <h2>Example tabs</h2>
          <p>Click the tabs below to toggle between hidden panes, even via dropdown menus.</p>
          <ul id="tab" class="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>
            </div>
          </div>
          <hr>
          <h2>Using bootstrap-tab.js</h2>
          <p>Enable tabbable tabs via javascript:</p>
632
          <pre class="prettyprint linenums">$('#myTab').tab('show')</pre>
633
          <h3>Markup</h3>
634
635
636
637
638
          <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.</p>
<pre class="prettyprint linenums">
&lt;ul class="tabs"&gt;
  &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;
639
640
  &lt;li&gt;&lt;a href="#messages" data-toggle="tab"&gt;Messages&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#ettings" data-toggle="tab"&gt;Settings&lt;/a&gt;&lt;/li&gt;
641
&lt;/ul&gt;</pre>
642
          <h3>Methods</h3>
643
          <h4>$().tab</h4>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
644
          <p>
645
            Activates a tab element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the dom.
646
647
          </p>
<pre class="prettyprint linenums">
Jacob Thornton's avatar
Jacob Thornton committed
648
&lt;ul class="tabs"&gt;
649
650
651
652
653
654
  &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;
&lt;/ul&gt;

655
&lt;div class="tab-content"&gt;
656
657
658
659
  &lt;div class="active" id="home"&gt;...&lt;/div&gt;
  &lt;div id="profile"&gt;...&lt;/div&gt;
  &lt;div id="messages"&gt;...&lt;/div&gt;
  &lt;div id="settings"&gt;...&lt;/div&gt;
660
&lt;/div&gt;
661
662
663

&lt;script&gt;
  $(function () {
664
    $('.tabs a:last').tab('show')
665
666
  })
&lt;/script&gt;</pre>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
667
          </p>
668
          <h3>Events</h3>
669
          <table class="table-bordered table-striped">
670
671
672
673
674
675
676
677
            <thead>
             <tr>
               <th style="width: 150px;">Event</th>
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
678
679
680
681
               <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>
682
               <td>shown</td>
683
               <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>
684
685
686
687
688
             </tr>
            </tbody>
          </table>

          <pre class="prettyprint linenums">
689
$('a[data-toggle="tab"]').on('shown', function (e) {
690
691
692
  e.target // activated tab
  e.relatedTarget // previous tab
})</pre>
693
       </div>
Jacob Thornton's avatar
Jacob Thornton committed
694
695
696
      </div>
    </section>

697

698
    <!-- Tooltips
699
    ================================================== -->
700
    <section id="tooltips">
701
      <div class="page-header">
702
        <h1>Tooltips <small>bootstrap-tooltip.js</small></h1>
703
704
      </div>
      <div class="row">
705
        <div class="span3 columns">
706
707
708
          <h3>About Tooltips</h3>
          <p>Inspired by the excellent jQuery.tipsy plugin written by Jason Frame; Tooltips are an updated version, which don't rely on images, uss css3 for animations, and data-attributes for local title storage.</p>
          <a href="../js/bootstrap-tooltip.js" target="_blank" class="btn">Download file</a>
709
        </div>
710
        <div class="span9 columns">
711
          <h2>Example use of Tooltips</h2>
712
          <p>Hover over the links below to see tooltips:</p>
713
714
          <div class="tooltip-demo well">
            <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 <a href="#" rel='tooltip' title='Another one here too'>really ironic</a> artisan whatever keytar, 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.
715
716
717
            </p>
          </div>
          <hr>
718
719
720
          <h2>Using bootstrap-tooltip.js</h2>
          <p>Trigger the tooltip via javascript:</p>
          <pre class="prettyprint linenums">$('#example').tooltip(options)</pre>
721
          <h3>Options</h3>
722
          <table class="table-bordered table-striped">
723
724
725
726
727
728
729
730
731
732
            <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>
Jacob Thornton's avatar
Jacob Thornton committed
733
               <td>animation</td>
734
735
736
737
738
739
740
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
               <td>placement</td>
               <td>string</td>
741
742
               <td>'top'</td>
               <td>how to position the tooltip - top | bottom | left | right</td>
743
744
             </tr>
             <tr>
745
746
               <td>selector</td>
               <td>string</td>
747
               <td>false</td>
748
               <td>If a selector is provided, tooltip objects will be delegated to the specified targets.</td>
749
750
             </tr>
             <tr>
751
752
753
754
               <td>title</td>
               <td>string | function</td>
               <td>''</td>
               <td>default title value if `title` tag isn't present</td>
755
756
757
758
759
760
761
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
762
763
764
765
766
767
768
769
770
771
             <tr>
               <td>delay</td>
               <td>number | object</td>
               <td>0</td>
               <td>
                <p>delay showing/hiding the tooltip (ms)</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>
772
773
            </tbody>
          </table>
774
          <p><span class="label notice">Notice</span> Individual tooltip instance options can alternatively be specified through the use of data attributes.</code></p>
775
          <h3>Markup</h3>
776
          <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>
777
          <h3>Methods</h3>
778
779
780
781
782
783
784
785
          <h4>$().tooltip(options)</h4>
          <p>Attaches a tooltip handler to an element collection.</p>
          <h4>.tooltip('show')</h4>
          <p>Reveals an elements tooltip.</p>
          <pre class="prettyprint linenums">$('#element').tooltip('show')</pre>
          <h4>.tooltip('hide')</h4>
          <p>Hides an elements tooltip.</p>
          <pre class="prettyprint linenums">$('#element').tooltip('hide')</pre>
786
787
788
789
        </div>
      </div>
    </section>

790
791


Jacob Thornton's avatar
Jacob Thornton committed
792
793
    <!-- Popovers
    ================================================== -->
794
    <section id="popovers">
Jacob Thornton's avatar
Jacob Thornton committed
795
796
797
798
      <div class="page-header">
        <h1>Popovers <small>bootstrap-popover.js</small></h1>
      </div>
      <div class="row">
799
        <div class="span3 columns">
800
801
          <h3>About popovers</h3>
          <p>Add small overlays of content, like those on the iPad, to any element for housing secondary information.</p>
802
          <p class="muted"><strong>*</strong> Requires <a href="#tooltip">Tooltip</a> to be included</p>
803
          <a href="../js/bootstrap-popover.js" target="_blank" class="btn">Download file</a>
Jacob Thornton's avatar
Jacob Thornton committed
804
        </div>
805
        <div class="span9 columns">
806
807
808
809
810
811
812
813
          <h2>Example hover popover</h2>
          <p>Hover over the button to trigger the popover.</p>
          <div class="well">
            <a href="#" class="btn danger" rel="popover" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">hover for popover</a>
          </div>
          <hr>
          <h2>Using bootstrap-popover.js</h2>
          <p>Enable popovers via javascript:</p>
Jacob Thornton's avatar
Jacob Thornton committed
814
815
          <pre class="prettyprint linenums">$('#example').popover(options)</pre>
          <h3>Options</h3>
816
          <table class="table-bordered table-striped">
817
818
819
820
821
822
823
824
825
826
            <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>
Jacob Thornton's avatar
Jacob Thornton committed
827
               <td>animation</td>
828
829
830
831
832
833
834
835
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
               <td>placement</td>
               <td>string</td>
               <td>'right'</td>
Jacob Thornton's avatar
Jacob Thornton committed
836
               <td>how to position the popover - top | bottom | left | right</td>
837
838
             </tr>
             <tr>
839
840
               <td>selector</td>
               <td>string</td>
841
               <td>false</td>
842
               <td>if a selector is provided, tooltip objects will be delegated to the specified targets</td>
843
844
845
846
847
848
849
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
             <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>
                <p>delay showing/hiding the popover (ms)</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>
872
873
            </tbody>
          </table>
874
875
          <p><span class="label notice">Notice</span> Individual popover instance options can alternatively be specified through the use of data attributes.</code></p>
          <h3>Markup</h3>
876
          <p>
877
          For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a the selector option.
878
          </p>
Jacob Thornton's avatar
Jacob Thornton committed
879
          <h3>Methods</h3>
880
          <h4>$().popover(options)</h4>
Jacob Thornton's avatar
Jacob Thornton committed
881
          <p>Initializes popovers for an element collection.</p>
882
          <h4>.popover('show')</h4>
883
          <p>Reveals an elements popover.</p>
884
885
          <pre class="prettyprint linenums">$('#element').popover('show')</pre>
          <h4>.popover('hide')</h4>
886
          <p>Hides an elements popover.</p>
887
          <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
888
889
890
        </div>
      </div>
    </section>
891

892

893

894
    <!-- Alert
895
    ================================================== -->
896
    <section id="alerts">
897
      <div class="page-header">
898
        <h1>Alert messages <small>bootstrap-alert.js</small></h1>
899
900
      </div>
      <div class="row">
901
        <div class="span3 columns">
902
903
904
          <h3>About alerts</h3>
          <p>The alert plugin is a tiny class for adding close functionality to alerts.</p>
          <a href="../js/bootstrap-alerts.js" target="_blank" class="btn">Download</a>
905
        </div>
906
        <div class="span9 columns">
907
908
          <h2>Example alerts</h2>
          <p>The alerts plugin works on regular alert messages, and block messages.</p>
Mark Otto's avatar
Mark Otto committed
909
          <div class="alert fade in">
910
            <a class="close" data-dismiss="alert" href="#">&times;</a>
911
            <strong>Holy guacamole!</strong> Best check yo self, you’re not looking too good.
912
          </div>
Mark Otto's avatar
Mark Otto committed
913
          <div class="alert alert-block alert-error fade in">
914
            <a class="close" data-dismiss="alert" href="#">&times;</a>
Mark Otto's avatar
Mark Otto committed
915
916
917
918
919
            <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>
              <a class="btn danger small" href="#">Take this action</a> <a class="btn small" href="#">Or do this</a>
            </p>
920
921
922
923
          </div>
          <hr>
          <h2>Using bootstrap-alerts.js</h2>
          <p>Enable dismissal of an alert via javascript:</p>
924
          <pre class="prettyprint linenums">$(".alert-message").alert()</pre>
925
          <h3>Markup</h3>
926
927
          <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>
928
          <h3>Methods</h3>
929
          <h4>$().alert()</h4>
930
          <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>
931
          <h4>.alert('close')</h4>
932
          <p>Closes an alert.</p>
933
          <pre class="prettyprint linenums">$(".alert-message").alert('close')</pre>
934
935
          <h3>Events</h3>
          <p>Bootstrap's alert class exposes a few events for hooking into alert functionality. </p>
936
          <table class="table-bordered table-striped">
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
            <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>
             <tr>
               <td>closed</td>
               <td>This event is fired when the alert has been closed (will wait for css transitions to complete).</td>
             </tr>
            </tbody>
          </table>
<pre class="prettyprint linenums">
$('#my-alert').bind('closed', function () {
  // do something ...
})</pre>
958
959
960
961
        </div>
      </div>
    </section>

Mark Otto's avatar
Mark Otto committed
962

963

964
965
    <!-- Buttons
    ================================================== -->
966
    <section id="buttons">
967
      <div class="page-header">
968
        <h1>Buttons <small>bootstrap-button.js</small></h1>
969
970
971
      </div>
      <div class="row">
        <div class="span3 columns">
972
973
974
          <h3>About</h3>
          <p>Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p>
          <a href="../js/bootstrap-button.js" target="_blank" class="btn">Download file</a>
975
976
        </div>
        <div class="span9 columns">
977
978
          <h2>Example uses</h2>
          <p>Use the buttons plugin for states and toggles.</p>
979
          <table class="table-bordered table-striped">
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
            <tbody>
             <tr>
               <td>Stateful</td>
               <td>
                  <button id="fat-btn" data-loading-text="loading..." class="btn primary">
                    Loading State
                  </button>
                </td>
             </tr>
             <tr>
               <td>Single toggle</td>
               <td>
                  <button class="btn primary" data-toggle="button">Single Toggle</button>
                </td>
             </tr>
             <tr>
               <td>Checkbox</td>
               <td>
                  <div class="btn-group" data-toggle="buttons-checkbox">
                    <button class="btn primary">Left</button>
                    <button class="btn primary">Middle</button>
For faster browsing, not all history is shown. View entire blame