javascript.html 68.6 KB
Newer Older
Jacob Thornton's avatar
Jacob Thornton committed
1
2
3
4
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
5
    <title>Javascript · 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">
27

Jacob Thornton's avatar
Jacob Thornton committed
28
29
  </head>

30
  <body data-spy="scroll" data-target=".bs-docs-sidebar" data-offset="10">
31

Mark Otto's avatar
Mark Otto committed
32
33
34
35
    <!-- Navbar
    ================================================== -->
    <div class="navbar navbar-fixed-top">
      <div class="navbar-inner">
36
        <div class="container">
Purwandi's avatar
Purwandi committed
37
          <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
Mark Otto's avatar
Mark Otto committed
38
39
40
41
42
43
44
45
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
          <a class="brand" href="./index.html">Bootstrap</a>
          <div class="nav-collapse collapse">
            <ul class="nav">
              <li class="">
Mark Otto's avatar
Mark Otto committed
46
                <a href="./index.html">Home</a>
Mark Otto's avatar
Mark Otto committed
47
48
49
50
51
52
53
54
55
56
57
              </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">
Mark Otto's avatar
Mark Otto committed
58
                <a href="./javascript.html">Javascript</a>
Mark Otto's avatar
Mark Otto committed
59
              </li>
60
61
62
              <li class="">
                <a href="./extend.html">Extend</a>
              </li>
Mark Otto's avatar
Mark Otto committed
63
64
65
66
67
68
            </ul>
          </div>
        </div>
      </div>
    </div>

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

71
72
73
74
75
<!-- Masthead
================================================== -->
<header class="jumbotron subhead" id="overview">
  <h1>Javascript for Bootstrap</h1>
  <p class="lead">Bring Bootstrap's components to life&mdash;now with 12 custom <a href="http://jquery.com/" target="_blank">jQuery</a> plugins.
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
  <div class="navbar navbar-subnav">
    <div class="navbar-inner">
      <ul class="nav">
        <li><a href="#transitions">Transitions</a></li>
        <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>
        <li><a href="#affix">Affix</a></li>
      </ul>
    </div>
Mark Otto's avatar
Mark Otto committed
94
  </div>
95
96
97
</header>


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<div class="row">
  <div class="span3 bs-docs-sidebar">
    <ul class="nav nav-list bs-docs-sidenav">
      <li><a href="#transitions">Transitions</a></li>
      <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>
      <li><a href="#affix">Affix</a></li>
    </ul>
  </div>
  <div class="span9">


119

120
121
122
123
124
125
126

<!-- Overview
================================================== -->
<section id="overview">
  <div class="page-header">
    <h1>Javascript in Bootstrap</h1>
  </div>
127

128
129
  <h3>Individual or compiled</h3>
  <p>If you have downloaded the latest version of Bootstrap, both <strong>bootstrap.js</strong> and <strong>bootstrap.min.js</strong> contain all of these plugins.</p>
130
131

  <h3>Data attributes</h3>
132
  <p>...</p>
133

134
135
136
137
138
139
140
141
142
143
144
  <h3>Programmatic API</h3>
  <p>...</p>



</section>



<!-- Transitions
================================================== -->
145
<section id="transitions">
146
147
148
149
  <div class="page-header">
    <h1>Transitions <small>bootstrap-transition.js</small></h1>
  </div>
  <h3>About transitions</h3>
150
151
152
153
154
155
156
157
158
159
  <p>For simple transition effects, include bootstrap-transition.js once alongside the other JS files. If you're using the compiled (or minified) bootstrap.js, there is no need to include this&mdash;it's already there.</p>
  <h3>Use cases</h3>
  <p>A few examples of the transition plugin:</p>
  <ul>
    <li>Sliding or fading in modals</li>
    <li>Fading out tabs</li>
    <li>Fading out alerts</li>
    <li>Sliding carousel panes</li>
  </ul>

160
</section>
Jacob Thornton's avatar
Jacob Thornton committed
161
162
163



