javascript.html 101 KB
Newer Older
Mark Otto's avatar
Mark Otto committed
1
2
---
layout: default
fat's avatar
fat committed
3
title: JavaScript
Mark Otto's avatar
Mark Otto committed
4
5
6
7
8
9
10
slug: js
lead: "Bring Bootstrap's components to life with over a dozen custom jQuery plugins. Easily include them all, or one by one."
---


  <!-- Overview
  ================================================== -->
fat's avatar
fat committed
11
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
12
    <div class="page-header">
fat's avatar
fat committed
13
      <h1 id="js-overview">Overview</h1>
Mark Otto's avatar
Mark Otto committed
14
15
16
    </div>

    <h3 id="js-individual-compiled">Individual or compiled</h3>
17
    <p>Plugins can be included individually (using Bootstrap's individual <code>*.js</code> files), or all at once (using <code>bootstrap.js</code> or the minified <code>bootstrap.min.js</code>).</p>
18
19
20
21
22
23
24

    <div class="bs-callout bs-callout-danger">
      <h4>Do not attempt to include both.</h4>
      <p>Both <code>bootstrap.js</code> and <code>bootstrap.min.js</code> contain all plugins in a single file.</p>
    </div>

    <div class="bs-callout bs-callout-danger">
Mark Otto's avatar
Mark Otto committed
25
      <h4>Plugin dependencies</h4>
26
      <p>Some plugins and CSS components depend on other plugins. If you include plugins individually, make sure to check for these dependencies in the docs. Also note that all plugins depend on jQuery (this means jQuery must be included <strong>before</strong> the plugin files). <a href="{{ site.repo }}/blob/v{{ site.current_version }}/bower.json">Consult our <code>bower.json</code></a> to see which versions of jQuery are supported.</p>
Mark Otto's avatar
Mark Otto committed
27
28
29
    </div>

    <h3 id="js-data-attrs">Data attributes</h3>
30
    <p>You can use all Bootstrap plugins purely through the markup API without writing a single line of JavaScript. This is Bootstrap's first-class API and should be your first consideration when using a plugin.</p>
Mark Otto's avatar
Mark Otto committed
31

32
    <p>That said, in some situations it may be desirable to turn this functionality off. Therefore, we also provide the ability to disable the data attribute API by unbinding all events on the document namespaced with <code>data-api</code>. This looks like this:</p>
Mark Otto's avatar
Mark Otto committed
33
{% highlight js %}
Jacob Thornton's avatar
Jacob Thornton committed
34
$(document).off('.data-api')
Mark Otto's avatar
Mark Otto committed
35
36
37
38
{% endhighlight %}

    <p>Alternatively, to target a specific plugin, just include the plugin's name as a namespace along with the data-api namespace like this:</p>
{% highlight js %}
Jacob Thornton's avatar
Jacob Thornton committed
39
$(document).off('.alert.data-api')
Mark Otto's avatar
Mark Otto committed
40
41
42
43
44
{% endhighlight %}

    <h3 id="js-programmatic-api">Programmatic API</h3>
    <p>We also believe you should be able to use all Bootstrap plugins purely through the JavaScript API. All public APIs are single, chainable methods, and return the collection acted upon.</p>
{% highlight js %}
45
$('.btn.danger').button('toggle').addClass('fat')
Mark Otto's avatar
Mark Otto committed
46
47
48
49
{% endhighlight %}

    <p>All methods should accept an optional options object, a string which targets a particular method, or nothing (which initiates a plugin with default behavior):</p>
{% highlight js %}
50
51
$('#myModal').modal()                      // initialized with defaults
$('#myModal').modal({ keyboard: false })   // initialized with no keyboard
52
$('#myModal').modal('show')                // initializes and invokes show immediately
Mark Otto's avatar
Mark Otto committed
53
54
{% endhighlight %}

55
    <p>Each plugin also exposes its raw constructor on a <code>Constructor</code> property: <code>$.fn.popover.Constructor</code>. If you'd like to get a particular plugin instance, retrieve it directly from an element: <code>$('[rel=popover]').data('popover')</code>.</p>
Mark Otto's avatar
Mark Otto committed
56
57
58
59
60

    <h3 id="js-noconflict">No conflict</h3>
    <p>Sometimes it is necessary to use Bootstrap plugins with other UI frameworks. In these circumstances, namespace collisions can occasionally occur. If this happens, you may call <code>.noConflict</code> on the plugin you wish to revert the value of.</p>
{% highlight js %}
var bootstrapButton = $.fn.button.noConflict() // return $.fn.button to previously assigned value
Chris Rebert's avatar
Chris Rebert committed
61
$.fn.bootstrapBtn = bootstrapButton            // give $().bootstrapBtn the Bootstrap functionality
Mark Otto's avatar
Mark Otto committed
62
63
64
65
{% endhighlight %}

    <h3 id="js-events">Events</h3>
    <p>Bootstrap provides custom events for most plugin's unique actions. Generally, these come in an infinitive and past participle form - where the infinitive (ex. <code>show</code>) is triggered at the start of an event, and its past participle form (ex. <code>shown</code>) is trigger on the completion of an action.</p>
Chris Rebert's avatar
Chris Rebert committed
66
    <p>As of 3.0.0, all Bootstrap events are namespaced.</p>
Mark Otto's avatar
Mark Otto committed
67
68
    <p>All infinitive events provide <code>preventDefault</code> functionality. This provides the ability to stop the execution of an action before it starts.</p>
{% highlight js %}
fat's avatar
fat committed
69
$('#myModal').on('show.bs.modal', function (e) {
Mark Otto's avatar
Mark Otto committed
70
71
72
  if (!data) return e.preventDefault() // stops modal from being shown
})
{% endhighlight %}
73

74
    <div class="bs-callout bs-callout-warning" id="callout-third-party-libs">
75
      <h4>Third-party libraries</h4>
Mark Otto's avatar
Mark Otto committed
76
      <p><strong>Bootstrap does not officially support third-party JavaScript libraries</strong> like Prototype or jQuery UI. Despite <code>.noConflict</code> and namespaced events, there may be compatibility problems that you need to fix on your own.</p>
77
    </div>
Mark Otto's avatar
Mark Otto committed
78
79
80
81
82
83
  </div>



  <!-- Transitions
  ================================================== -->
fat's avatar
fat committed
84
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
85
    <div class="page-header">
fat's avatar
fat committed
86
      <h1 id="transitions">Transitions <small>transition.js</small></h1>
Mark Otto's avatar
Mark Otto committed
87
88
    </div>
    <h3>About transitions</h3>
Chris Rebert's avatar
Chris Rebert committed
89
    <p>For simple transition effects, include <code>transition.js</code> once alongside the other JS files. If you're using the compiled (or minified) <code>bootstrap.js</code>, there is no need to include this&mdash;it's already there.</p>
fat's avatar
fat committed
90
    <h3>What's inside</h3>
91
    <p>Transition.js is a basic helper for <code>transitionEnd</code> events as well as a CSS transition emulator. It's used by the other plugins to check for CSS transition support and to catch hanging transitions.</p>
Mark Otto's avatar
Mark Otto committed
92
93
94
95
96
97
  </div>



  <!-- Modal
  ================================================== -->
fat's avatar
fat committed
98
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
99
    <div class="page-header">
fat's avatar
fat committed
100
      <h1 id="modals">Modals <small>modal.js</small></h1>
Mark Otto's avatar
Mark Otto committed
101
102
103
104
105
    </div>

    <h2 id="modals-examples">Examples</h2>
    <p>Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.</p>

106
    <div class="bs-callout bs-callout-warning" id="callout-stacked-modals">
107
108
109
      <h4>Overlapping modals not supported</h4>
      <p>Be sure not to open a modal while another is still visible. Showing more than one modal at a time requires custom code.</p>
    </div>
110
111
    <div class="bs-callout bs-callout-warning">
      <h4>Mobile device caveats</h4>
Quy Ton's avatar
Quy Ton committed
112
      <p>There are some caveats regarding using modals on mobile devices. <a href="../getting-started/#support-fixed-position-keyboards">See our browser support docs</a> for details.</p>
113
    </div>
114

Mark Otto's avatar
Mark Otto committed
115
116
    <h3>Static example</h3>
    <p>A rendered modal with header, body, and set of actions in the footer.</p>
Mark Otto's avatar
Mark Otto committed
117
    <div class="bs-example bs-example-modal">
Mark Otto's avatar
Mark Otto committed
118
119
120
121
122
123
124
125
126
127
128
      <div class="modal">
        <div class="modal-dialog">
          <div class="modal-content">
            <div class="modal-header">
              <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
              <h4 class="modal-title">Modal title</h4>
            </div>
            <div class="modal-body">
              <p>One fine body&hellip;</p>
            </div>
            <div class="modal-footer">
129
130
              <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
              <button type="button" class="btn btn-primary">Save changes</button>
Mark Otto's avatar
Mark Otto committed
131
132
            </div>
          </div><!-- /.modal-content -->
Chris Rebert's avatar
Chris Rebert committed
133
        </div><!-- /.modal-dialog -->
Mark Otto's avatar
Mark Otto committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147
      </div><!-- /.modal -->
    </div><!-- /example -->
{% highlight html %}
<div class="modal fade">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
        <h4 class="modal-title">Modal title</h4>
      </div>
      <div class="modal-body">
        <p>One fine body&hellip;</p>
      </div>
      <div class="modal-footer">
148
149
        <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
        <button type="button" class="btn btn-primary">Save changes</button>
Mark Otto's avatar
Mark Otto committed
150
151
      </div>
    </div><!-- /.modal-content -->
Chris Rebert's avatar
Chris Rebert committed
152
  </div><!-- /.modal-dialog -->
Mark Otto's avatar
Mark Otto committed
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
</div><!-- /.modal -->
{% endhighlight %}

    <h3>Live demo</h3>
    <p>Toggle a modal via JavaScript by clicking the button below. It will slide down and fade in from the top of the page.</p>
    <!-- sample modal content -->
    <div id="myModal" class="modal fade" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
      <div class="modal-dialog">
        <div class="modal-content">

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

            <h4>Popover in a modal</h4>
172
            <p>This <a href="#" role="button" class="btn btn-default popover-test" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">button</a> should trigger a popover on click.</p>
Mark Otto's avatar
Mark Otto committed
173
174
175
176
177
178

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

Mark Otto's avatar
Mark Otto committed
179
            <h4>Overflowing text to show scroll behavior</h4>
Mark Otto's avatar
Mark Otto committed
180
181
182
183
184
185
186
187
188
189
190
            <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>
            <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">
191
192
            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
            <button type="button" class="btn btn-primary">Save changes</button>
Mark Otto's avatar
Mark Otto committed
193
194
195
          </div>

        </div><!-- /.modal-content -->
Chris Rebert's avatar
Chris Rebert committed
196
      </div><!-- /.modal-dialog -->
Mark Otto's avatar
Mark Otto committed
197
198
    </div><!-- /.modal -->

Mark Otto's avatar
Mark Otto committed
199
    <div class="bs-example" style="padding-bottom: 24px;">
200
201
202
      <button class="btn btn-primary btn-lg" data-toggle="modal" data-target="#myModal">
        Launch demo modal
      </button>
Mark Otto's avatar
Mark Otto committed
203
204
    </div><!-- /example -->
{% highlight html %}
205
206
207
208
209
210
211
212
213
214
215
<!-- Button trigger modal -->
<button class="btn btn-primary btn-lg" data-toggle="modal" data-target="#myModal">
  Launch demo modal
</button>

<!-- Modal -->
<div class="modal fade" id="myModal" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
216
        <h4 class="modal-title" id="myModalLabel">Modal title</h4>
217
218
219
220
221
222
223
224
      </div>
      <div class="modal-body">
        ...
      </div>
      <div class="modal-footer">
        <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
        <button type="button" class="btn btn-primary">Save changes</button>
      </div>
Mark Otto's avatar
Mark Otto committed
225
226
227
    </div>
  </div>
</div>
Mark Otto's avatar
Mark Otto committed
228
229
{% endhighlight %}

230
231
232

    <div class="bs-callout bs-callout-warning">
      <h4>Make modals accessible</h4>
233
234
      <p>Be sure to add <code>role="dialog"</code> to <code>.modal</code>, <code>aria-labelledby="myModalLabel"</code> attribute to reference the modal title, and <code>aria-hidden="true"</code> to tell assistive technologies to skip the modal's DOM elements.</p>
      <p>Additionally, you may give a description of your modal dialog with <code>aria-describedby</code> on <code>.modal</code>.</p>
235
236
    </div>

Mark Otto's avatar
Mark Otto committed
237
238
239
240
241
242
243
244
245
246
    <h2 id="modals-sizes">Optional sizes</h2>
    <p>Modals have two optional sizes, available via modifier classes to be placed on a <code>.modal-dialog</code>.</p>
    <div class="bs-example">
      <button class="btn btn-primary" data-toggle="modal" data-target=".bs-modal-lg">Large modal</button>
      <button class="btn btn-primary" data-toggle="modal" data-target=".bs-modal-sm">Small modal</button>
    </div>
{% highlight html %}
<!-- Large modal -->
<button class="btn btn-primary" data-toggle="modal" data-target=".bs-modal-lg">Large modal</button>

247
<div class="modal fade bs-modal-lg" tabindex="-1" role="dialog" aria-labelledby="myLargeModalLabel" aria-hidden="true">
Mark Otto's avatar
Mark Otto committed
248
249
250
251
252
253
254
255
256
257
  <div class="modal-dialog modal-lg">
    <div class="modal-content">
      ...
    </div>
  </div>
</div>

<!-- Small modal -->
<button class="btn btn-primary" data-toggle="modal" data-target=".bs-modal-sm">Small modal</button>

258
<div class="modal fade bs-modal-sm" tabindex="-1" role="dialog" aria-labelledby="mySmallModalLabel" aria-hidden="true">
Mark Otto's avatar
Mark Otto committed
259
260
261
262
263
264
265
266
267
  <div class="modal-dialog modal-sm">
    <div class="modal-content">
      ...
    </div>
  </div>
</div>
{% endhighlight %}

    <!--  Modal content for the above example -->
268
    <div class="modal fade bs-modal-lg" tabindex="-1" role="dialog" aria-labelledby="myLargeModalLabel" aria-hidden="true">
Mark Otto's avatar
Mark Otto committed
269
270
271
272
273
      <div class="modal-dialog modal-lg">
        <div class="modal-content">

          <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
274
            <h4 class="modal-title" id="myLargeModalLabel">Large modal</h4>
Mark Otto's avatar
Mark Otto committed
275
276
277
278
279
280
281
          </div>
          <div class="modal-body">
            ...
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div><!-- /.modal -->
282
    <div class="modal fade bs-modal-sm" tabindex="-1" role="dialog" aria-labelledby="mySmallModalLabel" aria-hidden="true">
Mark Otto's avatar
Mark Otto committed
283
284
285
286
287
      <div class="modal-dialog modal-sm">
        <div class="modal-content">

          <div class="modal-header">
            <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
288
            <h4 class="modal-title" id="mySmallModalLabel">Small modal</h4>
Mark Otto's avatar
Mark Otto committed
289
290
291
292
293
294
295
296
297
          </div>
          <div class="modal-body">
            ...
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div><!-- /.modal -->


Mark Otto's avatar
Mark Otto committed
298
    <h2 id="modals-usage">Usage</h2>
299
    <p>The modal plugin toggles your hidden content on demand, via data attributes or JavaScript. It also adds <code>.modal-open</code> to the <code>&lt;body&gt;</code> to override default scrolling behavior and generates a <code>.modal-backdrop</code> to provide a click area for dismissing shown modals when clicking outside the modal.</p>
Mark Otto's avatar
Mark Otto committed
300
301
302
303
304
305
306
307
308
309
310
311
312

    <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>
{% highlight html %}
<button type="button" data-toggle="modal" data-target="#myModal">Launch modal</button>
{% endhighlight %}

    <h3>Via JavaScript</h3>
    <p>Call a modal with id <code>myModal</code> with a single line of JavaScript:</p>
    {% highlight js %}$('#myModal').modal(options){% endhighlight %}

    <h3>Options</h3>
    <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>
313
    <div class="table-responsive">
314
315
316
317
318
319
320
321
322
323
324
325
      <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>
Chris Rebert's avatar
Chris Rebert committed
326
           <td>boolean or the string <code>'static'</code></td>
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
           <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>
346
           <td><p>If a remote URL is provided, <strong>content will be loaded one time</strong> via jQuery's <code>load</code> method and injected into the root of the modal element. If you're using the data-api, you may alternatively use the <code>href</code> attribute to specify the remote source. An example of this is shown below:</p>
Mark Otto's avatar
Mark Otto committed
347
348
349
{% highlight html %}
<a data-toggle="modal" href="remote.html" data-target="#modal">Click me</a>
{% endhighlight %}
wangsai's avatar
wangsai committed
350
           </td>
351
352
353
         </tr>
        </tbody>
      </table>
354
    </div><!-- /.table-responsive -->
Mark Otto's avatar
Mark Otto committed
355
356
357
358
359
360
361
362
363
364
365
366

    <h3>Methods</h3>

    <h4>.modal(options)</h4>
    <p>Activates your content as a modal. Accepts an optional options <code>object</code>.</p>
{% highlight js %}
$('#myModal').modal({
  keyboard: false
})
{% endhighlight %}

    <h4>.modal('toggle')</h4>
367
    <p>Manually toggles a modal. <strong>Returns to the caller before the modal has actually been shown or hidden</strong> (i.e. before the <code>shown.bs.modal</code> or <code>hidden.bs.modal</code> event occurs).</p>
Mark Otto's avatar
Mark Otto committed
368
369
370
    {% highlight js %}$('#myModal').modal('toggle'){% endhighlight %}

    <h4>.modal('show')</h4>
371
    <p>Manually opens a modal. <strong>Returns to the caller before the modal has actually been shown</strong> (i.e. before the <code>shown.bs.modal</code> event occurs).</p>
Mark Otto's avatar
Mark Otto committed
372
373
374
    {% highlight js %}$('#myModal').modal('show'){% endhighlight %}

    <h4>.modal('hide')</h4>
375
    <p>Manually hides a modal. <strong>Returns to the caller before the modal has actually been hidden</strong> (i.e. before the <code>hidden.bs.modal</code> event occurs).</p>
Mark Otto's avatar
Mark Otto committed
376
377
378
379
    {% highlight js %}$('#myModal').modal('hide'){% endhighlight %}

    <h3>Events</h3>
    <p>Bootstrap's modal class exposes a few events for hooking into modal functionality.</p>
380
    <div class="table-responsive">
381
382
383
384
385
386
387
388
389
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 150px;">Event Type</th>
           <th>Description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
390
           <td>show.bs.modal</td>
391
           <td>This event fires immediately when the <code>show</code> instance method is called. If caused by a click, the clicked element is available as the <code>relatedTarget</code> property of the event.</td>
392
393
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
394
           <td>shown.bs.modal</td>
395
           <td>This event is fired when the modal has been made visible to the user (will wait for CSS transitions to complete). If caused by a click, the clicked element is available as the <code>relatedTarget</code> property of the event.</td>
396
397
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
398
           <td>hide.bs.modal</td>
399
400
401
           <td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
402
           <td>hidden.bs.modal</td>
403
404
           <td>This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).</td>
         </tr>
