javascript.mustache 86.8 KB
Newer Older
1
<!-- Subhead
2
================================================== -->
3
<header class="jumbotron subhead">
4
  <div class="container">
5
    <h1>{{_i}}JavaScript for Bootstrap{{/i}}</h1>
6
    <p class="lead">{{_i}}Bring Bootstrap's components to life&mdash;now with 13 custom jQuery plugins.{{/i}}
7
  </div>
8
9
</header>

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

12
13
14
15
    <!-- Docs nav
    ================================================== -->
    <div class="row">
      <div class="span3 bs-docs-sidebar">
16
        <ul class="nav nav-list bs-docs-sidenav">
17
18
19
20
21
22
23
24
25
26
27
28
          <li><a href="#overview"><i class="icon-chevron-right"></i> {{_i}}Overview{{/i}}</a></li>
          <li><a href="#transitions"><i class="icon-chevron-right"></i> {{_i}}Transitions{{/i}}</a></li>
          <li><a href="#modals"><i class="icon-chevron-right"></i> {{_i}}Modal{{/i}}</a></li>
          <li><a href="#dropdowns"><i class="icon-chevron-right"></i> {{_i}}Dropdown{{/i}}</a></li>
          <li><a href="#scrollspy"><i class="icon-chevron-right"></i> {{_i}}Scrollspy{{/i}}</a></li>
          <li><a href="#tabs"><i class="icon-chevron-right"></i> {{_i}}Tab{{/i}}</a></li>
          <li><a href="#tooltips"><i class="icon-chevron-right"></i> {{_i}}Tooltip{{/i}}</a></li>
          <li><a href="#popovers"><i class="icon-chevron-right"></i> {{_i}}Popover{{/i}}</a></li>
          <li><a href="#alerts"><i class="icon-chevron-right"></i> {{_i}}Alert{{/i}}</a></li>
          <li><a href="#buttons"><i class="icon-chevron-right"></i> {{_i}}Button{{/i}}</a></li>
          <li><a href="#collapse"><i class="icon-chevron-right"></i> {{_i}}Collapse{{/i}}</a></li>
          <li><a href="#carousel"><i class="icon-chevron-right"></i> {{_i}}Carousel{{/i}}</a></li>
29
          <li><a href="#typeahead"><i class="icon-chevron-right"></i> {{_i}}Typeahead{{/i}}</a></li>
30
          <li><a href="#affix"><i class="icon-chevron-right"></i> {{_i}}Affix{{/i}}</a></li>
31
        </ul>
32
33
      </div>
      <div class="span9">
Jacob Thornton's avatar
Jacob Thornton committed
34
35


36
37
38
39
        <!-- Overview
        ================================================== -->
        <section id="overview">
          <div class="page-header">
40
            <h1>{{_i}}JavaScript in Bootstrap{{/i}}</h1>
41
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
42

43
          <h3>{{_i}}Individual or compiled{{/i}}</h3>
44
          <p>{{_i}}If you have downloaded the latest version of Bootstrap, both <strong>bootstrap.js</strong> and <strong>bootstrap.min.js</strong> contain all of the plugins listed on this page.{{/i}}</p>
45

46
          <h3>{{_i}}Data attributes{{/i}}</h3>
47
          <p>{{_i}}You can use all Bootstrap plugins purely through the markup API without writing a single line of JavaScript. This is Bootstrap's first class API and should be your first consideration when using a plugin.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
48

49
50
          <p>{{_i}}That said, in some situations it may be desirable to turn this functionality off. Therefore, we also provide the ability to disable the data attribute API by unbinding all events on the body namespaced with `'data-api'`. This looks like this:{{/i}}
          <pre class="prettyprint linenums">$('body').off('.data-api')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
51

Mark Otto's avatar
Mark Otto committed
52
          <p>{{_i}}Alternatively, to target a specific plugin, just include the plugin's name as a namespace along with the data-api namespace like this:{{/i}}</p>
53
          <pre class="prettyprint linenums">$('body').off('.alert.data-api')</pre>
54