164
165
166
167
168
169
170
<!-- Modal
================================================== -->
<section id="modals">
  <div class="page-header">
    <h1>Modals <small>bootstrap-modal.js</small></h1>
  </div>

171

172
173
  <h2>Examples</h2>
  <p>Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.</p>
174

175
  <h3>Static example</h3>
176
  <p>A rendered modal with header, body, and set of actions in the footer.</p>
177
178
179
180
181
  <div class="bs-docs-example" style="background-color: #f5f5f5;">
    <div class="modal" style="position: relative; top: auto; left: auto; margin: 0 auto 20px; z-index: 1; max-width: 100%;">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal">&times;</button>
        <h3>Modal header</h3>
Jacob Thornton's avatar
Jacob Thornton committed
182
      </div>
183
184
185
186
187
188
189
190
191
      <div class="modal-body">
        <p>One fine body…</p>
      </div>
      <div class="modal-footer">
        <a href="#" class="btn">Close</a>
        <a href="#" class="btn btn-primary">Save changes</a>
      </div>
    </div>
  </div>
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<pre class="prettyprint linenums">
&lt;div class="modal hide fade"&gt;
  &lt;div class="modal-header"&gt;
    &lt;button type="button" class="close" data-dismiss="modal"&gt;&amp;times;&lt;/button&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"&gt;Close&lt;/a&gt;
    &lt;a href="#" class="btn btn-primary"&gt;Save changes&lt;/a&gt;
  &lt;/div&gt;
&lt;/div&gt;
</pre>

  <h3>Live demo</h3>
209
210
  <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 -->
211
  <div id="myModal" class="modal hide" tabindex="-1" role="dialog" aria-labelledby="myModalLabel">
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
    <div class="modal-header">
      <button type="button" class="close" data-dismiss="modal">&times;</button>
      <h3 id="myModalLabel">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="#" role="button" class="btn popover-test" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">button</a> should trigger a popover on hover.</p>

      <h4>Tooltips in a modal</h4>
      <p><a href="#" class="tooltip-test" title="Tooltip">This link</a> and <a href="#" class="tooltip-test" title="Tooltip">that link</a> should have tooltips on hover.</p>

      <hr>

      <h4>Overflowing text to show optional scrollbar</h4>
      <p>We set a fixed <code>max-height</code> on the <code>.modal-body</code>. Watch it overflow with all this extra lorem ipsum text we've included.</p>
      <p>Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.</p>
      <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.</p>
      <p>Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.</p>
      <p>Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.</p>
      <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.</p>
      <p>Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.</p>
    </div>
    <div class="modal-footer">
      <a href="#" role="button" class="btn" data-dismiss="modal" >Close</a>
      <a href="#" role="button" class="btn btn-primary">Save changes</a>
    </div>
  </div>
  <div class="bs-docs-example" style="padding-bottom: 24px;">
    <a data-toggle="modal" href="#myModal" class="btn btn-primary btn-large">Launch demo modal</a>
  </div>
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<pre class="prettyprint linenums">
&lt;-- Button to trigger modal --&gt;
&lt;a href="#myModal" role="button" class="btn" data-toggle="modal"&gt;Launch demo modal&lt;/a&gt;

&lt;-- Modal --&gt;
&lt;div class="modal" id="myModal" tabindex="-1" role="dialog" aria-labelledby="myModalLabel"&gt;
  &lt;div class="modal-header"&gt;
    &lt;button type="button" class="close" data-dismiss="modal"&gt;&times;&lt;/button&gt;
    &lt;h3 id="myModalLabel"&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="#" role="button" class="btn"&gt;Close&lt;/a&gt;
    &lt;a href="#" role="button" class="btn btn-primary"&gt;Save changes&lt;/a&gt;
  &lt;/div&gt;
&lt;/div&gt;
</pre>
264
265


266
267
268
269
  <hr class="bs-docs-separator">


  <h2>Usage</h2>