405
406
407
408
         <tr>
           <td>loaded.bs.modal</td>
           <td>This event is fired when the modal has loaded content using the remote option.</td>
         </tr>
409
410
        </tbody>
      </table>
411
    </div><!-- /.table-responsive -->
Mark Otto's avatar
Mark Otto committed
412
{% highlight js %}
413
414
$('#myModal').on('hidden.bs.modal', function (e) {
  // do something...
Mark Otto's avatar
Mark Otto committed
415
416
417
418
419
420
})
{% endhighlight %}
  </div>



421
422
423
424
425
426
  <!-- Dropdowns
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="dropdowns">Dropdowns <small>dropdown.js</small></h1>
    </div>
Mark Otto's avatar
Mark Otto committed
427

428
429
430
431
432
    <h2 id="dropdowns-examples">Examples</h2>
    <p>Add dropdown menus to nearly anything with this simple plugin, including the navbar, tabs, and pills.</p>

    <h3>Within a navbar</h3>
    <div class="bs-example">
433
      <nav id="navbar-example" class="navbar navbar-default navbar-static" role="navigation">
434
        <div class="navbar-header">
435
          <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-js-navbar-collapse">
436
            <span class="sr-only">Toggle navigation</span>
437
438
439
440
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
441
442
          <a class="navbar-brand" href="#">Project Name</a>
        </div>
443
        <div class="collapse navbar-collapse bs-js-navbar-collapse">
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
          <ul class="nav navbar-nav">
            <li class="dropdown">
              <a id="drop1" href="#" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
              <ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Action</a></li>
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Another action</a></li>
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Something else here</a></li>
                <li role="presentation" class="divider"></li>
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Separated link</a></li>
              </ul>
            </li>
            <li class="dropdown">
              <a href="#" id="drop2" role="button" class="dropdown-toggle" data-toggle="dropdown">Dropdown 2 <b class="caret"></b></a>
              <ul class="dropdown-menu" role="menu" aria-labelledby="drop2">
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Action</a></li>
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Another action</a></li>
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Something else here</a></li>
                <li role="presentation" class="divider"></li>
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Separated link</a></li>
              </ul>
            </li>
          </ul>
466
          <ul class="nav navbar-nav navbar-right">
467
468
469
470
471
472
473
474
475
476
477
478
            <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">
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Action</a></li>
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Another action</a></li>
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Something else here</a></li>
                <li role="presentation" class="divider"></li>
                <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Separated link</a></li>
              </ul>
            </li>
          </ul>
        </div><!-- /.nav-collapse -->
479
      </nav> <!-- /navbar-example -->
480
481
    </div> <!-- /example -->

482
    <h3>Within pills</h3>
483
484
485
486
    <div class="bs-example">
      <ul class="nav nav-pills">
        <li class="active"><a href="#">Regular link</a></li>
        <li class="dropdown">
487
          <a id="drop4" role="button" data-toggle="dropdown" href="#">Dropdown <b class="caret"></b></a>
488
489
490
491
492
493
494
495
496
          <ul id="menu1" class="dropdown-menu" role="menu" aria-labelledby="drop4">
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Action</a></li>
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Another action</a></li>
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Something else here</a></li>
            <li role="presentation" class="divider"></li>
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Separated link</a></li>
          </ul>
        </li>
        <li class="dropdown">
497
          <a id="drop5" role="button" data-toggle="dropdown" href="#">Dropdown 2 <b class="caret"></b></a>