55
56
57
58
          <h3>{{_i}}Programmatic API{{/i}}</h3>
          <p>{{_i}}We also believe you should be able to use all Bootstrap plugins purely through the JavaScript API. All public APIs are single, chainable methods, and return the collection acted upon.{{/i}}</p>
          <pre class="prettyprint linenums">$(".btn.danger").button("toggle").addClass("fat")</pre>
          <p>{{_i}}All methods should accept an optional options object, a string which targets a particular method, or nothing (which initiates a plugin with default behavior):{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
59
<pre class="prettyprint linenums">
60
61
62
$("#myModal").modal()                       // initialized with defaults
$("#myModal").modal({ keyboard: false })   // initialized with no keyboard
$("#myModal").modal('show')                // initializes and invokes show immediately</p>
Jacob Thornton's avatar
Jacob Thornton committed
63
</pre>
Mark Otto's avatar
Mark Otto committed
64
          <p>{{_i}}Each plugin also exposes its raw constructor on a `Constructor` property: <code>$.fn.popover.Constructor</code>. If you'd like to get a particular plugin instance, retrieve it directly from an element: <code>$('[rel=popover]').data('popover')</code>.{{/i}}</p>
65

66
          <h3>{{_i}}Events{{/i}}</h3>
Mark Otto's avatar
Mark Otto committed
67
          <p>{{_i}}Bootstrap provides custom events for most plugin's unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex. <code>show</code>) is triggered at the start of an event, and its past participle form (ex. <code>shown</code>) is trigger on the completion of an action.{{/i}}</p>
68
          <p>{{_i}}All infinitive events provide preventDefault functionality. This provides the abililty to stop the execution of an action before it starts.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
69
<pre class="prettyprint linenums">
70
71
72
$('#myModal').on('show', function (e) {
    if (!data) return e.preventDefault() // stops modal from being shown
})
Jacob Thornton's avatar
Jacob Thornton committed
73
</pre>
74
        </section>
75
76
77



78
79
80
81
82
        <!-- Transitions
        ================================================== -->
        <section id="transitions">
          <div class="page-header">
            <h1>{{_i}}Transitions{{/i}} <small>bootstrap-transition.js</small></h1>
83
          </div>
84
85
86
87
88
89
90
91
92
93
          <h3>{{_i}}About transitions{{/i}}</h3>
          <p>{{_i}}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.{{/i}}</p>
          <h3>{{_i}}Use cases{{/i}}</h3>
          <p>{{_i}}A few examples of the transition plugin:{{/i}}</p>
          <ul>
            <li>{{_i}}Sliding or fading in modals{{/i}}</li>
            <li>{{_i}}Fading out tabs{{/i}}</li>
            <li>{{_i}}Fading out alerts{{/i}}</li>
            <li>{{_i}}Sliding carousel panes{{/i}}</li>
          </ul>
94

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

98
99


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

107

Mark Otto's avatar
Mark Otto committed
108
109
          <h2>{{_i}}Examples{{/i}}</h2>
          <p>{{_i}}Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.{{/i}}</p>
110

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

Mark Otto's avatar
Mark Otto committed
144
          <h3>{{_i}}Live demo{{/i}}</h3>
145
          <p>{{_i}}Toggle a modal via JavaScript by clicking the button below. It will slide down and fade in from the top of the page.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
146
          <!-- sample modal content -->
147
          <div id="myModal" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
Mark Otto's avatar
Mark Otto committed
148
            <div class="modal-header">
149
              <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
Mark Otto's avatar
Mark Otto committed
150
151
152
153
154
155
156
              <h3 id="myModalLabel">{{_i}}Modal Heading{{/i}}</h3>
            </div>
            <div class="modal-body">
              <h4>{{_i}}Text in a modal{{/i}}</h4>
              <p>Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem.</p>

              <h4>{{_i}}Popover in a modal{{/i}}</h4>
157
              <p>{{_i}}This <a href="#" role="button" class="btn popover-test" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">button</a> should trigger a popover on click.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
158
159
160
161
162
163
164
165
166
167
168
169
170
171

              <h4>{{_i}}Tooltips in a modal{{/i}}</h4>
              <p>{{_i}}<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.{{/i}}</p>

              <hr>

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

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


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


          <h2>{{_i}}Usage{{/i}}</h2>

          <h3>{{_i}}Via data attributes{{/i}}</h3>
208
          <p>{{_i}}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.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
209
210
          <pre class="prettyprint linenums">&lt;button type="button" data-toggle="modal" data-target="#myModal"&gt;Launch modal&lt;/button&gt;</pre>

211
212
          <h3>{{_i}}Via JavaScript{{/i}}</h3>
          <p>{{_i}}Call a modal with id <code>myModal</code> with a single line of JavaScript:{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
213
214
215
          <pre class="prettyprint linenums">$('#myModal').modal(options)</pre>

          <h3>{{_i}}Options{{/i}}</h3>
216
          <p>{{_i}}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>.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
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
245
246
247
248
249
250
251
252
253
254
255
256
257
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 100px;">{{_i}}Name{{/i}}</th>
               <th style="width: 50px;">{{_i}}type{{/i}}</th>
               <th style="width: 50px;">{{_i}}default{{/i}}</th>
               <th>{{_i}}description{{/i}}</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>{{_i}}backdrop{{/i}}</td>
               <td>{{_i}}boolean{{/i}}</td>
               <td>{{_i}}true{{/i}}</td>
               <td>{{_i}}Includes a modal-backdrop element. Alternatively, specify <code>static</code> for a backdrop which doesn't close the modal on click.{{/i}}</td>
             </tr>
             <tr>
               <td>{{_i}}keyboard{{/i}}</td>
               <td>{{_i}}boolean{{/i}}</td>
               <td>{{_i}}true{{/i}}</td>
               <td>{{_i}}Closes the modal when escape key is pressed{{/i}}</td>
             </tr>
             <tr>
               <td>{{_i}}show{{/i}}</td>
               <td>{{_i}}boolean{{/i}}</td>
               <td>{{_i}}true{{/i}}</td>
               <td>{{_i}}Shows the modal when initialized.{{/i}}</td>
             </tr>
             <tr>
               <td>{{_i}}remote{{/i}}</td>
               <td>{{_i}}path{{/i}}</td>
               <td>{{_i}}false{{/i}}</td>
               <td><p>{{_i}}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:{{/i}}</p>
              <pre class="prettyprint linenums"><code>&lt;a data-toggle="modal" href="remote.html" data-target="#modal"&gt;click me&lt;/a&gt;</code></pre></td>
             </tr>
            </tbody>
          </table>

          <h3{{_i}}>Methods{{/i}}</h3>
          <h4>.modal({{_i}}options{{/i}})</h4>
          <p>{{_i}}Activates your content as a modal. Accepts an optional options <code>object</code>.{{/i}}</p>
258
259
<pre class="prettyprint linenums">
$('#myModal').modal({
Jacob Thornton's avatar
Jacob Thornton committed
260
  keyboard: false
261
262
})
</pre>
Mark Otto's avatar
Mark Otto committed
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
          <h4>.modal('toggle')</h4>
          <p>{{_i}}Manually toggles a modal.{{/i}}</p>
          <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre>
          <h4>.modal('show')</h4>
          <p>{{_i}}Manually opens a modal.{{/i}}</p>
          <pre class="prettyprint linenums">$('#myModal').modal('show')</pre>
          <h4>.modal('hide')</h4>
          <p>{{_i}}Manually hides a modal.{{/i}}</p>
          <pre class="prettyprint linenums">$('#myModal').modal('hide')</pre>
          <h3>{{_i}}Events{{/i}}</h3>
          <p>{{_i}}Bootstrap's modal class exposes a few events for hooking into modal functionality.{{/i}}</p>
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 150px;">{{_i}}Event{{/i}}</th>
               <th>{{_i}}Description{{/i}}</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>{{_i}}show{{/i}}</td>
               <td>{{_i}}This event fires immediately when the <code>show</code> instance method is called.{{/i}}</td>
             </tr>
             <tr>
               <td>{{_i}}shown{{/i}}</td>
               <td>{{_i}}This event is fired when the modal has been made visible to the user (will wait for css transitions to complete).{{/i}}</td>
             </tr>
             <tr>
               <td>{{_i}}hide{{/i}}</td>
               <td>{{_i}}This event is fired immediately when the <code>hide</code> instance method has been called.{{/i}}</td>
             </tr>
             <tr>
               <td>{{_i}}hidden{{/i}}</td>
               <td>{{_i}}This event is fired when the modal has finished being hidden from the user (will wait for css transitions to complete).{{/i}}</td>
             </tr>
            </tbody>
          </table>
300
301
<pre class="prettyprint linenums">
$('#myModal').on('hidden', function () {
302
  // {{_i}}do something…{{/i}}
303
304
})
</pre>
Mark Otto's avatar
Mark Otto committed
305
        </section>
306
307
308



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


Mark Otto's avatar
Mark Otto committed
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
          <h2>{{_i}}Examples{{/i}}</h2>
          <p>{{_i}}Add dropdown menus to nearly anything with this simple plugin, including the navbar, tabs, and pills.{{/i}}</p>

          <h3>{{_i}}Within a navbar{{/i}}</h3>
          <div class="bs-docs-example">
            <div id="navbar-example" class="navbar navbar-static">
              <div class="navbar-inner">
                <div class="container" style="width: auto;">
                  <a class="brand" href="#">{{_i}}Project Name{{/i}}</a>
                  <ul class="nav" role="navigation">
                    <li class="dropdown">
                      <a id="drop1" href="#" role="button" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown{{/i}} <b class="caret"></b></a>
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
                        <li><a tabindex="-1" href="http://google.com">{{_i}}Action{{/i}}</a></li>
                        <li><a tabindex="-1" href="#anotherAction">{{_i}}Another action{{/i}}</a></li>
                        <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
                        <li class="divider"></li>
                        <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
                      </ul>
                    </li>
                    <li class="dropdown">
                      <a href="#" id="drop2" role="button" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown 2 {{/i}}<b class="caret"></b></a>
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop2">
                        <li><a tabindex="-1" href="#">{{_i}}Action{{/i}}</a></li>
                        <li><a tabindex="-1" href="#">{{_i}}Another action{{/i}}</a></li>
                        <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
                        <li class="divider"></li>
                        <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
                      </ul>
                    </li>
347
                  </ul>
Mark Otto's avatar
Mark Otto committed
348
349
350
351
352
353
354
355
356
357
358
                  <ul class="nav pull-right">
                    <li id="fat-menu" class="dropdown">
                      <a href="#" id="drop3" role="button" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown 3{{/i}} <b class="caret"></b></a>
                      <ul class="dropdown-menu" role="menu" aria-labelledby="drop3">
                        <li><a tabindex="-1" href="#">{{_i}}Action{{/i}}</a></li>
                        <li><a tabindex="-1" href="#">{{_i}}Another action{{/i}}</a></li>
                        <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
                        <li class="divider"></li>
                        <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
                      </ul>
                    </li>
359
                  </ul>
Mark Otto's avatar
Mark Otto committed
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
                </div>
              </div>
            </div> <!-- /navbar-example -->
          </div> {{! /example }}

          <h3>{{_i}}Within tabs{{/i}}</h3>
          <div class="bs-docs-example">
            <ul class="nav nav-pills">
              <li class="active"><a href="#">{{_i}}Regular link{{/i}}</a></li>
              <li class="dropdown">
                <a class="dropdown-toggle" id="drop4" role="button" data-toggle="dropdown" href="#">{{_i}}Dropdown{{/i}} <b class="caret"></b></a>
                <ul id="menu1" class="dropdown-menu" role="menu" aria-labelledby="drop4">
                  <li><a tabindex="-1" href="#">{{_i}}Action{{/i}}</a></li>
                  <li><a tabindex="-1" href="#">{{_i}}Another action{{/i}}</a></li>
                  <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
                  <li class="divider"></li>
                  <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
                </ul>
              </li>
              <li class="dropdown">
                <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">{{_i}}Dropdown 2{{/i}} <b class="caret"></b></a>
                <ul id="menu2" class="dropdown-menu" role="menu" aria-labelledby="drop5">
                  <li><a tabindex="-1" href="#">{{_i}}Action{{/i}}</a></li>
                  <li><a tabindex="-1" href="#">{{_i}}Another action{{/i}}</a></li>
                  <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
                  <li class="divider"></li>
                  <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
                </ul>
              </li>
              <li class="dropdown">
                <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">{{_i}}Dropdown 3{{/i}} <b class="caret"></b></a>
                <ul id="menu3" class="dropdown-menu" role="menu" aria-labelledby="drop5">
                  <li><a tabindex="-1" href="#">{{_i}}Action{{/i}}</a></li>
                  <li><a tabindex="-1" href="#">{{_i}}Another action{{/i}}</a></li>
                  <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
                  <li class="divider"></li>
                  <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
                </ul>
              </li>
            </ul> <!-- /tabs -->
          </div> {{! /example }}


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


          <h2>{{_i}}Usage{{/i}}</h2>

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

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

Mark Otto's avatar
Mark Otto committed
435
436
          <h3>{{_i}}Options{{/i}}</h3>
          <p><em>{{_i}}None{{/i}}</em></p>
437

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



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


Mark Otto's avatar
Mark Otto committed
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
          <h2>{{_i}}Example in navbar{{/i}}</h2>
          <p>{{_i}}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.{{/i}}</p>
          <div class="bs-docs-example">
            <div id="navbarExample" class="navbar navbar-static">
              <div class="navbar-inner">
                <div class="container" style="width: auto;">
                  <a class="brand" href="#">{{_i}}Project Name{{/i}}</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">{{_i}}Dropdown{{/i}} <b class="caret"></b></a>
                      <ul class="dropdown-menu">
                        <li><a href="#one">{{_i}}one{{/i}}</a></li>
                        <li><a href="#two">{{_i}}two{{/i}}</a></li>
                        <li class="divider"></li>
                        <li><a href="#three">{{_i}}three{{/i}}</a></li>
                      </ul>
                    </li>
                  </ul>
473
                </div>
474
              </div>
Mark Otto's avatar
Mark Otto committed
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
            </div>
            <div data-spy="scroll" data-target="#navbarExample" data-offset="0" class="scrollspy-example">
              <h4 id="fat">@fat</h4>
              <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p>
              <h4 id="mdo">@mdo</h4>
              <p>Veniam marfa mustache skateboard, adipisicing fugiat velit pitchfork beard. Freegan beard aliqua cupidatat mcsweeney's vero. Cupidatat four loko nisi, ea helvetica nulla carles. Tattooed cosby sweater food truck, mcsweeney's quis non freegan vinyl. Lo-fi wes anderson +1 sartorial. Carles non aesthetic exercitation quis gentrify. Brooklyn adipisicing craft beer vice keytar deserunt.</p>
              <h4 id="one">one</h4>
              <p>Occaecat commodo aliqua delectus. Fap craft beer deserunt skateboard ea. Lomo bicycle rights adipisicing banh mi, velit ea sunt next level locavore single-origin coffee in magna veniam. High life id vinyl, echo park consequat quis aliquip banh mi pitchfork. Vero VHS est adipisicing. Consectetur nisi DIY minim messenger bag. Cred ex in, sustainable delectus consectetur fanny pack iphone.</p>
              <h4 id="two">two</h4>
              <p>In incididunt echo park, officia deserunt mcsweeney's proident master cleanse thundercats sapiente veniam. Excepteur VHS elit, proident shoreditch +1 biodiesel laborum craft beer. Single-origin coffee wayfarers irure four loko, cupidatat terry richardson master cleanse. Assumenda you probably haven't heard of them art party fanny pack, tattooed nulla cardigan tempor ad. Proident wolf nesciunt sartorial keffiyeh eu banh mi sustainable. Elit wolf voluptate, lo-fi ea portland before they sold out four loko. Locavore enim nostrud mlkshk brooklyn nesciunt.</p>
              <h4 id="three">three</h4>
              <p>Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.</p>
              <p>Keytar twee blog, culpa messenger bag marfa whatever delectus food truck. Sapiente synth id assumenda. Locavore sed helvetica cliche irony, thundercats you probably haven't heard of them consequat hoodie gluten-free lo-fi fap aliquip. Labore elit placeat before they sold out, terry richardson proident brunch nesciunt quis cosby sweater pariatur keffiyeh ut helvetica artisan. Cardigan craft beer seitan readymade velit. VHS chambray laboris tempor veniam. Anim mollit minim commodo ullamco thundercats.
              </p>
            </div>
          </div>{{! /example }}
491

492

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


Mark Otto's avatar
Mark Otto committed
496
          <h2>{{_i}}Usage{{/i}}</h2>
497

Mark Otto's avatar
Mark Otto committed
498
          <h3>{{_i}}Via data attributes{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
499
          <p>{{_i}}To easily add scrollspy behavior to your topbar navigation, just add <code>data-spy="scroll"</code> to the element you want to spy on (most typically this would be the body) and <code>data-target=".navbar"</code> to select which nav to use. You'll want to use scrollspy with a <code>.nav</code> component.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
500
          <pre class="prettyprint linenums">&lt;body data-spy="scroll" data-target=".navbar"&gt;...&lt;/body&gt;</pre>
501

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

Mark Otto's avatar
Mark Otto committed
506
507
508
509
          <div class="alert alert-info">
            <strong>{{_i}}Heads up!{{/i}}</strong>
            {{_i}}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>.{{/i}}
          </div>
510

Mark Otto's avatar
Mark Otto committed
511
512
513
          <h3>{{_i}}Methods{{/i}}</h3>
          <h4>.scrollspy('refresh')</h4>
          <p>{{_i}}When using scrollspy in conjunction with adding or removing of elements from the DOM, you'll need to call the refresh method like so:{{/i}}</p>
514
515
516
517
518
<pre class="prettyprint linenums">
$('[data-spy="scroll"]').each(function () {
  var $spy = $(this).scrollspy('refresh')
});
</pre>
519

Mark Otto's avatar
Mark Otto committed
520
          <h3>{{_i}}Options{{/i}}</h3>
521
          <p>{{_i}}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>.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
               <th style="width: 100px;">{{_i}}Name{{/i}}</th>
               <th style="width: 100px;">{{_i}}type{{/i}}</th>
               <th style="width: 50px;">{{_i}}default{{/i}}</th>
               <th>{{_i}}description{{/i}}</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>{{_i}}offset{{/i}}</td>
               <td>{{_i}}number{{/i}}</td>
               <td>{{_i}}10{{/i}}</td>
               <td>{{_i}}Pixels to offset from top when calculating position of scroll.{{/i}}</td>
             </tr>
            </tbody>
          </table>
540

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

Mark Otto's avatar
Mark Otto committed
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587


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


          <h2>{{_i}}Example tabs{{/i}}</h2>
          <p>{{_i}}Add quick, dynamic tab functionality to transiton through panes of local content, even via dropdown menus.{{/i}}</p>
          <div class="bs-docs-example">
            <ul id="myTab" class="nav nav-tabs">
              <li class="active"><a href="#home" data-toggle="tab">{{_i}}Home{{/i}}</a></li>
              <li><a href="#profile" data-toggle="tab">{{_i}}Profile{{/i}}</a></li>
              <li class="dropdown">
                <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown{{/i}} <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>
588
              </div>
Mark Otto's avatar
Mark Otto committed
589
590
591
592
593
594
595
596
              <div class="tab-pane fade" id="dropdown1">
                <p>Etsy mixtape wayfarers, ethical wes anderson tofu before they sold out mcsweeney's organic lomo retro fanny pack lo-fi farm-to-table readymade. Messenger bag gentrify pitchfork tattooed craft beer, iphone skateboard locavore carles etsy salvia banksy hoodie helvetica. DIY synth PBR banksy irony. Leggings gentrify squid 8-bit cred pitchfork. Williamsburg banh mi whatever gluten-free, carles pitchfork biodiesel fixie etsy retro mlkshk vice blog. Scenester cred you probably haven't heard of them, vinyl craft beer blog stumptown. Pitchfork sustainable tofu synth chambray yr.</p>
              </div>
              <div class="tab-pane fade" id="dropdown2">
                <p>Trust fund seitan letterpress, keytar raw denim keffiyeh etsy art party before they sold out master cleanse gluten-free squid scenester freegan cosby sweater. Fanny pack portland seitan DIY, art party locavore wolf cliche high life echo park Austin. Cred vinyl keffiyeh DIY salvia PBR, banh mi before they sold out farm-to-table VHS viral locavore cosby sweater. Lomo wolf viral, mustache readymade thundercats keffiyeh craft beer marfa ethical. Wolf salvia freegan, sartorial keffiyeh echo park vegan.</p>
              </div>
            </div>
          </div>{{! /example }}
597
598


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


Mark Otto's avatar
Mark Otto committed
602
          <h2>{{_i}}Usage{{/i}}</h2>
603
          <p>{{_i}}Enable tabbable tabs via JavaScript (each tab needs to be activated individually):{{/i}}</p>
604
<pre class="prettyprint linenums">
605
606
607
608
$('#myTab a').click(function (e) {
  e.preventDefault();
  $(this).tab('show');
})</pre>
Mark Otto's avatar
Mark Otto committed
609
          <p>{{_i}}You can activate individual tabs in several ways:{{/i}}</p>
610
<pre class="prettyprint linenums">
Mark Otto's avatar
Mark Otto committed
611
612
613
614
$('#myTab a[href="#profile"]').tab('show'); // Select tab by name
$('#myTab a:first').tab('show'); // Select first tab
$('#myTab a:last').tab('show'); // Select last tab
$('#myTab li:eq(2) a').tab('show'); // Select third tab (0-indexed)
615
</pre>
616

Mark Otto's avatar
Mark Otto committed
617
          <h3>{{_i}}Markup{{/i}}</h3>
618
          <p>{{_i}}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.{{/i}}</p>
619
<pre class="prettyprint linenums">
620
&lt;ul class="nav nav-tabs"&gt;
621
622
623
  &lt;li&gt;&lt;a href="#home" data-toggle="tab"&gt;{{_i}}Home{{/i}}&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#profile" data-toggle="tab"&gt;{{_i}}Profile{{/i}}&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#messages" data-toggle="tab"&gt;{{_i}}Messages{{/i}}&lt;/a&gt;&lt;/li&gt;
Kyle Robinson Young's avatar
Kyle Robinson Young committed
624
  &lt;li&gt;&lt;a href="#settings" data-toggle="tab"&gt;{{_i}}Settings{{/i}}&lt;/a&gt;&lt;/li&gt;
625
&lt;/ul&gt;</pre>
626

Mark Otto's avatar
Mark Otto committed
627
628
629
630
631
          <h3>{{_i}}Methods{{/i}}</h3>
          <h4>$().tab</h4>
          <p>
            {{_i}}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.{{/i}}
          </p>
632
<pre class="prettyprint linenums">
633
&lt;ul class="nav nav-tabs" id="myTab"&gt;
634
635
636
637
  &lt;li class="active"&gt;&lt;a href="#home"&gt;{{_i}}Home{{/i}}&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#profile"&gt;{{_i}}Profile{{/i}}&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#messages"&gt;{{_i}}Messages{{/i}}&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#settings"&gt;{{_i}}Settings{{/i}}&lt;/a&gt;&lt;/li&gt;
638
639
640
&lt;/ul&gt;

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

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

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


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

689

690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
          <h2>{{_i}}Examples{{/i}}</h2>
          <p>{{_i}}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.{{/i}}</p>
          <p>{{_i}}Hover over the links below to see tooltips:{{/i}}</p>
          <div class="bs-docs-example tooltip-demo">
            <p class="muted" style="margin-bottom: 0;">{{_i}}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.{{/i}}
            </p>
          </div>{{! /example }}

          <h3>{{_i}}Four directions{{/i}}</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>{{! /example }}


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


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

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

781
782
          <h3>{{_i}}Markup{{/i}}</h3>
          <p>{{_i}}For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a selector option.{{/i}}</p>
783
          <pre class="prettyprint linenums">&lt;a href="#" rel="tooltip" title="{{_i}}first tooltip{{/i}}"&gt;{{_i}}hover over me{{/i}}&lt;/a&gt;</pre>
784

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



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

811
812
813
814
815
816
817
818
819
820
821
822
823
824
        <h2>{{_i}}Examples{{/i}}</h2>
        <p>{{_i}}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>{{/i}}</p>

        <h3>{{_i}}Static popover{{/i}}</h3>
        <p>{{_i}}Four options are available: top, right, bottom, and left aligned.{{/i}}</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>

Mark Otto's avatar
Mark Otto committed
825
826
827
828
829
          <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>
830
            </div>
Mark Otto's avatar
Mark Otto committed
831
          </div>
832

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

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

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

Mark Otto's avatar
Mark Otto committed
853
854
        <h3>Live demo</h3>
        <div class="bs-docs-example" style="padding-bottom: 24px;">
855
          <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?">{{_i}}Click to toggle popover{{/i}}</a>
Mark Otto's avatar
Mark Otto committed
856
        </div>
857

858
859
860
861
862
863
864
865
866
867
        <h4>{{_i}}Four directions{{/i}}</h4>
        <div class="bs-docs-example tooltip-demo">
          <ul class="bs-docs-tooltip-examples">
            <li><a href="#" class="btn" rel="popover" data-placement="top" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus." title="Popover on top">Popover on top</a></li>
            <li><a href="#" class="btn" rel="popover" data-placement="right" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus." title="Popover on right">Popover on right</a></li>
            <li><a href="#" class="btn" rel="popover" data-placement="bottom" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus." title="Popover on bottom">Popover on bottom</a></li>
            <li><a href="#" class="btn" rel="popover" data-placement="left" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus." title="Popover on left">Popover on left</a></li>
          </ul>
        </div>{{! /example }}

868

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


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

        <h3>{{_i}}Options{{/i}}</h3>
877
        <p>{{_i}}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>.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
        <table class="table table-bordered table-striped">
          <thead>
           <tr>
             <th style="width: 100px;">{{_i}}Name{{/i}}</th>
             <th style="width: 100px;">{{_i}}type{{/i}}</th>
             <th style="width: 50px;">{{_i}}default{{/i}}</th>
             <th>{{_i}}description{{/i}}</th>
           </tr>
          </thead>
          <tbody>
           <tr>
             <td>{{_i}}animation{{/i}}</td>
             <td>{{_i}}boolean{{/i}}</td>
             <td>true</td>
             <td>{{_i}}apply a css fade transition to the tooltip{{/i}}</td>
           </tr>
           <tr>
             <td>{{_i}}html{{/i}}</td>
             <td>{{_i}}boolean{{/i}}</td>
897
             <td>false</td>
Mark Otto's avatar
Mark Otto committed
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
             <td>{{_i}}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.{{/i}}</td>
           </tr>
           <tr>
             <td>{{_i}}placement{{/i}}</td>
             <td>{{_i}}string|function{{/i}}</td>
             <td>'right'</td>
             <td>{{_i}}how to position the popover{{/i}} - top | bottom | left | right</td>
           </tr>
           <tr>
             <td>{{_i}}selector{{/i}}</td>
             <td>{{_i}}string{{/i}}</td>
             <td>false</td>
             <td>{{_i}}if a selector is provided, tooltip objects will be delegated to the specified targets{{/i}}</td>
           </tr>
           <tr>
             <td>{{_i}}trigger{{/i}}</td>
             <td>{{_i}}string{{/i}}</td>
915
916
             <td>'click'</td>
             <td>{{_i}}how popover is triggered{{/i}} - click | hover | focus | manual</td>
Mark Otto's avatar
Mark Otto committed
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
           </tr>
           <tr>
             <td>{{_i}}title{{/i}}</td>
             <td>{{_i}}string | function{{/i}}</td>
             <td>''</td>
             <td>{{_i}}default title value if `title` attribute isn't present{{/i}}</td>
           </tr>
           <tr>
             <td>{{_i}}content{{/i}}</td>
             <td>{{_i}}string | function{{/i}}</td>
             <td>''</td>
             <td>{{_i}}default content value if `data-content` attribute isn't present{{/i}}</td>
           </tr>
           <tr>
             <td>{{_i}}delay{{/i}}</td>
             <td>{{_i}}number | object{{/i}}</td>
             <td>0</td>
             <td>
              <p>{{_i}}delay showing and hiding the popover (ms) - does not apply to manual trigger type{{/i}}</p>
              <p>{{_i}}If a number is supplied, delay is applied to both hide/show{{/i}}</p>
              <p>{{_i}}Object structure is: <code>delay: { show: 500, hide: 100 }</code>{{/i}}</p>
             </td>
           </tr>
          </tbody>
        </table>
        <div class="alert alert-info">
          <strong>{{_i}}Heads up!{{/i}}</strong>
          {{_i}}Options for individual popovers can alternatively be specified through the use of data attributes.{{/i}}
        </div>
946

Mark Otto's avatar
Mark Otto committed
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
        <h3>{{_i}}Markup{{/i}}</h3>
        <p>{{_i}}For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a selector option.{{/i}}</p>

        <h3>{{_i}}Methods{{/i}}</h3>
        <h4>$().popover({{_i}}options{{/i}})</h4>
        <p>{{_i}}Initializes popovers for an element collection.{{/i}}</p>
        <h4>.popover('show')</h4>
        <p>{{_i}}Reveals an elements popover.{{/i}}</p>
        <pre class="prettyprint linenums">$('#element').popover('show')</pre>
        <h4>.popover('hide')</h4>
        <p>{{_i}}Hides an elements popover.{{/i}}</p>
        <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
        <h4>.popover('toggle')</h4>
        <p>{{_i}}Toggles an elements popover.{{/i}}</p>
        <pre class="prettyprint linenums">$('#element').popover('toggle')</pre>
        <h4>.popover('destroy')</h4>
        <p>{{_i}}Hides and destroys an element's popover.{{/i}}</p>
        <pre class="prettyprint linenums">$('#element').popover('destroy')</pre>
      </section>



      <!-- Alert
      ================================================== -->
      <section id="alerts">
        <div class="page-header">
          <h1>{{_i}}Alert messages{{/i}} <small>bootstrap-alert.js</small></h1>
        </div>
975
976


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

        <div class="bs-docs-example">
          <div class="alert alert-block alert-error fade in">
            <button type="button" class="close" data-dismiss="alert">&times;</button>
            <h4 class="alert-heading">{{_i}}Oh snap! You got an error!{{/i}}</h4>
            <p>{{_i}}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.{{/i}}</p>
            <p>
              <a class="btn btn-danger" href="#">{{_i}}Take this action{{/i}}</a> <a class="btn" href="#">{{_i}}Or do this{{/i}}</a>
            </p>
          </div>
        </div>{{! /example }}


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


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