270
271
272
273
274
275
276
277
278

  <h3>Via data attributes</h3>
  <p>Activate a modal without writing javascript. Set <code>data-toggle="modal"</code> on a controller element, like a button, along with a <code>data-target="#foo"</code> or <code>href="#foo"</code> to target a specific modal to toggle.</p>
<pre class="prettyprint linenums">
&lt;button type="button" data-toggle="modal" data-target="#myModal"&gt;Launch modal&lt;/button&gt;
</pre>

  <h3>Via javascript</h3>
  <p>Call a modal with id <code>myModal</code> with a single line of javascript:</p>
279
  <pre class="prettyprint linenums">$('#myModal').modal(options)</pre>
280

281
  <h3>Options</h3>
282
  <p>Options can be passed via data attributes or javascript. For data attributes, append the option name to <code>data-</code>, as in <code>data-backdrop=""</code>.</p>
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <th style="width: 100px;">Name</th>
       <th style="width: 50px;">type</th>
       <th style="width: 50px;">default</th>
       <th>description</th>
     </tr>
    </thead>
    <tbody>
     <tr>
       <td>backdrop</td>
       <td>boolean</td>
       <td>true</td>
       <td>Includes a modal-backdrop element. Alternatively, specify <code>static</code> for a backdrop which doesn't close the modal on click.</td>
     </tr>
     <tr>
       <td>keyboard</td>
       <td>boolean</td>
       <td>true</td>
       <td>Closes the modal when escape key is pressed</td>
     </tr>
     <tr>
       <td>show</td>
       <td>boolean</td>
       <td>true</td>
       <td>Shows the modal when initialized.</td>
     </tr>
     <tr>
       <td>remote</td>
       <td>path</td>
       <td>false</td>
       <td><p>If a remote url is provided, content will be loaded via jQuery's <code>load</code> method and injected into the <code>.modal-body</code>. If you're using the data api, you may alternatively use the <code>href</code> tag to specify the remote source. An example of this is shown below:</p>
316
<pre class="prettyprint linenums"><code>&lt;a data-toggle="modal" href="remote.html" data-target="#modal"&gt;click me&lt;/a&gt;</code></pre></td>
317
318
319
     </tr>
    </tbody>
  </table>
320

321
322
323
  <h3>Methods</h3>
  <h4>.modal(options)</h4>
  <p>Activates your content as a modal. Accepts an optional options <code>object</code>.</p>
Jacob Thornton's avatar
Jacob Thornton committed
324
<pre class="prettyprint linenums">
325
$('#myModal').modal({
Jacob Thornton's avatar
Jacob Thornton committed
326
  keyboard: false
327
})</pre>
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
  <h4>.modal('toggle')</h4>
  <p>Manually toggles a modal.</p>
  <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre>
  <h4>.modal('show')</h4>
  <p>Manually opens a modal.</p>
  <pre class="prettyprint linenums">$('#myModal').modal('show')</pre>
  <h4>.modal('hide')</h4>
  <p>Manually hides a modal.</p>
  <pre class="prettyprint linenums">$('#myModal').modal('hide')</pre>
  <h3>Events</h3>
  <p>Bootstrap's modal class exposes a few events for hooking into modal functionality.</p>
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <th style="width: 150px;">Event</th>
       <th>Description</th>
     </tr>
    </thead>
    <tbody>
     <tr>
       <td>show</td>
       <td>This event fires immediately when the <code>show</code> instance method is called.</td>
     </tr>
     <tr>
       <td>shown</td>
       <td>This event is fired when the modal has been made visible to the user (will wait for css transitions to complete).</td>
     </tr>
     <tr>
       <td>hide</td>
       <td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
     </tr>
     <tr>
       <td>hidden</td>
       <td>This event is fired when the modal has finished being hidden from the user (will wait for css transitions to complete).</td>
     </tr>
    </tbody>
  </table>
365
<pre class="prettyprint linenums">
366
$('#myModal').on('hidden', function () {
367
  // do something…
368
})</pre>
369
</section>
Jacob Thornton's avatar
Jacob Thornton committed
370
371
372