498
499
500
501
502
503
504
505
506
          <ul id="menu2" class="dropdown-menu" role="menu" aria-labelledby="drop5">
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Action</a></li>
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Another action</a></li>
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Something else here</a></li>
            <li role="presentation" class="divider"></li>
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Separated link</a></li>
          </ul>
        </li>
        <li class="dropdown">
507
          <a id="drop6" role="button" data-toggle="dropdown" href="#">Dropdown 3 <b class="caret"></b></a>
508
509
510
511
512
513
514
515
          <ul id="menu3" class="dropdown-menu" role="menu" aria-labelledby="drop6">
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Action</a></li>
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Another action</a></li>
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Something else here</a></li>
            <li role="presentation" class="divider"></li>
            <li role="presentation"><a role="menuitem" tabindex="-1" href="http://twitter.com/fat">Separated link</a></li>
          </ul>
        </li>
516
      </ul> <!-- /pills -->
517
    </div> <!-- /example -->
Mark Otto's avatar
Mark Otto committed
518
519


520
    <h2 id="dropdowns-usage">Usage</h2>
521
    <p>Via data attributes or JavaScript, the dropdown plugin toggles hidden content (dropdown menus) by toggling the <code>.open</code> class on the parent list item. When opened, the plugin also adds <code>.dropdown-backdrop</code> as a click area for closing dropdown menus when clicking outside the menu. Note: The <code>data-toggle=dropdown</code> attribute is relied on for closing dropdown menus at an application level, so it's a good idea to always use it.</p>
Mark Otto's avatar
Mark Otto committed
522

523
524
    <h3>Via data attributes</h3>
    <p>Add <code>data-toggle="dropdown"</code> to a link or button to toggle a dropdown.</p>
Mark Otto's avatar
Mark Otto committed
525
526
{% highlight html %}
<div class="dropdown">
527
  <a data-toggle="dropdown" href="#">Dropdown trigger</a>
Mark Otto's avatar
Mark Otto committed
528
529
530
531
532
533
534
535
  <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel">
    ...
  </ul>
</div>
{% endhighlight %}
          <p>To keep URLs intact, use the <code>data-target</code> attribute instead of <code>href="#"</code>.</p>
{% highlight html %}
<div class="dropdown">
536
  <a id="dLabel" role="button" data-toggle="dropdown" data-target="#" href="/page.html">
Mark Otto's avatar
Mark Otto committed
537
538
    Dropdown <span class="caret"></span>
  </a>
539
540


Mark Otto's avatar
Mark Otto committed
541
542
543
544
545
546
  <ul class="dropdown-menu" role="menu" aria-labelledby="dLabel">
    ...
  </ul>
</div>
{% endhighlight %}

547
548
    <h3>Via JavaScript</h3>
    <p>Call the dropdowns via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
549
550
551
552
{% highlight js %}
$('.dropdown-toggle').dropdown()
{% endhighlight %}

553
554
    <h3>Options</h3>
    <p><em>None</em></p>
Mark Otto's avatar
Mark Otto committed
555

556
557
    <h3>Methods</h3>
    <h4>$().dropdown('toggle')</h4>
558
    <p>Toggles the dropdown menu of a given navbar or tabbed navigation.</p>
Mark Otto's avatar
Mark Otto committed
559

560
    <h3>Events</h3>
561
    <div class="table-responsive">
562
563
564
565
566
567
568
569
570
571
      <table class="table table-bordered table-striped">
        <thead>
          <tr>
            <th style="width: 150px;">Event Type</th>
            <th>Description</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td>show.bs.dropdown</td>
572
            <td>This event fires immediately when the show instance method is called. The toggling anchor element is available as the <code>relatedTarget</code> property of the event.</td>
573
574
575
          </tr>
          <tr>
            <td>shown.bs.dropdown</td>
576
            <td>This event is fired when the dropdown has been made visible to the user (will wait for CSS transitions, to complete).  The toggling anchor element is available as the <code>relatedTarget</code> property of the event.</td>
577
578
579
          </tr>
          <tr>
            <td>hide.bs.dropdown</td>
580
            <td>This event is fired immediately when the hide instance method has been called. The toggling anchor element is available as the <code>relatedTarget</code> property of the event.</td>
581
582
583
          </tr>
          <tr>
            <td>hidden.bs.dropdown</td>
584
            <td>This event is fired when the dropdown has finished being hidden from the user (will wait for CSS transitions, to complete). The toggling anchor element is available as the <code>relatedTarget</code> property of the event.</td>
585
586
587
          </tr>
        </tbody>
      </table>
588
    </div><!-- ./bs-table-responsive -->
589
590
591
592
593
594
{% highlight js %}
$('#myDropdown').on('show.bs.dropdown', function () {
  // do something…
})
{% endhighlight %}
  </div>
Mark Otto's avatar
Mark Otto committed
595

596

597
598
599
600
601
602
  <!-- ScrollSpy
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="scrollspy">ScrollSpy <small>scrollspy.js</small></h1>
    </div>
Mark Otto's avatar
Mark Otto committed
603
604


605
606
607
    <h2 id="scrollspy-examples">Example in navbar</h2>
    <p>The ScrollSpy plugin is for automatically updating nav targets based on scroll position. Scroll the area below the navbar and watch the active class change. The dropdown sub items will be highlighted as well.</p>
    <div class="bs-example">
608
      <nav id="navbar-example2" class="navbar navbar-default navbar-static" role="navigation">
609
        <div class="navbar-header">
610
611
612
613
614
615
          <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-js-navbar-scrollspy">
            <span class="sr-only">Toggle navigation</span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
616
617
          <a class="navbar-brand" href="#">Project Name</a>
        </div>
618
619
620
621
622
        <div class="collapse navbar-collapse bs-js-navbar-scrollspy">
          <ul class="nav navbar-nav">
            <li><a href="#fat">@fat</a></li>
            <li><a href="#mdo">@mdo</a></li>
            <li class="dropdown">
fat's avatar
fat committed
623
624
              <a href="#" id="navbarDrop1" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
              <ul class="dropdown-menu" role="menu" aria-labelledby="navbarDrop1">
fat's avatar
fat committed
625
626
                <li><a href="#one" tabindex="-1">one</a></li>
                <li><a href="#two" tabindex="-1">two</a></li>
627
                <li class="divider"></li>
fat's avatar
fat committed
628
                <li><a href="#three" tabindex="-1">three</a></li>
629
630
631
632
              </ul>
            </li>
          </ul>
        </div>
633
      </nav>
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
      <div data-spy="scroll" data-target="#navbar-example2" 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 -->
Mark Otto's avatar
Mark Otto committed
649
650


651
    <h2 id="scrollspy-usage">Usage</h2>
Mark Otto's avatar
Mark Otto committed
652

653
    <h3>Via data attributes</h3>
wangsai's avatar
wangsai committed
654
    <p>To easily add scrollspy behavior to your topbar navigation, add <code>data-spy="scroll"</code> to the element you want to spy on (most typically this would be the <code>&lt;body&gt;</code>). Then add the <code>data-target</code> attribute with the ID or class of the parent element of any Bootstrap <code>.nav</code> component.</p>
Mark Otto's avatar
Mark Otto committed
655
{% highlight html %}
656
657
658
659
660
661
662
<body data-spy="scroll" data-target=".navbar-example">
  ...
  <div class="navbar-example">
    <ul class="nav nav-tabs">
      ...
    </ul>
  </div>
Mark Otto's avatar
Mark Otto committed
663
664
665
666
  ...
</body>
{% endhighlight %}

667
668
    <h3>Via JavaScript</h3>
    <p>Call the scrollspy via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
669
{% highlight js %}
670
$('body').scrollspy({ target: '.navbar-example' })
Mark Otto's avatar
Mark Otto committed
671
672
{% endhighlight %}

673
674
675
676
    <div class="bs-callout bs-callout-danger">
      <h4>Resolvable ID targets required</h4>
      <p>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>.</p>
    </div>
Mark Otto's avatar
Mark Otto committed
677

678
679
680
    <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>
Mark Otto's avatar
Mark Otto committed
681
682
683
{% highlight js %}
$('[data-spy="scroll"]').each(function () {
  var $spy = $(this).scrollspy('refresh')
Chris Rebert's avatar
Chris Rebert committed
684
})
Mark Otto's avatar
Mark Otto committed
685
686
687
{% endhighlight %}


688
689
    <h3>Options</h3>
    <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>
690
    <div class="table-responsive">
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
      <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>
709
    </div><!-- ./bs-table-responsive -->
710
711

    <h3>Events</h3>
712
    <div class="table-responsive">
713
714
715
716
717
718
719
720
721
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 150px;">Event Type</th>
           <th>Description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
722
           <td>activate.bs.scrollspy</td>
723
724
725
726
           <td>This event fires whenever a new item becomes activated by the scrollspy.</td>
        </tr>
        </tbody>
      </table>
727
    </div><!-- ./bs-table-responsive -->
fat's avatar
fat committed
728
729
730
731
732
{% highlight js %}
$('#myScrollspy').on('activate.bs.scrollspy', function () {
  // do something…
})
{% endhighlight %}
733
  </div>
Mark Otto's avatar
Mark Otto committed
734
735
736



737
738
739
740
741
742
  <!-- Tabs
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="tabs">Togglable tabs <small>tab.js</small></h1>
    </div>
Mark Otto's avatar
Mark Otto committed
743

744
745
746
747
748
749
750
    <h2 id="tabs-examples">Example tabs</h2>
    <p>Add quick, dynamic tab functionality to transition through panes of local content, even via dropdown menus.</p>
    <div class="bs-example bs-example-tabs">
      <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">
fat's avatar
fat committed
751
752
          <a href="#" id="myTabDrop1" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
          <ul class="dropdown-menu" role="menu" aria-labelledby="myTabDrop1">
fat's avatar
fat committed
753
754
            <li><a href="#dropdown1" tabindex="-1" data-toggle="tab">@fat</a></li>
            <li><a href="#dropdown2" tabindex="-1" data-toggle="tab">@mdo</a></li>
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
          </ul>
        </li>
      </ul>
      <div id="myTabContent" class="tab-content">
        <div class="tab-pane fade in active" id="home">
          <p>Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.</p>
        </div>
        <div class="tab-pane fade" id="profile">
          <p>Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid. Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero sint qui sapiente accusamus tattooed echo park.</p>
        </div>
        <div class="tab-pane fade" id="dropdown1">
          <p>Etsy mixtape wayfarers, ethical wes anderson tofu before they sold out mcsweeney's organic lomo retro fanny pack lo-fi farm-to-table readymade. Messenger bag gentrify pitchfork tattooed craft beer, iphone skateboard locavore carles etsy salvia banksy hoodie helvetica. DIY synth PBR banksy irony. Leggings gentrify squid 8-bit cred pitchfork. Williamsburg banh mi whatever gluten-free, carles pitchfork biodiesel fixie etsy retro mlkshk vice blog. Scenester cred you probably haven't heard of them, vinyl craft beer blog stumptown. Pitchfork sustainable tofu synth chambray yr.</p>
        </div>
        <div class="tab-pane fade" id="dropdown2">
          <p>Trust fund seitan letterpress, keytar raw denim keffiyeh etsy art party before they sold out master cleanse gluten-free squid scenester freegan cosby sweater. Fanny pack portland seitan DIY, art party locavore wolf cliche high life echo park Austin. Cred vinyl keffiyeh DIY salvia PBR, banh mi before they sold out farm-to-table VHS viral locavore cosby sweater. Lomo wolf viral, mustache readymade thundercats keffiyeh craft beer marfa ethical. Wolf salvia freegan, sartorial keffiyeh echo park vegan.</p>
        </div>
      </div>
    </div><!-- /example -->
Mark Otto's avatar
Mark Otto committed
773

774
775
776
777
778
    <div class="bs-callout bs-callout-info">
      <h4>Extends tabbed navigation</h4>
      <p>This plugin extends the <a href="../components/#nav-tabs">tabbed navigation component</a> to add tabbable areas.</p>
    </div>

Mark Otto's avatar
Mark Otto committed
779

780
781
    <h2 id="tabs-usage">Usage</h2>
    <p>Enable tabbable tabs via JavaScript (each tab needs to be activated individually):</p>
Mark Otto's avatar
Mark Otto committed
782
783
{% highlight js %}
$('#myTab a').click(function (e) {
784
785
  e.preventDefault()
  $(this).tab('show')
Mark Otto's avatar
Mark Otto committed
786
787
788
789
790
})
{% endhighlight %}

          <p>You can activate individual tabs in several ways:</p>
{% highlight js %}
791
792
793
794
$('#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)
Mark Otto's avatar
Mark Otto committed
795
796
{% endhighlight %}

797
    <h3>Markup</h3>
Quy Ton's avatar
Quy Ton committed
798
    <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 <a href="../components/#nav-tabs">tab styling</a>, while adding the <code>nav</code> and <code>nav-pills</code> classes will apply <a href="../components/#nav-pills">pill styling</a>.</p>
Mark Otto's avatar
Mark Otto committed
799
{% highlight html %}
800
<!-- Nav tabs -->
Mark Otto's avatar
Mark Otto committed
801
802
803
804
805
806
<ul class="nav nav-tabs">
  <li><a href="#home" data-toggle="tab">Home</a></li>
  <li><a href="#profile" data-toggle="tab">Profile</a></li>
  <li><a href="#messages" data-toggle="tab">Messages</a></li>
  <li><a href="#settings" data-toggle="tab">Settings</a></li>
</ul>
807
808
809
810
811
812
813
814

<!-- Tab panes -->
<div class="tab-content">
  <div class="tab-pane active" id="home">...</div>
  <div class="tab-pane" id="profile">...</div>
  <div class="tab-pane" id="messages">...</div>
  <div class="tab-pane" id="settings">...</div>
</div>
Mark Otto's avatar
Mark Otto committed
815
816
{% endhighlight %}

817
818
819
820
821
822
823
824
825
826
    <h3>Fade effect</h3>
    <p>To make tabs fade in, add <code>.fade</code> to each <code>.tab-pane</code>. The first tab pane must also have <code>.in</code> to properly fade in initial content.</p>
{% highlight html %}
<div class="tab-content">
  <div class="tab-pane fade in active" id="home">...</div>
  <div class="tab-pane fade" id="profile">...</div>
  <div class="tab-pane fade" id="messages">...</div>
  <div class="tab-pane fade" id="settings">...</div>
</div>
{% endhighlight %}
Mark Otto's avatar
Mark Otto committed
827

828
829
830
831
832
    <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>
Mark Otto's avatar
Mark Otto committed
833
834
{% highlight html %}
<ul class="nav nav-tabs" id="myTab">
Chris Rebert's avatar
Chris Rebert committed
835
836
837
838
  <li class="active"><a href="#home" data-toggle="tab">Home</a></li>
  <li><a href="#profile" data-toggle="tab">Profile</a></li>
  <li><a href="#messages" data-toggle="tab">Messages</a></li>
  <li><a href="#settings" data-toggle="tab">Settings</a></li>
Mark Otto's avatar
Mark Otto committed
839
840
841
842
843
844
845
846
847
848
849
</ul>

<div class="tab-content">
  <div class="tab-pane active" id="home">...</div>
  <div class="tab-pane" id="profile">...</div>
  <div class="tab-pane" id="messages">...</div>
  <div class="tab-pane" id="settings">...</div>
</div>

<script>
  $(function () {
Chris Rebert's avatar
Chris Rebert committed
850
    $('#myTab a:last').tab('show')
Mark Otto's avatar
Mark Otto committed
851
852
853
854
  })
</script>
{% endhighlight %}

855
    <h3>Events</h3>
856
    <div class="table-responsive">
857
858
859
860
861
862
863
864
865
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 150px;">Event Type</th>
           <th>Description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
866
           <td>show.bs.tab</td>
867
868
869
           <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>
Jacob Thornton's avatar
Jacob Thornton committed
870
           <td>shown.bs.tab</td>
871
872
873
874
           <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>
875
    </div><!-- /.table-responsive -->
Mark Otto's avatar
Mark Otto committed
876
{% highlight js %}
fat's avatar
fat committed
877
$('a[data-toggle="tab"]').on('shown.bs.tab', function (e) {
Mark Otto's avatar
Mark Otto committed
878
879
880
881
  e.target // activated tab
  e.relatedTarget // previous tab
})
{% endhighlight %}
882
  </div>
Mark Otto's avatar
Mark Otto committed
883
884
885



886
887
888
889
890
891
  <!-- Tooltips
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="tooltips">Tooltips <small>tooltip.js</small></h1>
    </div>
Mark Otto's avatar
Mark Otto committed
892

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

901
902
903
    <h3>Four directions</h3>
    <div class="bs-example tooltip-demo">
      <div class="bs-example-tooltips">
904
        <button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</button>
905
906
        <button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="top" title="Tooltip on top">Tooltip on top</button>
        <button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">Tooltip on bottom</button>
907
        <button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</button>
908
909
      </div>
    </div><!-- /example -->
Mark Otto's avatar
Mark Otto committed
910
911
{% highlight html %}
<button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</button>
912

Mark Otto's avatar
Mark Otto committed
913
<button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="top" title="Tooltip on top">Tooltip on top</button>
914

Mark Otto's avatar
Mark Otto committed
915
<button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">Tooltip on bottom</button>
916

Mark Otto's avatar
Mark Otto committed
917
918
<button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</button>
{% endhighlight %}
919

920
921
    <div class="bs-callout bs-callout-danger">
      <h4>Opt-in functionality</h4>
Julian Thilo's avatar
Julian Thilo committed
922
      <p>For performance reasons, the Tooltip and Popover data-apis are opt-in, meaning <strong>you must initialize them yourself</strong>.</p>
923
    </div>
924
925
926
927
    <div class="bs-callout bs-callout-info">
      <h4>Tooltips in button groups and input groups require special setting</h4>
      <p>When using tooltips on elements within a <code>.btn-group</code> or an <code>.input-group</code>, you'll have to specify the option <code>container: 'body'</code> (documented below) to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the tooltip is triggered).</p>
    </div>
928
    <div class="bs-callout bs-callout-info">
Chris Rebert's avatar
Chris Rebert committed
929
      <h4>Tooltips on disabled elements require wrapper elements</h4>
930
      <p>To add a tooltip to a <code>disabled</code> or <code>.disabled</code> element, put the element inside of a <code>&lt;div&gt;</code> and apply the tooltip to that <code>&lt;div&gt;</code> instead.</p>
931
    </div>
Mark Otto's avatar
Mark Otto committed
932

933
    <h2 id="tooltips-usage">Usage</h2>
934
    <p>The tooltip plugin generates content and markup on demand, and by default places tooltips after their trigger element.</p>
935
    <p>Trigger the tooltip via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
936
937
{% highlight js %}
$('#example').tooltip(options)
938
939
940
{% endhighlight %}

    <h3>Markup</h3>
Mark Otto's avatar
Mark Otto committed
941
942
943
944
945
    <p>The required markup for a tooltip is only a <code>data</code> attribute and <code>title</code> on the HTML element you wish to have a tooltip. The generated markup of a tooltip is rather simple, though it does require a position (by default, set to <code>top</code> by the plugin).</p>
    <div class="bs-callout bs-callout-warning">
      <h4>Multiple-line links</h4>
      <p>Sometimes you want to add a tooltip to a hyperlink that wraps multiple lines. The default behavior of the tooltip plugin is to center it horizontally and vertically. Add <code>white-space: nowrap;</code> to your anchors to avoid this.</p>
    </div>
946
{% highlight html linenos %}
Mark Otto's avatar
Mark Otto committed
947
948
949
950
951
<!-- HTML to write -->
<a href="#" data-toggle="tooltip" title="first tooltip">Hover over me</a>

<!-- Generated markup by the plugin -->
<div class="tooltip top">
952
953
954
955
956
  <div class="tooltip-inner">
    Tooltip!
  </div>
  <div class="tooltip-arrow"></div>
</div>
Mark Otto's avatar
Mark Otto committed
957
958
{% endhighlight %}

959
960
    <h3>Options</h3>
    <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>
961
    <div class="table-responsive">
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
      <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>false</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>
988
           <td>how to position the tooltip - top | bottom | left | right | auto. <br> When "auto" is specified, it will dynamically reorient the tooltip. For example, if placement is "auto left", the tooltip will display to the left when possible, otherwise it will display right.</td>
989
990
991
992
993
994
995
996
997
998
999
         </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>
Oliver Schmidt's avatar
Oliver Schmidt committed
1000
           <td>default title value if <code>title</code> attribute isn't present</td>
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
         </tr>
         <tr>
           <td>trigger</td>
           <td>string</td>
           <td>'hover focus'</td>
           <td>how tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.</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>
         <tr>
           <td>container</td>
           <td>string | false</td>
           <td>false</td>
           <td>
            <p>Appends the tooltip to a specific element. Example: <code>container: 'body'</code></p>
           </td>
         </tr>
        </tbody>
      </table>
1028
    </div><!-- /.table-responsive -->
1029
1030
1031
1032
    <div class="bs-callout bs-callout-info">
      <h4>Data attributes for individual tooltips</h4>
      <p>Options for individual tooltips can alternatively be specified through the use of data attributes, as explained above.</p>
    </div>
Mark Otto's avatar
Mark Otto committed
1033

1034
1035
1036
1037
    <h3>Methods</h3>

    <h4>$().tooltip(options)</h4>
    <p>Attaches a tooltip handler to an element collection.</p>
Mark Otto's avatar
Mark Otto committed
1038

1039
1040
1041
    <h4>.tooltip('show')</h4>
    <p>Reveals an element's tooltip.</p>
    {% highlight js %}$('#element').tooltip('show'){% endhighlight %}
Mark Otto's avatar
Mark Otto committed
1042

1043
1044
1045
    <h4>.tooltip('hide')</h4>
    <p>Hides an element's tooltip.</p>
    {% highlight js %}$('#element').tooltip('hide'){% endhighlight %}
Mark Otto's avatar
Mark Otto committed
1046

1047
1048
1049
1050
1051
1052
1053
    <h4>.tooltip('toggle')</h4>
    <p>Toggles an element's tooltip.</p>
    {% highlight js %}$('#element').tooltip('toggle'){% endhighlight %}

    <h4>.tooltip('destroy')</h4>
    <p>Hides and destroys an element's tooltip.</p>
    {% highlight js %}$('#element').tooltip('destroy'){% endhighlight %}
Mark Otto's avatar
Mark Otto committed
1054

1055
    <h3>Events</h3>
1056
    <div class="table-responsive">
1057
1058
1059
1060
1061
1062
1063
1064
1065
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 150px;">Event Type</th>
           <th>Description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1066
           <td>show.bs.tooltip</td>
1067
1068
1069
           <td>This event fires immediately when the <code>show</code> instance method is called.</td>
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1070
           <td>shown.bs.tooltip</td>
1071
1072
1073
           <td>This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete).</td>
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1074
           <td>hide.bs.tooltip</td>