373
374
375
376
377
378
379
380
381
<!-- Dropdown
================================================== -->
<section id="dropdowns">
  <div class="page-header">
    <h1>Dropdowns <small>bootstrap-dropdown.js</small></h1>
  </div>


  <h2>Examples</h2>
382
  <p>Add dropdown menus to nearly anything with this simple plugin, including the navbar, tabs, and pills.</p>
383

384
  <h3>Within a navbar</h3>
385
386
387
388
389
390
  <div class="bs-docs-example">
    <div id="navbar-example" class="navbar navbar-static">
      <div class="navbar-inner">
        <div class="container" style="width: auto;">
          <a class="brand" href="#">Project Name</a>
          <ul class="nav" role="navigation">
Jacob Thornton's avatar
Jacob Thornton committed
391
            <li class="dropdown">
392
393
394
395
              <a id="drop1" href="#" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
              <ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
                <li><a tabindex="-1" href="http://google.com">Action</a></li>
                <li><a tabindex="-1" href="#anotherAction">Another action</a></li>
396
                <li><a tabindex="-1" href="#">Something else here</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
397
                <li class="divider"></li>
398
                <li><a tabindex="-1" href="#">Separated link</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
399
400
401
              </ul>
            </li>
            <li class="dropdown">
402
403
              <a href="#" id="drop2" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown 2 <b class="caret"></b></a>
              <ul class="dropdown-menu" role="menu" aria-labelledby="drop2">
404
405
406
                <li><a tabindex="-1" href="#">Action</a></li>
                <li><a tabindex="-1" href="#">Another action</a></li>
                <li><a tabindex="-1" href="#">Something else here</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
407
                <li class="divider"></li>
408
                <li><a tabindex="-1" href="#">Separated link</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
409
410
              </ul>
            </li>
411
412
413
414
415
          </ul>
          <ul class="nav pull-right">
            <li id="fat-menu" class="dropdown">
              <a href="#" id="drop3" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown 3 <b class="caret"></b></a>
              <ul class="dropdown-menu" role="menu" aria-labelledby="drop3">
416
417
418
                <li><a tabindex="-1" href="#">Action</a></li>
                <li><a tabindex="-1" href="#">Another action</a></li>
                <li><a tabindex="-1" href="#">Something else here</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
419
                <li class="divider"></li>
420
                <li><a tabindex="-1" href="#">Separated link</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
421
422
              </ul>
            </li>
423
424
425
426
427
          </ul>
        </div>
      </div>
    </div> <!-- /navbar-example -->
  </div> 
428

429
  <h3>Within tabs</h3>
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
  <div class="bs-docs-example">
    <ul class="nav nav-pills">
      <li class="active"><a href="#">Regular link</a></li>
      <li class="dropdown">
        <a class="dropdown-toggle" id="drop4" role="button" data-toggle="dropdown" href="#">Dropdown <b class="caret"></b></a>
        <ul id="menu1" class="dropdown-menu" role="menu" aria-labelledby="drop4">
          <li><a tabindex="-1" href="#">Action</a></li>
          <li><a tabindex="-1" href="#">Another action</a></li>
          <li><a tabindex="-1" href="#">Something else here</a></li>
          <li class="divider"></li>
          <li><a tabindex="-1" href="#">Separated link</a></li>
        </ul>
      </li>
      <li class="dropdown">
        <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">Dropdown 2 <b class="caret"></b></a>
        <ul id="menu2" class="dropdown-menu" role="menu" aria-labelledby="drop5">
          <li><a tabindex="-1" href="#">Action</a></li>
          <li><a tabindex="-1" href="#">Another action</a></li>
          <li><a tabindex="-1" href="#">Something else here</a></li>
          <li class="divider"></li>
          <li><a tabindex="-1" href="#">Separated link</a></li>
        </ul>
      </li>
      <li class="dropdown">
        <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">Dropdown 3 <b class="caret"></b></a>
        <ul id="menu3" class="dropdown-menu" role="menu" aria-labelledby="drop5">
          <li><a tabindex="-1" href="#">Action</a></li>
          <li><a tabindex="-1" href="#">Another action</a></li>
          <li><a tabindex="-1" href="#">Something else here</a></li>
          <li class="divider"></li>
          <li><a tabindex="-1" href="#">Separated link</a></li>
        </ul>
      </li>
    </ul> <!-- /tabs -->
  </div> 


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