1075
1076
1077
           <td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1078
           <td>hidden.bs.tooltip</td>
1079
1080
1081
1082
           <td>This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete).</td>
         </tr>
        </tbody>
      </table>
1083
    </div><!-- /.table-responsive -->
1084
1085
{% highlight js %}
$('#myTooltip').on('hidden.bs.tooltip', function () {
ggam's avatar
ggam committed
1086
  // do something…
1087
1088
})
{% endhighlight %}
1089
  </div>
Mark Otto's avatar
Mark Otto committed
1090

1091
1092
1093
1094
1095
1096
1097
1098
  <!-- Popovers
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="popovers">Popovers <small>popover.js</small></h1>
    </div>

    <h2 id="popovers-examples">Examples</h2>
fat's avatar
fat committed
1099
    <p>Add small overlays of content, like those on the iPad, to any element for housing secondary information.</p>
Mark Otto's avatar
Mark Otto committed
1100

1101
1102
1103
1104
    <div class="bs-callout bs-callout-danger">
      <h4>Plugin dependency</h4>
      <p>Popovers require the <a href="#tooltips">tooltip plugin</a> to be included in your version of Bootstrap.</p>
    </div>
1105
1106
    <div class="bs-callout bs-callout-danger">
      <h4>Opt-in functionality</h4>
Julian Thilo's avatar
Julian Thilo committed
1107
      <p>For performance reasons, the Tooltip and Popover data-apis are opt-in, meaning <strong>you must initialize them yourself</strong>.</p>
1108
    </div>
1109
1110
1111
1112
    <div class="bs-callout bs-callout-info">
      <h4>Popovers in button groups and input groups require special setting</h4>
      <p>When using popovers on elements within a <code>.btn-group</code> or an <code>.input-group</code>, you'll have to specify the option <code>container: 'body'</code> (documented below) to avoid unwanted side effects (such as the element growing wider and/or losing its rounded corners when the popover is triggered).</p>
    </div>
1113
1114
    <div class="bs-callout bs-callout-info">
      <h4>Popovers on disabled elements require wrapper elements</h4>
1115
      <p>To add a popover to a <code>disabled</code> or <code>.disabled</code> element, put the element inside of a <code>&lt;div&gt;</code> and apply the popover to that <code>&lt;div&gt;</code> instead.</p>
1116
    </div>
Mark Otto's avatar
Mark Otto committed
1117

1118
1119
1120
1121
1122
1123
1124
1125
    <h3>Static popover</h3>
    <p>Four options are available: top, right, bottom, and left aligned.</p>
    <div class="bs-example bs-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>
Mark Otto's avatar
Mark Otto committed
1126
        </div>
1127
      </div>
Mark Otto's avatar
Mark Otto committed
1128

1129
1130
1131
1132
1133
1134
1135
      <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>
Mark Otto's avatar
Mark Otto committed
1136

1137
1138
1139
      <div class="popover bottom">
        <div class="arrow"></div>
        <h3 class="popover-title">Popover bottom</h3>
1140

1141
1142
        <div class="popover-content">
          <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
Mark Otto's avatar
Mark Otto committed
1143
        </div>
1144
1145
1146
1147
1148
1149
1150
      </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>
Chris Rebert's avatar
Chris Rebert committed
1151
        </div>
1152
      </div>
Mark Otto's avatar
Mark Otto committed
1153

1154
1155
      <div class="clearfix"></div>
    </div>
Mark Otto's avatar
Mark Otto committed
1156

1157
1158
    <h3>Live demo</h3>
    <div class="bs-example" style="padding-bottom: 24px;">
1159
      <a href="#" class="btn btn-lg btn-danger" data-toggle="popover" title="A Title" data-content="And here's some amazing content. It's very engaging. right?" role="button">Click to toggle popover</a>
1160
    </div>
Mark Otto's avatar
Mark Otto committed
1161

1162
1163
    <h4>Four directions</h4>
    <div class="bs-example tooltip-demo">
1164
      <div class="bs-example-tooltips">
1165
        <button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="left" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
1166
1167
          Popover on left
        </button>
1168
        <button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="top" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
1169
1170
          Popover on top
        </button>
1171
        <button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="bottom" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
1172
1173
          Popover on bottom
        </button>
1174
        <button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="right" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
1175
          Popover on right
1176
1177
        </button>
      </div>
1178
    </div><!-- /example -->
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
{% highlight html %}
<button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="left" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
  Popover on left
</button>

<button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="top" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
  Popover on top
</button>

<button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="bottom" data-content="Vivamus
sagittis lacus vel augue laoreet rutrum faucibus.">
  Popover on bottom
</button>

<button type="button" class="btn btn-default" data-container="body" data-toggle="popover" data-placement="right" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
  Popover on right
</button>
{% endhighlight %}

    <div class="bs-callout bs-callout-warning">
      <h4>Multiple-line links</h4>
1200
      <p>Sometimes you want to add a popover to a hyperlink that wraps multiple lines. The default behavior of the popover plugin is to center it horizontally and vertically. Add <code>white-space: nowrap;</code> to your anchors to avoid this.</p>
1201
    </div>
Mark Otto's avatar
Mark Otto committed
1202
1203


1204
1205
1206
    <h2 id="popovers-usage">Usage</h2>
    <p>Enable popovers via JavaScript:</p>
    {% highlight js %}$('#example').popover(options){% endhighlight %}
Mark Otto's avatar
Mark Otto committed
1207

1208
1209
    <h3>Options</h3>
    <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>
1210
    <div class="table-responsive">
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
      <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>
kostyatretyak's avatar
kostyatretyak committed
1225
            <td>apply a CSS fade transition to the popover</td>
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
          </tr>
          <tr>
            <td>html</td>
            <td>boolean</td>
            <td>false</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>
1237
            <td>how to position the popover - top | bottom | left | right | auto.<br> When "auto" is specified, it will dynamically reorient the popover. For example, if placement is "auto left", the popover will display to the left when possible, otherwise it will display right.</td>
1238
1239
1240
1241
1242
          </tr>
          <tr>
            <td>selector</td>
            <td>string</td>
            <td>false</td>
1243
            <td>if a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See <a href="https://github.com/twbs/bootstrap/issues/4215">this</a> and <a href="http://jsfiddle.net/fScua/">an informative example</a>.</td>
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
          </tr>
          <tr>
            <td>trigger</td>
            <td>string</td>
            <td>'click'</td>
            <td>how popover is triggered - click | hover | focus | manual</td>
          </tr>
          <tr>
            <td>title</td>
            <td>string | function</td>
            <td>''</td>
            <td>default title value if <code>title</code> attribute isn't present</td>
          </tr>
          <tr>
            <td>content</td>
            <td>string | function</td>
            <td>''</td>
            <td>default content value if <code>data-content</code> 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>
          <tr>
            <td>container</td>
            <td>string | false</td>
            <td>false</td>
            <td>
Chris Rebert's avatar
Chris Rebert committed
1278
             <p>Appends the popover to a specific element. Example: <code>container: 'body'</code>. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.</p>
1279
1280
1281
1282
            </td>
          </tr>
        </tbody>
      </table>
1283
    </div><!-- /.table-responsive -->
1284
1285
1286
1287
    <div class="bs-callout bs-callout-info">
      <h4>Data attributes for individual popovers</h4>
      <p>Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.</p>
    </div>
Mark Otto's avatar
Mark Otto committed
1288

1289
1290
1291
    <h3>Methods</h3>
    <h4>$().popover(options)</h4>
    <p>Initializes popovers for an element collection.</p>
Mark Otto's avatar
Mark Otto committed
1292

1293
1294
1295
    <h4>.popover('show')</h4>
    <p>Reveals an elements popover.</p>
    {% highlight js %}$('#element').popover('show'){% endhighlight %}
Mark Otto's avatar
Mark Otto committed
1296

1297
1298
1299
    <h4>.popover('hide')</h4>
    <p>Hides an elements popover.</p>
    {% highlight js %}$('#element').popover('hide'){% endhighlight %}
Mark Otto's avatar
Mark Otto committed
1300

1301
1302
1303
    <h4>.popover('toggle')</h4>
    <p>Toggles an elements popover.</p>
    {% highlight js %}$('#element').popover('toggle'){% endhighlight %}
Mark Otto's avatar
Mark Otto committed
1304

1305
1306
1307
    <h4>.popover('destroy')</h4>
    <p>Hides and destroys an element's popover.</p>
    {% highlight js %}$('#element').popover('destroy'){% endhighlight %}
1308
    <h3>Events</h3>
1309
    <div class="table-responsive">
1310
1311
1312
1313
1314
1315
1316
1317
1318
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 150px;">Event Type</th>
           <th>Description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1319
           <td>show.bs.popover</td>
1320
1321
1322
           <td>This event fires immediately when the <code>show</code> instance method is called.</td>
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1323
           <td>shown.bs.popover</td>
1324
1325
1326
           <td>This event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).</td>
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1327
           <td>hide.bs.popover</td>
1328
1329
1330
           <td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1331
           <td>hidden.bs.popover</td>
1332
1333
1334
1335
           <td>This event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete).</td>
         </tr>
        </tbody>
      </table>
1336
    </div><!-- /.table-responsive -->
1337
1338
1339
1340
1341
{% highlight js %}
$('#myPopover').on('hidden.bs.popover', function () {
  // do something…
})
{% endhighlight %}
1342
  </div>
Mark Otto's avatar
Mark Otto committed
1343

1344
1345
1346
1347
1348
1349
  <!-- Alert
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="alerts">Alert messages <small>alert.js</small></h1>
    </div>
Mark Otto's avatar
Mark Otto committed
1350
1351


1352
1353
1354
    <h2 id="alerts-examples">Example alerts</h2>
    <p>Add dismiss functionality to all alert messages with this plugin.</p>
    <div class="bs-example">
1355
      <div class="alert alert-warning fade in">
1356
        <button type="button" class="close" data-dismiss="alert" aria-hidden="true">&times;</button>
1357
1358
1359
        <strong>Holy guacamole!</strong> Best check yo self, you're not looking too good.
      </div>
    </div><!-- /example -->
Mark Otto's avatar
Mark Otto committed
1360

1361
    <div class="bs-example">
1362
      <div class="alert alert-danger fade in">
1363
        <button type="button" class="close" data-dismiss="alert" aria-hidden="true">&times;</button>
1364
1365
1366
        <h4>Oh snap! You got an error!</h4>
        <p>Change this and that and try again. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum.</p>
        <p>
Mark Otto's avatar
Mark Otto committed
1367
1368
          <button type="button" class="btn btn-danger">Take this action</button>
          <button type="button" class="btn btn-default">Or do this</button>
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
        </p>
      </div>
    </div><!-- /example -->


    <h2 id="alerts-usage">Usage</h2>
    <p>Enable dismissal of an alert via JavaScript:</p>
    {% highlight js %}$(".alert").alert(){% endhighlight %}

    <h3>Markup</h3>
    <p>Just add <code>data-dismiss="alert"</code> to your close button to automatically give an alert close functionality.</p>
1380
    {% highlight html %}<a class="close" data-dismiss="alert" href="#" aria-hidden="true">&times;</a>{% endhighlight %}
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393

    <h3>Methods</h3>

    <h4>$().alert()</h4>
    <p>Wraps all alerts with close functionality. To have your alerts animate out when closed, make sure they have the <code>.fade</code> and <code>.in</code> class already applied to them.</p>

    <h4>.alert('close')</h4>
    <p>Closes an alert.</p>
    {% highlight js %}$(".alert").alert('close'){% endhighlight %}


    <h3>Events</h3>
    <p>Bootstrap's alert class exposes a few events for hooking into alert functionality.</p>
1394
    <div class="table-responsive">
1395
1396
1397
1398
1399
1400
1401
1402
1403
      <table class="table table-bordered table-striped">
        <thead>
          <tr>
            <th style="width: 150px;">Event Type</th>
            <th>Description</th>
          </tr>
        </thead>
        <tbody>
          <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1404
            <td>close.bs.alert</td>
1405
1406
1407
            <td>This event fires immediately when the <code>close</code> instance method is called.</td>
          </tr>
          <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1408
            <td>closed.bs.alert</td>
1409
1410
1411
1412
            <td>This event is fired when the alert has been closed (will wait for CSS transitions to complete).</td>
          </tr>
        </tbody>
      </table>
1413
    </div><!-- /.table-responsive -->
Mark Otto's avatar
Mark Otto committed
1414
{% highlight js %}
fat's avatar
fat committed
1415
$('#my-alert').bind('closed.bs.alert', function () {
Mark Otto's avatar
Mark Otto committed
1416
1417
1418
  // do something…
})
{% endhighlight %}
1419
  </div>
Mark Otto's avatar
Mark Otto committed
1420
1421
1422



1423
1424
1425
1426
1427
1428
  <!-- Buttons
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="buttons">Buttons <small>button.js</small></h1>
    </div>
Mark Otto's avatar
Mark Otto committed
1429

1430
1431
    <h2 id="buttons-examples">Example uses</h2>
    <p>Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p>
Mark Otto's avatar
Mark Otto committed
1432

1433
1434
1435
    <h4>Stateful</h4>
    <p>Add <code>data-loading-text="Loading..."</code> to use a loading state on a button.</p>
    <div class="bs-example" style="padding-bottom: 24px;">
1436
      <button type="button" id="loading-example-btn" data-loading-text="Loading..." class="btn btn-primary">
1437
1438
1439
        Loading state
      </button>
    </div><!-- /example -->
Mark Otto's avatar
Mark Otto committed
1440
{% highlight html %}
1441
<button type="button" id="loading-example-btn" data-loading-text="Loading..." class="btn btn-primary">
Mark Otto's avatar
Mark Otto committed
1442
1443
  Loading state
</button>
1444
1445
1446
1447
1448
1449
1450
1451
1452
<script>
  $('#loading-example-btn').click(function () {
    var btn = $(this);
    btn.button('loading');
    $.ajax(...).always(function () {
      btn.button('reset');
    });
  });
</script>
Mark Otto's avatar
Mark Otto committed
1453
1454
{% endhighlight %}

1455
1456
1457
1458
1459
    <h4>Single toggle</h4>
    <p>Add <code>data-toggle="button"</code> to activate toggling on a single button.</p>
    <div class="bs-example" style="padding-bottom: 24px;">
      <button type="button" class="btn btn-primary" data-toggle="button">Single toggle</button>
    </div><!-- /example -->
Mark Otto's avatar
Mark Otto committed
1460
1461
1462
1463
{% highlight html %}
<button type="button" class="btn btn-primary" data-toggle="button">Single toggle</button>
{% endhighlight %}

1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
    <h4>Checkbox</h4>
    <p>Add <code>data-toggle="buttons"</code> to a group of checkboxes for checkbox style toggling on btn-group.</p>
    <div class="bs-example" style="padding-bottom: 24px;">
      <div class="btn-group" data-toggle="buttons">
        <label class="btn btn-primary">
          <input type="checkbox"> Option 1
        </label>
        <label class="btn btn-primary">
          <input type="checkbox"> Option 2
        </label>
        <label class="btn btn-primary">
          <input type="checkbox"> Option 3
        </label>
      </div>
    </div><!-- /example -->
Mark Otto's avatar
Mark Otto committed
1479
{% highlight html %}
1480
<div class="btn-group" data-toggle="buttons">
Mark Otto's avatar
Mark Otto committed
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
  <label class="btn btn-primary">
    <input type="checkbox"> Option 1
  </label>
  <label class="btn btn-primary">
    <input type="checkbox"> Option 2
  </label>
  <label class="btn btn-primary">
    <input type="checkbox"> Option 3
  </label>
</div>
{% endhighlight %}

1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
    <h4>Radio</h4>
    <p>Add <code>data-toggle="buttons"</code> to a group of radio inputs for radio style toggling on btn-group.</p>
    <div class="bs-example" style="padding-bottom: 24px;">
      <div class="btn-group" data-toggle="buttons">
        <label class="btn btn-primary">
          <input type="radio" name="options" id="option1"> Option 1
        </label>
        <label class="btn btn-primary">
          <input type="radio" name="options" id="option2"> Option 2
        </label>
        <label class="btn btn-primary">
          <input type="radio" name="options" id="option3"> Option 3
        </label>
      </div>
    </div><!-- /example -->
Mark Otto's avatar
Mark Otto committed
1508
{% highlight html %}
1509
<div class="btn-group" data-toggle="buttons">
Mark Otto's avatar
Mark Otto committed
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
  <label class="btn btn-primary">
    <input type="radio" name="options" id="option1"> Option 1
  </label>
  <label class="btn btn-primary">
    <input type="radio" name="options" id="option2"> Option 2
  </label>
  <label class="btn btn-primary">
    <input type="radio" name="options" id="option3"> Option 3
  </label>
</div>
{% endhighlight %}


1523
1524
    <h2 id="buttons-usage">Usage</h2>
    <p>Enable buttons via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
1525
{% highlight js %}
1526
$('.btn').button()
Mark Otto's avatar
Mark Otto committed
1527
1528
{% endhighlight %}

1529
1530
    <h3>Markup</h3>
    <p>Data attributes are integral to the button plugin. Check out the example code below for the various markup types.</p>
Mark Otto's avatar
Mark Otto committed
1531

1532
1533
    <h3>Options</h3>
    <p><em>None</em></p>
Mark Otto's avatar
Mark Otto committed
1534

1535
    <h3>Methods</h3>
Mark Otto's avatar
Mark Otto committed
1536

1537
1538
1539
1540
1541
1542
    <h4>$().button('toggle')</h4>
    <p>Toggles push state. Gives the button the appearance that it has been activated.</p>
    <div class="bs-callout bs-callout-info">
      <h4>Auto toggling</h4>
      <p>You can enable auto toggling of a button by using the <code>data-toggle</code> attribute.</p>
    </div>
Mark Otto's avatar
Mark Otto committed
1543
{% highlight html %}
1544
<button type="button" class="btn btn-primary" data-toggle="button">...</button>
Mark Otto's avatar
Mark Otto committed
1545
1546
{% endhighlight %}

1547
1548
1549
    <h4>$().button('loading')</h4>
    <p>Sets button state to loading - disables button and swaps text to loading text. Loading text should be defined on the button element using the data attribute <code>data-loading-text</code>.
    </p>
Mark Otto's avatar
Mark Otto committed
1550
{% highlight html %}
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
<button id="loading-example-btn" type="button" class="btn btn-primary" data-loading-text="loading stuff...">...</button>
<script>
  $('#loading-example-btn').click(function () {
    var btn = $(this);
    btn.button('loading');
    $.ajax(...).always(function () {
      btn.button('reset');
    });
  });
</script>
Mark Otto's avatar
Mark Otto committed
1561
1562
{% endhighlight %}

1563
1564
1565
1566
    <div class="bs-callout bs-callout-danger">
      <h4>Cross-browser compatibility</h4>
      <p><a href="https://github.com/twbs/bootstrap/issues/793">Firefox persists the disabled state across page loads</a>. A workaround for this is to use <code>autocomplete="off"</code>.</p>
    </div>
Mark Otto's avatar
Mark Otto committed
1567

1568
1569
    <h4>$().button('reset')</h4>
    <p>Resets button state - swaps text to original text.</p>
Mark Otto's avatar
Mark Otto committed
1570

1571
1572
    <h4>$().button(string)</h4>
    <p>Resets button state - swaps text to any data defined text state.</p>
Mark Otto's avatar
Mark Otto committed
1573
{% highlight html %}
1574
<button type="button" class="btn btn-primary" data-complete-text="finished!" >...</button>
Mark Otto's avatar
Mark Otto committed
1575
1576
1577
1578
<script>
  $('.btn').button('complete')
</script>
{% endhighlight %}
1579
  </div>
Mark Otto's avatar
Mark Otto committed
1580
1581
1582



1583
1584
1585
1586
1587
1588
  <!-- Collapse
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="collapse">Collapse <small>collapse.js</small></h1>
    </div>
Mark Otto's avatar
Mark Otto committed
1589

1590
1591
    <h3>About</h3>
    <p>Get base styles and flexible support for collapsible components like accordions and navigation.</p>
Mark Otto's avatar
Mark Otto committed
1592

1593
1594
1595
1596
1597
1598
    <div class="bs-callout bs-callout-danger">
      <h4>Plugin dependency</h4>
      <p>Collapse requires the <a href="#transitions">transitions plugin</a> to be included in your version of Bootstrap.</p>
    </div>

    <h2 id="collapse-examples">Example accordion</h2>
Mark Otto's avatar
copy    
Mark Otto committed
1599
    <p>Using the collapse plugin, we built a simple accordion by extending the panel component.</p>
Mark Otto's avatar
Mark Otto committed
1600

1601
    <div class="bs-example">
Mark Otto's avatar
Mark Otto committed
1602
      <div class="panel-group" id="accordion">
Mark Otto's avatar
Mark Otto committed
1603
        <div class="panel panel-default">
Mark Otto's avatar
Mark Otto committed
1604
          <div class="panel-heading">
1605
            <h4 class="panel-title">
1606
              <a data-toggle="collapse" data-parent="#accordion" href="#collapseOne">
Mark Otto's avatar
Mark Otto committed
1607
1608
                Collapsible Group Item #1
              </a>
1609
            </h4>
1610
          </div>
Mark Otto's avatar
Mark Otto committed
1611
1612
          <div id="collapseOne" class="panel-collapse collapse in">
            <div class="panel-body">
1613
1614
1615
1616
              Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
            </div>
          </div>
        </div>
Mark Otto's avatar
Mark Otto committed
1617
        <div class="panel panel-default">
Mark Otto's avatar
Mark Otto committed
1618
          <div class="panel-heading">
1619
            <h4 class="panel-title">
1620
              <a data-toggle="collapse" data-parent="#accordion" href="#collapseTwo">
Mark Otto's avatar
Mark Otto committed
1621
1622
                Collapsible Group Item #2
              </a>
1623
            </h4>
1624
          </div>
Mark Otto's avatar
Mark Otto committed
1625
1626
          <div id="collapseTwo" class="panel-collapse collapse">
            <div class="panel-body">
1627
1628
1629
1630
              Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
            </div>
          </div>
        </div>
Mark Otto's avatar
Mark Otto committed
1631
        <div class="panel panel-default">