469

470
471
472
473
  <h2>Usage</h2>

  <h3>Via data attributes</h3>
  <p>Add <code>data-toggle="dropdown"</code> to a link or button to toggle a dropdown.</p>
474
<pre class="prettyprint linenums">
475
476
477
478
479
480
481
&lt;div class="dropdown"&gt;
  &lt;a class="dropdown-toggle" href="#"&gt;Dropdown trigger&lt;/a&gt;
  &lt;ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"&gt;
    ...
  &lt;/ul&gt;
&lt;/div&gt;
</pre>
482
  <p>To keep URLs intact, use the <code>data-target</code> attribute instead of <code>href="#"</code>.</p>
483
<pre class="prettyprint linenums">
484
485
486
487
488
489
490
491
492
&lt;div class="dropdown"&gt;
  &lt;a class="dropdown-toggle" id="dLabel" role="button" data-toggle="dropdown" data-target="#" href="/page.html"&gt;
    Dropdown
    &lt;b class="caret"&gt;&lt;/b&gt;
  &lt;/a&gt;
  &lt;ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"&gt;
    ...
  &lt;/ul&gt;
&lt;/div&gt;
493
</pre>
494
495
496
497
498

  <h3>Via javascript</h3>
  <p>Call the dropdowns via javascript:</p>
  <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre>

499
500
501
  <h3>Options</h3>
  <p><em>None</em></p>

502
503
504
505
  <h3>Methods</h3>
  <h4>$().dropdown()</h4>
  <p>A programatic api for activating menus for a given navbar or tabbed navigation.</p>
</section>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
506

507
508


509
510
511
512
513
514
515
516
<!-- ScrollSpy
================================================== -->
<section id="scrollspy">
  <div class="page-header">
    <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
  </div>


517
518
  <h2>Example in navbar</h2>
  <p>The ScrollSpy plugin is for automatically updating nav targets based on scroll position. Scroll the area below the navbar and watch the active class change. The dropdown sub items will be highlighted as well.</p>
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
  <div class="bs-docs-example">
    <div id="navbarExample" class="navbar navbar-static">
      <div class="navbar-inner">
        <div class="container" style="width: auto;">
          <a class="brand" href="#">Project Name</a>
          <ul class="nav">
            <li><a href="#fat">@fat</a></li>
            <li><a href="#mdo">@mdo</a></li>
            <li class="dropdown">
              <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
              <ul class="dropdown-menu">
                <li><a href="#one">one</a></li>
                <li><a href="#two">two</a></li>
                <li class="divider"></li>
                <li><a href="#three">three</a></li>
              </ul>
            </li>
          </ul>
Jacob Thornton's avatar
Jacob Thornton committed
537
        </div>
538
539
540
541
      </div>
    </div>
    <div data-spy="scroll" data-target="#navbarExample" data-offset="0" class="scrollspy-example">
      <h4 id="fat">@fat</h4>
542
      <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>
543
      <h4 id="mdo">@mdo</h4>
544
      <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>
545
      <h4 id="one">one</h4>
546
      <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>
547
      <h4 id="two">two</h4>
548
      <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>
549
      <h4 id="three">three</h4>
550
      <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>
551
552
553
554
555
      <p>Keytar twee blog, culpa messenger bag marfa whatever delectus food truck. Sapiente synth id assumenda. Locavore sed helvetica cliche irony, thundercats you probably haven't heard of them consequat hoodie gluten-free lo-fi fap aliquip. Labore elit placeat before they sold out, terry richardson proident brunch nesciunt quis cosby sweater pariatur keffiyeh ut helvetica artisan. Cardigan craft beer seitan readymade velit. VHS chambray laboris tempor veniam. Anim mollit minim commodo ullamco thundercats.
      </p>
    </div>
  </div>