Mark Otto's avatar
Mark Otto committed
1632
          <div class="panel-heading">
1633
            <h4 class="panel-title">
1634
              <a data-toggle="collapse" data-parent="#accordion" href="#collapseThree">
Mark Otto's avatar
Mark Otto committed
1635
1636
                Collapsible Group Item #3
              </a>
1637
            </h4>
1638
          </div>
Mark Otto's avatar
Mark Otto committed
1639
1640
          <div id="collapseThree" class="panel-collapse collapse">
            <div class="panel-body">
1641
1642
1643
1644
1645
1646
              Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
            </div>
          </div>
        </div>
      </div>
    </div><!-- /example -->
Mark Otto's avatar
Mark Otto committed
1647
{% highlight html %}
Mark Otto's avatar
Mark Otto committed
1648
<div class="panel-group" id="accordion">
Mark Otto's avatar
Mark Otto committed
1649
  <div class="panel panel-default">
Mark Otto's avatar
Mark Otto committed
1650
    <div class="panel-heading">
1651
      <h4 class="panel-title">
1652
        <a data-toggle="collapse" data-parent="#accordion" href="#collapseOne">
Mark Otto's avatar
Mark Otto committed
1653
1654
          Collapsible Group Item #1
        </a>
1655
      </h4>
Mark Otto's avatar
Mark Otto committed
1656
    </div>
Mark Otto's avatar
Mark Otto committed
1657
1658
1659
    <div id="collapseOne" class="panel-collapse collapse in">
      <div class="panel-body">
        Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
Mark Otto's avatar
Mark Otto committed
1660
1661
1662
      </div>
    </div>
  </div>
Mark Otto's avatar
Mark Otto committed
1663
  <div class="panel panel-default">
Mark Otto's avatar
Mark Otto committed
1664
    <div class="panel-heading">
1665
      <h4 class="panel-title">
1666
        <a data-toggle="collapse" data-parent="#accordion" href="#collapseTwo">
Mark Otto's avatar
Mark Otto committed
1667
1668
          Collapsible Group Item #2
        </a>
1669
      </h4>
Mark Otto's avatar
Mark Otto committed
1670
    </div>
Mark Otto's avatar
Mark Otto committed
1671
1672
1673
    <div id="collapseTwo" class="panel-collapse collapse">
      <div class="panel-body">
        Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
Mark Otto's avatar
Mark Otto committed
1674
1675
1676
      </div>
    </div>
  </div>
Mark Otto's avatar
Mark Otto committed
1677
  <div class="panel panel-default">
Mark Otto's avatar
Mark Otto committed
1678
    <div class="panel-heading">
1679
      <h4 class="panel-title">
1680
        <a data-toggle="collapse" data-parent="#accordion" href="#collapseThree">
Mark Otto's avatar
Mark Otto committed
1681
1682
          Collapsible Group Item #3
        </a>
1683
      </h4>
Mark Otto's avatar
Mark Otto committed
1684
    </div>
Mark Otto's avatar
Mark Otto committed
1685
1686
1687
    <div id="collapseThree" class="panel-collapse collapse">
      <div class="panel-body">
        Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
Mark Otto's avatar
Mark Otto committed
1688
1689
1690
1691
1692
1693
      </div>
    </div>
  </div>
</div>
{% endhighlight %}

1694
    <p>You can also use the plugin without the accordion markup. Make a button toggle the expanding and collapsing of another element.</p>
Mark Otto's avatar
Mark Otto committed
1695
1696
1697
1698
1699
1700
1701
1702
1703
{% highlight html %}
<button type="button" class="btn btn-danger" data-toggle="collapse" data-target="#demo">
  simple collapsible
</button>

<div id="demo" class="collapse in">...</div>
{% endhighlight %}


1704
    <h2 id="collapse-usage">Usage</h2>
1705
1706
1707
1708
1709
1710
1711
    <p>The collapse plugin utilizes a few classes to handle the heavy lifting:</p>
    <ul>
      <li><code>.collapse</code> hides the content</li>
      <li><code>.collapse.in</code> shows the content</li>
      <li><code>.collapsing</code> is added when the transition starts, and removed when it finishes</li>
    </ul>
    <p>These classes can be found in <code>component-animations.less</code>.</p>
Mark Otto's avatar
Mark Otto committed
1712

1713
1714
1715
    <h3>Via data attributes</h3>
    <p>Just add <code>data-toggle="collapse"</code> and a <code>data-target</code> to element to automatically assign control of a collapsible element. The <code>data-target</code> attribute accepts a CSS selector to apply the collapse to. Be sure to add the class <code>collapse</code> to the collapsible element. If you'd like it to default open, add the additional class <code>in</code>.</p>
    <p>To add accordion-like group management to a collapsible control, add the data attribute <code>data-parent="#selector"</code>. Refer to the demo to see this in action.</p>
Mark Otto's avatar
Mark Otto committed
1716

1717
1718
    <h3>Via JavaScript</h3>
    <p>Enable manually with:</p>
Mark Otto's avatar
Mark Otto committed
1719
{% highlight js %}
1720
$('.collapse').collapse()
Mark Otto's avatar
Mark Otto committed
1721
1722
{% endhighlight %}

1723
1724
    <h3>Options</h3>
    <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-parent=""</code>.</p>
1725
    <div class="table-responsive">
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
      <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>parent</td>
           <td>selector</td>
           <td>false</td>
fat's avatar
fat committed
1740
           <td>If selector then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior - this dependent on the <code>panel</code> class)</td>
1741
1742
1743
1744
1745
1746
1747
1748
1749
         </tr>
         <tr>
           <td>toggle</td>
           <td>boolean</td>
           <td>true</td>
           <td>Toggles the collapsible element on invocation</td>
         </tr>
        </tbody>
      </table>
1750
    </div><!-- /.table-responsive -->
1751
1752
1753
1754
1755

    <h3>Methods</h3>

    <h4>.collapse(options)</h4>
    <p>Activates your content as a collapsible element. Accepts an optional options <code>object</code>.
Mark Otto's avatar
Mark Otto committed
1756
1757
1758
1759
1760
1761
{% highlight js %}
$('#myCollapsible').collapse({
  toggle: false
})
{% endhighlight %}

1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
    <h4>.collapse('toggle')</h4>
    <p>Toggles a collapsible element to shown or hidden.</p>

    <h4>.collapse('show')</h4>
    <p>Shows a collapsible element.</p>

    <h4>.collapse('hide')</h4>
    <p>Hides a collapsible element.</p>

    <h3>Events</h3>
    <p>Bootstrap's collapse class exposes a few events for hooking into collapse functionality.</p>
1773
    <div class="table-responsive">
1774
1775
1776
1777
1778
1779
1780
1781
1782
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 150px;">Event Type</th>
           <th>Description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1783
           <td>show.bs.collapse</td>
1784
1785
1786
           <td>This event fires immediately when the <code>show</code> instance method is called.</td>
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1787
           <td>shown.bs.collapse</td>
1788
1789
1790
           <td>This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).</td>
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1791
           <td>hide.bs.collapse</td>
1792
1793
1794
1795
1796
           <td>
            This event is fired immediately when the <code>hide</code> method has been called.
           </td>
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
1797
           <td>hidden.bs.collapse</td>
1798
1799
1800
1801
           <td>This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).</td>
         </tr>
        </tbody>
      </table>
1802
    </div><!-- /.table-responsive -->
Mark Otto's avatar
Mark Otto committed
1803
{% highlight js %}
fat's avatar
fat committed
1804
$('#myCollapsible').on('hidden.bs.collapse', function () {
Mark Otto's avatar
Mark Otto committed
1805
1806
1807
  // do something…
})
{% endhighlight %}
1808
  </div>
Mark Otto's avatar
Mark Otto committed
1809
1810
1811



1812
1813
1814
1815
1816
1817
  <!-- Carousel
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="carousel">Carousel <small>carousel.js</small></h1>
    </div>
Mark Otto's avatar
Mark Otto committed
1818

1819
1820
1821
    <h2 id="carousel-examples">Examples</h2>
    <p>The slideshow below shows a generic plugin and component for cycling through elements like a carousel.</p>
    <div class="bs-example">
1822
      <div id="carousel-example-generic" class="carousel slide" data-ride="carousel">
1823
1824
1825
1826
1827
1828
1829
        <ol class="carousel-indicators">
          <li data-target="#carousel-example-generic" data-slide-to="0" class="active"></li>
          <li data-target="#carousel-example-generic" data-slide-to="1"></li>
          <li data-target="#carousel-example-generic" data-slide-to="2"></li>
        </ol>
        <div class="carousel-inner">
          <div class="item active">
1830
            <img data-src="holder.js/900x500/auto/#777:#555/text:First slide" alt="First slide">
1831
1832
          </div>
          <div class="item">
1833
            <img data-src="holder.js/900x500/auto/#666:#444/text:Second slide" alt="Second slide">
1834
1835
          </div>
          <div class="item">
1836
            <img data-src="holder.js/900x500/auto/#555:#333/text:Third slide" alt="Third slide">
1837
1838
1839
          </div>
        </div>
        <a class="left carousel-control" href="#carousel-example-generic" data-slide="prev">
1840
          <span class="glyphicon glyphicon-chevron-left"></span>
1841
1842
        </a>
        <a class="right carousel-control" href="#carousel-example-generic" data-slide="next">
1843
          <span class="glyphicon glyphicon-chevron-right"></span>
1844
1845
1846
        </a>
      </div>
    </div><!-- /example -->
Mark Otto's avatar
Mark Otto committed
1847
{% highlight html %}
1848
<div id="carousel-example-generic" class="carousel slide" data-ride="carousel">
Mark Otto's avatar
Mark Otto committed
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
  <!-- Indicators -->
  <ol class="carousel-indicators">
    <li data-target="#carousel-example-generic" data-slide-to="0" class="active"></li>
    <li data-target="#carousel-example-generic" data-slide-to="1"></li>
    <li data-target="#carousel-example-generic" data-slide-to="2"></li>
  </ol>

  <!-- Wrapper for slides -->
  <div class="carousel-inner">
    <div class="item active">
Chris Rebert's avatar
Chris Rebert committed
1859
      <img src="..." alt="...">
Mark Otto's avatar
Mark Otto committed
1860
1861
1862
1863
1864
1865
1866
1867
1868
      <div class="carousel-caption">
        ...
      </div>
    </div>
    ...
  </div>

  <!-- Controls -->
  <a class="left carousel-control" href="#carousel-example-generic" data-slide="prev">
1869
    <span class="glyphicon glyphicon-chevron-left"></span>
Mark Otto's avatar
Mark Otto committed
1870
1871
  </a>
  <a class="right carousel-control" href="#carousel-example-generic" data-slide="next">
1872
    <span class="glyphicon glyphicon-chevron-right"></span>
Mark Otto's avatar
Mark Otto committed
1873
1874
1875
  </a>
</div>
{% endhighlight %}
1876
1877
1878
1879
<div class="bs-callout bs-callout-warning" id="callout-carousel-transitions">
  <h4>Transition animations not supported in Internet Explorer 8 &amp; 9</h4>
  <p>Bootstrap exclusively uses CSS3 for its animations, but Internet Explorer 8 &amp; 9 don't support the necessary CSS properties. Thus, there are no slide transition animations when using these browsers. We have intentionally decided not to include jQuery-based fallbacks for the transitions.</p>
</div>
Mark Otto's avatar
Mark Otto committed
1880