556
557
558
559
560
561
562
563
564
565
566

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


  <h2>Usage</h2>

  <h3>Via data attributes</h3>
  <p>To easily add scrollspy behavior to your topbar navigation, just add <code>data-spy="scroll"</code> to the element you want to spy on (most typically this would be the body) and <code>data-target=".navbar"</code> to select which nav to use.</p>
  <pre class="prettyprint linenums">&lt;body data-spy="scroll" data-target=".navbar"&gt;...&lt;/body&gt;</pre>

  <h3>Via javascript</h3>
567
568
  <p>Call the scrollspy via javascript:</p>
  <pre class="prettyprint linenums">$('#navbar').scrollspy()</pre>
569

570
571
572
573
  <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>
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>
578
579
580
581
582
<pre class="prettyprint linenums">
$('[data-spy="scroll"]').each(function () {
  var $spy = $(this).scrollspy('refresh')
});
</pre>
583

584
  <h3>Options</h3>
585
  <p>Options can be passed via data attributes or javascript. For data attributes, append the option name to <code>data-</code>, as in <code>data-offset=""</code>.</p>
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
  <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>
604
605

  <h3>Events</h3>
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <th style="width: 150px;">Event</th>
       <th>Description</th>
     </tr>
    </thead>
    <tbody>
     <tr>
       <td>activate</td>
       <td>This event fires whenever a new item becomes activated by the scrollspy.</td>
    </tr>
    </tbody>
  </table>
</section>
Jacob Thornton's avatar
Jacob Thornton committed
621

622
623


624
625
626
627
628
629
630
631
632
<!-- Tabs
================================================== -->
<section id="tabs">
  <div class="page-header">
    <h1>Togglable tabs <small>bootstrap-tab.js</small></h1>
  </div>


  <h2>Example tabs</h2>
633
  <p>Add quick, dynamic tab functionality to transiton through panes of local content, even via dropdown menus.</p>
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
  <div class="bs-docs-example">
    <ul id="myTab" class="nav nav-tabs">
      <li class="active"><a href="#home" data-toggle="tab">Home</a></li>
      <li><a href="#profile" data-toggle="tab">Profile</a></li>
      <li class="dropdown">
        <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
        <ul class="dropdown-menu">
          <li><a href="#dropdown1" data-toggle="tab">@fat</a></li>
          <li><a href="#dropdown2" data-toggle="tab">@mdo</a></li>
        </ul>
      </li>
    </ul>
    <div id="myTabContent" class="tab-content">
      <div class="tab-pane fade in active" id="home">
        <p>Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.</p>
649
      </div>
650
651
652
653
654
655
656
657
658
659
660
661
      <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>
  </div>

662
663
664
665
666

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


  <h2>Usage</h2>
667
668
  <p>Enable tabbable tabs via javascript (each tab needs to be activated individually):</p>
<pre class="prettyprint linenums">
669
670
671
672
$('#myTab a').click(function (e) {
  e.preventDefault();
  $(this).tab('show');
})</pre>
673
  <p>You can activate individual tabs in several ways:</p>