1881
1882
1883
    <h3>Optional captions</h3>
    <p>Add captions to your slides easily with the <code>.carousel-caption</code> element within any <code>.item</code>. Place just about any optional HTML within there and it will be automatically aligned and formatted.</p>
    <div class="bs-example">
1884
      <div id="carousel-example-captions" class="carousel slide" data-ride="carousel">
1885
1886
1887
1888
1889
1890
1891
        <ol class="carousel-indicators">
          <li data-target="#carousel-example-captions" data-slide-to="0" class="active"></li>
          <li data-target="#carousel-example-captions" data-slide-to="1"></li>
          <li data-target="#carousel-example-captions" data-slide-to="2"></li>
        </ol>
        <div class="carousel-inner">
          <div class="item active">
1892
            <img data-src="holder.js/900x500/auto/#777:#777" alt="First slide image">
1893
1894
1895
1896
1897
1898
            <div class="carousel-caption">
              <h3>First slide label</h3>
              <p>Nulla vitae elit libero, a pharetra augue mollis interdum.</p>
            </div>
          </div>
          <div class="item">
1899
            <img data-src="holder.js/900x500/auto/#666:#666" alt="Second slide image">
1900
1901
1902
1903
1904
1905
            <div class="carousel-caption">
              <h3>Second slide label</h3>
              <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
            </div>
          </div>
          <div class="item">
1906
            <img data-src="holder.js/900x500/auto/#555:#5555" alt="Third slide image">
1907
1908
1909
1910
1911
1912
1913
            <div class="carousel-caption">
              <h3>Third slide label</h3>
              <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur.</p>
            </div>
          </div>
        </div>
        <a class="left carousel-control" href="#carousel-example-captions" data-slide="prev">
1914
          <span class="glyphicon glyphicon-chevron-left"></span>
1915
1916
        </a>
        <a class="right carousel-control" href="#carousel-example-captions" data-slide="next">
1917
          <span class="glyphicon glyphicon-chevron-right"></span>
1918
1919
1920
        </a>
      </div>
    </div><!-- /example -->
Mark Otto's avatar
Mark Otto committed
1921
1922
{% highlight html %}
<div class="item active">
1923
  <img src="..." alt="...">
Mark Otto's avatar
Mark Otto committed
1924
1925
1926
1927
1928
1929
1930
  <div class="carousel-caption">
    <h3>...</h3>
    <p>...</p>
  </div>
</div>
{% endhighlight %}

1931
1932
1933
1934
<div class="bs-callout bs-callout-danger">
  <h4>Accessibility issue</h4>
  <p>The carousel component is generally not compliant with accessibility standards. If you need to be compliant, please consider other options for presenting your content.</p>
</div>
Mark Otto's avatar
Mark Otto committed
1935

1936
    <h2 id="carousel-usage">Usage</h2>
Mark Otto's avatar
Mark Otto committed
1937

1938
1939
    <h3>Via data attributes</h3>
    <p>Use data attributes to easily control the position of the carousel. <code>data-slide</code> accepts the keywords <code>prev</code> or <code>next</code>, which alters the slide position relative to its current position. Alternatively, use <code>data-slide-to</code> to pass a raw slide index to the carousel <code>data-slide-to="2"</code>, which shifts the slide position to a particular index beginning with <code>0</code>.</p>
1940
    <p>The <code>data-ride="carousel"</code> attribute is used to mark a carousel as animating starting at page load.</p>
Mark Otto's avatar
Mark Otto committed
1941

1942
1943
    <h3>Via JavaScript</h3>
    <p>Call carousel manually with:</p>
Mark Otto's avatar
Mark Otto committed
1944
1945
1946
1947
{% highlight js %}
$('.carousel').carousel()
{% endhighlight %}

1948
1949
    <h3>Options</h3>
    <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-interval=""</code>.</p>
1950
    <div class="table-responsive">
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
      <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>interval</td>
           <td>number</td>
           <td>5000</td>
           <td>The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.</td>
         </tr>
         <tr>
           <td>pause</td>
           <td>string</td>
           <td>"hover"</td>
           <td>Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.</td>
         </tr>
Jacob Thornton's avatar
Jacob Thornton committed
1973
1974
1975
1976
1977
1978
         <tr>
           <td>wrap</td>
           <td>boolean</td>
           <td>true</td>
           <td>Whether the carousel should cycle continuously or have hard stops.</td>
         </tr>
1979
1980
        </tbody>
      </table>
1981
    </div><!-- /.table-responsive -->
1982
1983
1984
1985
1986

    <h3>Methods</h3>

    <h4>.carousel(options)</h4>
    <p>Initializes the carousel with an optional options <code>object</code> and starts cycling through items.</p>
saiwang's avatar
saiwang committed
1987
{% highlight js %}
Mark Otto's avatar
Mark Otto committed
1988
1989
1990
1991
1992
$('.carousel').carousel({
  interval: 2000
})
{% endhighlight %}

1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
    <h4>.carousel('cycle')</h4>
    <p>Cycles through the carousel items from left to right.</p>

    <h4>.carousel('pause')</h4>
    <p>Stops the carousel from cycling through items.</p>


    <h4>.carousel(number)</h4>
    <p>Cycles the carousel to a particular frame (0 based, similar to an array).</p>

    <h4>.carousel('prev')</h4>
    <p>Cycles to the previous item.</p>

    <h4>.carousel('next')</h4>
    <p>Cycles to the next item.</p>

    <h3>Events</h3>
    <p>Bootstrap's carousel class exposes two events for hooking into carousel functionality.</p>
2011
    <div class="table-responsive">
2012
2013
2014
2015
2016
2017
2018
2019
2020
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 150px;">Event Type</th>
           <th>Description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
2021
           <td>slide.bs.carousel</td>
2022
2023
2024
           <td>This event fires immediately when the <code>slide</code> instance method is invoked.</td>
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
2025
           <td>slid.bs.carousel</td>
2026
2027
2028
2029
           <td>This event is fired when the carousel has completed its slide transition.</td>
         </tr>
        </tbody>
      </table>
2030
    </div><!-- /.table-responsive -->
2031
{% highlight js %}
fat's avatar
fat committed
2032
2033
2034
2035
$('#myCarousel').on('slide.bs.carousel', function () {
  // do something…
})
{% endhighlight %}
2036
  </div>
Mark Otto's avatar
Mark Otto committed
2037
2038
2039



2040
2041
2042
2043
2044
2045
  <!-- Affix
  ================================================== -->
  <div class="bs-docs-section">
    <div class="page-header">
      <h1 id="affix">Affix <small>affix.js</small></h1>
    </div>
Mark Otto's avatar
Mark Otto committed
2046

2047
2048
    <h2 id="affix-examples">Example</h2>
    <p>The subnavigation on the left is a live demo of the affix plugin.</p>
Mark Otto's avatar
Mark Otto committed
2049

2050
    <hr class="bs-docs-separator">
Mark Otto's avatar
Mark Otto committed
2051

2052
    <h2 id="affix-usage">Usage</h2>
2053
2054
2055
2056
2057
2058
    <p>Use the affix plugin via data attributes or manually with your own JavaScript. <strong>In both situations, you must provide CSS for the positioning of your content.</strong></p>

    <h3>Positioning via CSS</h3>
    <p>The affix plugin toggles between three classes, each representing a particular state: <code>.affix</code>, <code>.affix-top</code>, and <code>.affix-bottom</code>. You must provide the styles for these classes yourself (independent of this plugin) to handle the actual positions.</p>
    <p>Here's how the affix plugin works:</p>
    <ol>
Chris Rebert's avatar
Chris Rebert committed
2059
      <li>To start, the plugin adds <code>.affix-top</code> to indicate the element is in its top-most position. At this point no CSS positioning is required.</li>
2060
      <li>Scrolling past the element you want affixed should trigger the actual affixing. This is where <code>.affix</code> replaces <code>.affix-top</code> and sets <code>position: fixed;</code> (provided by Bootstrap's code CSS).</li>
kostyatretyak's avatar
kostyatretyak committed
2061
      <li>If a bottom offset is defined, scrolling past that should replace <code>.affix</code> with <code>.affix-bottom</code>. Since offsets are optional, setting one requires you to set the appropriate CSS. In this case, add <code>position: absolute;</code> when necessary. The plugin uses the data attribute or JavaScript option to determine where to position the element from there.</li>
2062
2063
    </ol>
    <p>Follow the above steps to set your CSS for either of the usage options below.</p>
Mark Otto's avatar
Mark Otto committed
2064

2065
    <h3>Via data attributes</h3>
2066
    <p>To easily add affix behavior to any element, just add <code>data-spy="affix"</code> to the element you want to spy on. Use offsets to define when to toggle the pinning of an element.</p>
Mark Otto's avatar
Mark Otto committed
2067
2068

{% highlight html %}
2069
2070
2071
<div data-spy="affix" data-offset-top="60" data-offset-bottom="200">
  ...
</div>
Mark Otto's avatar
Mark Otto committed
2072
2073
{% endhighlight %}

2074
2075
    <h3>Via JavaScript</h3>
    <p>Call the affix plugin via JavaScript:</p>
Mark Otto's avatar
Mark Otto committed
2076
{% highlight js %}
fat's avatar
fat committed
2077
2078
2079
2080
2081
2082
2083
2084
  $('#myAffix').affix({
    offset: {
      top: 100
    , bottom: function () {
        return (this.bottom = $('.bs-footer').outerHeight(true))
      }
    }
  })
Mark Otto's avatar
Mark Otto committed
2085
2086
2087
{% endhighlight %}


2088
2089
2090
    <h3>Options</h3>
    <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-top="200"</code>.</p>

2091
    <div class="table-responsive">
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
      <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 | function | object</td>
           <td>10</td>
fat's avatar
fat committed
2106
           <td>Pixels to offset from screen when calculating position of scroll. If a single number is provided, the offset will be applied in both top and bottom directions. To provide a unique, bottom and top offset just provide an object <code>offset: { top: 10 }</code> or <code>offset: { top: 10, bottom: 5 }</code>. Use a function when you need to dynamically calculate an offset.</td>
2107
2108
2109
         </tr>
        </tbody>
      </table>
2110
    </div><!-- /.table-responsive -->
2111

fat's avatar
fat committed
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151

    <h3>Events</h3>
    <p>Bootstrap's affix class exposes a few events for hooking into affix functionality.</p>
    <div class="table-responsive">
      <table class="table table-bordered table-striped">
        <thead>
          <tr>
            <th style="width: 150px;">Event Type</th>
            <th>Description</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td>affix.bs.affix</td>
            <td>This event fires immediately before the element has been affixed.</td>
          </tr>
          <tr>
            <td>affixed.bs.affix</td>
            <td>This event is fired after the element has been affixed.</td>
          </tr>
          <tr>
            <td>affix-top.bs.affix</td>
            <td>This event fires immediately before the element has been affixed-top.</td>
          </tr>
          <tr>
            <td>affixed-top.bs.affix</td>
            <td>This event is fired after the element has been affixed-top.</td>
          </tr>
         <tr>
          <td>affix-bottom.bs.affix</td>
            <td>This event fires immediately before the element has been affixed-bottom.</td>
          </tr>
          <tr>
            <td>affixed-bottom.bs.affix</td>
            <td>This event is fired after the element has been affixed-bottom.</td>
          </tr>
        </tbody>
      </table>
    </div><!-- /.table-responsive -->

2152
  </div>