674
<pre class="prettyprint linenums">
675
676
677
678
$('#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)
679
</pre>
680

681
682
  <h3>Markup</h3>
  <p>You can activate a tab or pill navigation without writing any javascript by simply specifying <code>data-toggle="tab"</code> or <code>data-toggle="pill"</code> on an element. Adding the <code>nav</code> and <code>nav-tabs</code> classes to the tab <code>ul</code> will apply the bootstrap tab styling.</p>
683
<pre class="prettyprint linenums">
684
&lt;ul class="nav nav-tabs"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
685
686
687
  &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
688
  &lt;li&gt;&lt;a href="#settings" data-toggle="tab"&gt;Settings&lt;/a&gt;&lt;/li&gt;
689
&lt;/ul&gt;</pre>
690

691
692
693
694
695
  <h3>Methods</h3>
  <h4>$().tab</h4>
  <p>
    Activates a tab element and content container. Tab should have either a <code>data-target</code> or an <code>href</code> targeting a container node in the DOM.
  </p>
696
<pre class="prettyprint linenums">
697
&lt;ul class="nav nav-tabs" id="myTab"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
698
699
700
701
  &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;
702
703
&lt;/ul&gt;

704
&lt;div class="tab-content"&gt;
Mark Otto's avatar
Mark Otto committed
705
706
707
708
  &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;
709
&lt;/div&gt;
710
711

&lt;script&gt;
Jacob Thornton's avatar
Jacob Thornton committed
712
  $(function () {
713
    $('#myTab a:last').tab('show');
Jacob Thornton's avatar
Jacob Thornton committed
714
  })
715
&lt;/script&gt;</pre>
716

717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
  <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">
737
$('a[data-toggle="tab"]').on('shown', function (e) {
Jacob Thornton's avatar
Jacob Thornton committed
738
739
  e.target // activated tab
  e.relatedTarget // previous tab
740
})</pre>
741
</section>
Jacob Thornton's avatar
Jacob Thornton committed
742
743


744
745
746
747
748
749
750
751
<!-- Tooltips
================================================== -->
<section id="tooltips">
  <div class="page-header">
    <h1>Tooltips <small>bootstrap-tooltip.js</small></h1>
  </div>


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

760
761
762
763
764
765
766
767
768
769
  <h3>Four directions</h3>
  <div class="bs-docs-example tooltip-demo">
    <ul class="bs-docs-tooltip-examples">
      <li><a href="#" rel="tooltip" data-placement="top" title="Tooltip on top">Tooltip on top</a></li>
      <li><a href="#" rel="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</a></li>
      <li><a href="#" rel="tooltip" data-placement="bottom" title="Tooltip on bottom">Tooltip on bottom</a></li>
      <li><a href="#" rel="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</a></li>
    </ul>
  </div>

770
771
772
773
774

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


  <h2>Usage</h2>
775
776
  <p>Trigger the tooltip via javascript:</p>
  <pre class="prettyprint linenums">$('#example').tooltip(options)</pre>
777

778
  <h3>Options</h3>
779
  <p>Options can be passed via data attributes or javascript. For data attributes, append the option name to <code>data-</code>, as in <code>data-animation=""</code>.</p>
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
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <th style="width: 100px;">Name</th>
       <th style="width: 100px;">type</th>
       <th style="width: 50px;">default</th>
       <th>description</th>
     </tr>
    </thead>
    <tbody>
     <tr>
       <td>animation</td>
       <td>boolean</td>
       <td>true</td>
       <td>apply a css fade transition to the tooltip</td>
     </tr>
     <tr>
       <td>html</td>
       <td>boolean</td>
       <td>true</td>
       <td>Insert html into the tooltip. If false, jquery's <code>text</code> method will be used to insert content into the dom. Use text if you're worried about XSS attacks.</td>
     </tr>
     <tr>
       <td>placement</td>
       <td>string|function</td>
       <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>
        <p>delay showing and hiding the tooltip (ms) - does not apply to manual trigger type</p>
        <p>If a number is supplied, delay is applied to both hide/show</p>
        <p>Object structure is: <code>delay: { show: 500, hide: 100 }</code></p>
       </td>
     </tr>
    </tbody>
  </table>
  <div class="alert alert-info">
    <strong>Heads up!</strong>
    Options for individual tooltips can alternatively be specified through the use of data attributes.
  </div>
842

843
844
  <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>
845
846
847
<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
848

849
850
851
852
853
854
855
856
857
858
859
860
  <h3>Methods</h3>
  <h4>$().tooltip(options)</h4>
  <p>Attaches a tooltip handler to an element collection.</p>
  <h4>.tooltip('show')</h4>
  <p>Reveals an element's tooltip.</p>
  <pre class="prettyprint linenums">$('#element').tooltip('show')</pre>
  <h4>.tooltip('hide')</h4>
  <p>Hides an element's tooltip.</p>
  <pre class="prettyprint linenums">$('#element').tooltip('hide')</pre>
  <h4>.tooltip('toggle')</h4>
  <p>Toggles an element's tooltip.</p>
  <pre class="prettyprint linenums">$('#element').tooltip('toggle')</pre>
Mark Otto's avatar
Mark Otto committed
861
862
863
  <h4>.tooltip('destroy')</h4>
  <p>Destroys an element's tooltip.</p>
  <pre class="prettyprint linenums">$('#element').tooltip('destroy')</pre>
864
</section>
Jacob Thornton's avatar
Jacob Thornton committed
865
866
867



868
869
870
871
872
873
<!-- Popovers
================================================== -->
<section id="popovers">
  <div class="page-header">
    <h1>Popovers <small>bootstrap-popover.js</small></h1>
  </div>
Jacob Thornton's avatar
Jacob Thornton committed
874

875
  <h2>Examples</h2>
876
  <p>Add small overlays of content, like those on the iPad, to any element for housing secondary information. Hover over the button to trigger the popover. <strong>Requires <a href="#tooltips">Tooltip</a> to be included.</strong></p>
877
878
879
880
881
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
914
915
916
917

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

    <div class="popover right">
      <div class="arrow"></div>
      <h3 class="popover-title">Popover right</h3>
      <div class="popover-content">
        <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
      </div>
    </div>

    <div class="popover bottom">
      <div class="arrow"></div>
      <h3 class="popover-title">Popover bottom</h3>
      <div class="popover-content">
        <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
      </div>
    </div>

    <div class="popover left">
      <div class="arrow"></div>
      <h3 class="popover-title">Popover left</h3>
      <div class="popover-content">
        <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
      </div>
    </div>

    <div class="clearfix"></div>
  </div>
  <p>No markup shown as popovers are generated from javascript and content within a <code>data</code> attribute.</p>

  <h3>Live demo</h3>
918
  <div class="bs-docs-example" style="padding-bottom: 24px;">
919
    <a href="#" class="btn btn-large btn-danger" rel="popover" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">Hover for popover</a>
920
921
  </div>

922
923
924
925
926

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


  <h2>Usage</h2>
927
928
  <p>Enable popovers via javascript:</p>
  <pre class="prettyprint linenums">$('#example').popover(options)</pre>
929

930
  <h3>Options</h3>
931
  <p>Options can be passed via data attributes or javascript. For data attributes, append the option name to <code>data-</code>, as in <code>data-animation=""</code>.</p>
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <th style="width: 100px;">Name</th>
       <th style="width: 100px;">type</th>
       <th style="width: 50px;">default</th>
       <th>description</th>
     </tr>
    </thead>
    <tbody>
     <tr>
       <td>animation</td>
       <td>boolean</td>
       <td>true</td>
       <td>apply a css fade transition to the tooltip</td>
     </tr>
     <tr>
       <td>html</td>
       <td>boolean</td>
       <td>true</td>
       <td>Insert html into the popover. If false, jquery's <code>text</code> method will be used to insert content into the dom. Use text if you're worried about XSS attacks.</td>
     </tr>
     <tr>
       <td>placement</td>
       <td>string|function</td>
       <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>
Mark Otto's avatar
Mark Otto committed
970
       <td>how popover is triggered - hover | focus | manual</td>
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
     </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>
        <p>delay showing and hiding the popover (ms) - does not apply to manual trigger type</p>
        <p>If a number is supplied, delay is applied to both hide/show</p>
        <p>Object structure is: <code>delay: { show: 500, hide: 100 }</code></p>
       </td>
     </tr>
    </tbody>
  </table>
  <div class="alert alert-info">
    <strong>Heads up!</strong>
    Options for individual popovers can alternatively be specified through the use of data attributes.
  </div>
1000

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