javascript.html 98.5 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
slug: js
lead: "Bring Bootstrap's components to life with over a dozen custom jQuery plugins. Easily include them all, or one by one."
Mark Otto's avatar
Mark Otto committed
6
base_url: "../"
Mark Otto's avatar
Mark Otto committed
7
8
9
10
11
---


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

    <h3 id="js-individual-compiled">Individual or compiled</h3>
18
    <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>
19
20
21
22
23
24
25

    <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
26
      <h4>Plugin dependencies</h4>
27
      <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
28
29
30
    </div>

    <h3 id="js-data-attrs">Data attributes</h3>
31
    <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
32

33
    <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
34
{% highlight js %}
Jacob Thornton's avatar
Jacob Thornton committed
35
$(document).off('.data-api')
Mark Otto's avatar
Mark Otto committed
36
37
38
39
{% 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
40
$(document).off('.alert.data-api')
Mark Otto's avatar
Mark Otto committed
41
42
43
44
45
{% 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 %}
46
$('.btn.danger').button('toggle').addClass('fat')
Mark Otto's avatar
Mark Otto committed
47
48
49
50
{% 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 %}
51
52
$('#myModal').modal()                      // initialized with defaults
$('#myModal').modal({ keyboard: false })   // initialized with no keyboard
53
$('#myModal').modal('show')                // initializes and invokes show immediately
Mark Otto's avatar
Mark Otto committed
54
55
{% endhighlight %}

56
    <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
57
58
59
60
61

    <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
62
$.fn.bootstrapBtn = bootstrapButton            // give $().bootstrapBtn the Bootstrap functionality
Mark Otto's avatar
Mark Otto committed
63
64
65
66
{% 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
67
    <p>As of 3.0.0, all Bootstrap events are namespaced.</p>
Mark Otto's avatar
Mark Otto committed
68
69
    <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
70
$('#myModal').on('show.bs.modal', function (e) {
Mark Otto's avatar
Mark Otto committed
71
72
73
  if (!data) return e.preventDefault() // stops modal from being shown
})
{% endhighlight %}
74

75
    <div class="bs-callout bs-callout-warning" id="callout-third-party-libs">
76
      <h4>Third-party libraries</h4>
Mark Otto's avatar
Mark Otto committed
77
      <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>
78
    </div>
Mark Otto's avatar
Mark Otto committed
79
80
81
82
83
84
  </div>



  <!-- Transitions
  ================================================== -->
fat's avatar
fat committed
85
  <div class="bs-docs-section">
Mark Otto's avatar
Mark Otto committed
86
    <div class="page-header">
fat's avatar
fat committed
87
      <h1 id="transitions">Transitions <small>transition.js</small></h1>
Mark Otto's avatar
Mark Otto committed
88
89
    </div>
    <h3>About transitions</h3>
Chris Rebert's avatar
Chris Rebert committed
90
    <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
91
    <h3>What's inside</h3>
92
    <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
93
94
95
96
97
98
  </div>



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

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

107
    <div class="bs-callout bs-callout-warning" id="callout-stacked-modals">
108
109
110
      <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>
111
112
    <div class="bs-callout bs-callout-warning">
      <h4>Mobile device caveats</h4>
Mark Otto's avatar
Mark Otto committed
113
      <p>There are some caveats regarding using modals on mobile devices. <a href="{{ page.base_url }}getting-started#fixed-position-keyboards">See our browser support docs</a> for details.</p>
114
    </div>
115

Mark Otto's avatar
Mark Otto committed
116
117
    <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
118
    <div class="bs-example bs-example-modal">
Mark Otto's avatar
Mark Otto committed
119
120
121
122
123
124
125
126
127
128
129
      <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">
130
131
              <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
132
133
            </div>
          </div><!-- /.modal-content -->
Chris Rebert's avatar
Chris Rebert committed
134
        </div><!-- /.modal-dialog -->
Mark Otto's avatar
Mark Otto committed
135
136
137
138
139
140
141
142
143
144
145
146
147
148
      </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">
149
150
        <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
151
152
      </div>
    </div><!-- /.modal-content -->
Chris Rebert's avatar
Chris Rebert committed
153
  </div><!-- /.modal-dialog -->
Mark Otto's avatar
Mark Otto committed
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
</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>
173
            <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
174
175
176
177
178
179

            <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
180
            <h4>Overflowing text to show scroll behavior</h4>
Mark Otto's avatar
Mark Otto committed
181
182
183
184
185
186
187
188
189
190
191
            <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">
192
193
            <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
194
195
196
          </div>

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

Mark Otto's avatar
Mark Otto committed
200
    <div class="bs-example" style="padding-bottom: 24px;">
201
202
203
      <button class="btn btn-primary btn-lg" data-toggle="modal" data-target="#myModal">
        Launch demo modal
      </button>
Mark Otto's avatar
Mark Otto committed
204
205
    </div><!-- /example -->
{% highlight html %}
206
207
208
209
210
211
212
213
214
215
216
<!-- 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>
217
        <h4 class="modal-title" id="myModalLabel">Modal title</h4>
218
219
220
221
222
223
224
225
      </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
226
227
228
    </div>
  </div>
</div>
Mark Otto's avatar
Mark Otto committed
229
230
{% endhighlight %}

231
232
233

    <div class="bs-callout bs-callout-warning">
      <h4>Make modals accessible</h4>
234
235
      <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>
236
237
    </div>

Mark Otto's avatar
Mark Otto committed
238
239
240
241
242
243
244
245
246
247
    <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>

248
<div class="modal fade bs-modal-lg" tabindex="-1" role="dialog" aria-labelledby="myLargeModalLabel" aria-hidden="true">
Mark Otto's avatar
Mark Otto committed
249
250
251
252
253
254
255
256
257
258
  <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>

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

    <!--  Modal content for the above example -->
269
    <div class="modal fade bs-modal-lg" tabindex="-1" role="dialog" aria-labelledby="myLargeModalLabel" aria-hidden="true">
Mark Otto's avatar
Mark Otto committed
270
271
272
273
274
      <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>
275
            <h4 class="modal-title" id="myLargeModalLabel">Large modal</h4>
Mark Otto's avatar
Mark Otto committed
276
277
278
279
280
281
282
          </div>
          <div class="modal-body">
            ...
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div><!-- /.modal -->
283
    <div class="modal fade bs-modal-sm" tabindex="-1" role="dialog" aria-labelledby="mySmallModalLabel" aria-hidden="true">
Mark Otto's avatar
Mark Otto committed
284
285
286
287
288
      <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>
289
            <h4 class="modal-title" id="mySmallModalLabel">Small modal</h4>
Mark Otto's avatar
Mark Otto committed
290
291
292
293
294
295
296
297
298
          </div>
          <div class="modal-body">
            ...
          </div>
        </div><!-- /.modal-content -->
      </div><!-- /.modal-dialog -->
    </div><!-- /.modal -->


Mark Otto's avatar
Mark Otto committed
299
    <h2 id="modals-usage">Usage</h2>
300
    <p>The modal plugin toggles your hidden content on demand, via data attributes or JavaScript. It also adds <code>.model-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
301
302
303
304
305
306
307
308
309
310
311
312
313

    <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>
314
    <div class="table-responsive">
315
316
317
318
319
320
321
322
323
324
325
326
      <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
327
           <td>boolean or the string <code>'static'</code></td>
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
           <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>
Chris Rebert's avatar
Chris Rebert committed
347
           <td><p>If a remote URL is provided, content will be loaded 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
348
349
350
{% highlight html %}
<a data-toggle="modal" href="remote.html" data-target="#modal">Click me</a>
{% endhighlight %}
wangsai's avatar
wangsai committed
351
           </td>
352
353
354
         </tr>
        </tbody>
      </table>
355
    </div><!-- /.table-responsive -->
Mark Otto's avatar
Mark Otto committed
356
357
358
359
360
361
362
363
364
365
366
367

    <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>
368
    <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
369
370
371
    {% highlight js %}$('#myModal').modal('toggle'){% endhighlight %}

    <h4>.modal('show')</h4>
372
    <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
373
374
375
    {% highlight js %}$('#myModal').modal('show'){% endhighlight %}

    <h4>.modal('hide')</h4>
376
    <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
377
378
379
380
    {% highlight js %}$('#myModal').modal('hide'){% endhighlight %}

    <h3>Events</h3>
    <p>Bootstrap's modal class exposes a few events for hooking into modal functionality.</p>
381
    <div class="table-responsive">
382
383
384
385
386
387
388
389
390
      <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
391
           <td>show.bs.modal</td>
392
           <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>
393
394
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
395
           <td>shown.bs.modal</td>
396
           <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>
397
398
         </tr>
         <tr>
Jacob Thornton's avatar
Jacob Thornton committed
399
           <td>hide.bs.modal</td>
400
401
402
           <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
403
           <td>hidden.bs.modal</td>
404
405
406
407
           <td>This event is fired when the modal has finished being hidden from the user (will wait for CSS transitions to complete).</td>
         </tr>
        </tbody>
      </table>
408
    </div><!-- /.table-responsive -->
Mark Otto's avatar
Mark Otto committed
409
{% highlight js %}
410
411
$('#myModal').on('hidden.bs.modal', function (e) {
  // do something...
Mark Otto's avatar
Mark Otto committed
412
413
414
415
416
417
})
{% endhighlight %}
  </div>



418
419
420
421
422
423
  <!-- 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
424

425
426
427
428
429
    <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">
430
      <nav id="navbar-example" class="navbar navbar-default navbar-static" role="navigation">
431
        <div class="navbar-header">
432
          <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-js-navbar-collapse">
433
            <span class="sr-only">Toggle navigation</span>
434
435
436
437
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
            <span class="icon-bar"></span>
          </button>
438
439
          <a class="navbar-brand" href="#">Project Name</a>
        </div>
440
        <div class="collapse navbar-collapse bs-js-navbar-collapse">
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
          <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>
463
          <ul class="nav navbar-nav navbar-right">
464
465
466
467
468
469
470
471
472
473
474
475
            <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 -->
476
      </nav> <!-- /navbar-example -->
477
478
    </div> <!-- /example -->

479
    <h3>Within pills</h3>
480
481
482
483
    <div class="bs-example">
      <ul class="nav nav-pills">
        <li class="active"><a href="#">Regular link</a></li>
        <li class="dropdown">
484
          <a id="drop4" role="button" data-toggle="dropdown" href="#">Dropdown <b class="caret"></b></a>
485
486
487
488
489
490
491
492
493
          <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">
494
          <a id="drop5" role="button" data-toggle="dropdown" href="#">Dropdown 2 <b class="caret"></b></a>
495
496
497
498
499
500
501
502
503
          <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">
504
          <a id="drop6" role="button" data-toggle="dropdown" href="#">Dropdown 3 <b class="caret"></b></a>
505
506
507
508
509
510
511
512
          <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>
513
      </ul> <!-- /pills -->
514
    </div> <!-- /example -->
Mark Otto's avatar
Mark Otto committed
515
516


517
    <h2 id="dropdowns-usage">Usage</h2>
518
    <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.</p>
Mark Otto's avatar
Mark Otto committed
519

520
521
    <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
522
523
{% highlight html %}
<div class="dropdown">
524
  <a data-toggle="dropdown" href="#">Dropdown trigger</a>
Mark Otto's avatar
Mark Otto committed
525
526
527
528
529
530
531
532
  <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">
533
  <a id="dLabel" role="button" data-toggle="dropdown" data-target="#" href="/page.html">
Mark Otto's avatar
Mark Otto committed
534
535
    Dropdown <span class="caret"></span>
  </a>
536
537


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

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

550
551
    <h3>Options</h3>
    <p><em>None</em></p>
Mark Otto's avatar
Mark Otto committed
552

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

557
    <h3>Events</h3>
558
    <div class="table-responsive">
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
      <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>
            <td>This event fires immediately when the show instance method is called.</td>
          </tr>
          <tr>
            <td>shown.bs.dropdown</td>
            <td>This event is fired when the dropdown has been made visible to the user (will wait for CSS transitions, to complete).</td>
          </tr>
          <tr>
            <td>hide.bs.dropdown</td>
            <td>This event is fired immediately when the hide instance method has been called.</td>
          </tr>
          <tr>
            <td>hidden.bs.dropdown</td>
            <td>This event is fired when the dropdown has finished being hidden from the user (will wait for CSS transitions, to complete).</td>
          </tr>
        </tbody>
      </table>
585
    </div><!-- ./bs-table-responsive -->
586
587
588
589
590
591
{% highlight js %}
$('#myDropdown').on('show.bs.dropdown', function () {
  // do something…
})
{% endhighlight %}
  </div>
Mark Otto's avatar
Mark Otto committed
592

593

594
595
596
597
598
599
  <!-- 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
600
601


602
603
604
    <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">
605
      <nav id="navbar-example2" class="navbar navbar-default navbar-static" role="navigation">
606
        <div class="navbar-header">
607
608
609
610
611
612
          <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>
613
614
          <a class="navbar-brand" href="#">Project Name</a>
        </div>
615
616
617
618
619
        <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
620
621
              <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
622
623
                <li><a href="#one" tabindex="-1">one</a></li>
                <li><a href="#two" tabindex="-1">two</a></li>
624
                <li class="divider"></li>
fat's avatar
fat committed
625
                <li><a href="#three" tabindex="-1">three</a></li>
626
627
628
629
              </ul>
            </li>
          </ul>
        </div>
630
      </nav>
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
      <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
646
647


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

650
    <h3>Via data attributes</h3>
wangsai's avatar
wangsai committed
651
    <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
652
{% highlight html %}
653
654
655
656
657
658
659
<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
660
661
662
663
  ...
</body>
{% endhighlight %}

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

670
671
672
673
    <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
674

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


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

    <h3>Events</h3>
709
    <div class="table-responsive">
710
711
712
713
714
715
716
717
718
      <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
719
           <td>activate.bs.scrollspy</td>
720
721
722
723
           <td>This event fires whenever a new item becomes activated by the scrollspy.</td>
        </tr>
        </tbody>
      </table>
724
    </div><!-- ./bs-table-responsive -->
fat's avatar
fat committed
725
726
727
728
729
{% highlight js %}
$('#myScrollspy').on('activate.bs.scrollspy', function () {
  // do something…
})
{% endhighlight %}
730
  </div>
Mark Otto's avatar
Mark Otto committed
731
732
733



734
735
736
737
738
739
  <!-- 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
740

741
742
743
744
745
746
747
    <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
748
749
          <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
750
751
            <li><a href="#dropdown1" tabindex="-1" data-toggle="tab">@fat</a></li>
            <li><a href="#dropdown2" tabindex="-1" data-toggle="tab">@mdo</a></li>
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
          </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
770

771
772
773
774
775
    <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
776

777
778
    <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
779
780
{% highlight js %}
$('#myTab a').click(function (e) {
781
782
  e.preventDefault()
  $(this).tab('show')
Mark Otto's avatar
Mark Otto committed
783
784
785
786
787
})
{% endhighlight %}

          <p>You can activate individual tabs in several ways:</p>
{% highlight js %}
788
789
790
791
$('#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
792
793
{% endhighlight %}

794
    <h3>Markup</h3>
795
    <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="{{ page.base_url }}components#nav-tabs">tab styling</a>, while adding the <code>nav</code> and <code>nav-pills</code> classes will apply <a href="{{ page.base_url }}components#nav-pills">pill styling</a>.</p>
Mark Otto's avatar
Mark Otto committed
796
{% highlight html %}
797
<!-- Nav tabs -->
Mark Otto's avatar
Mark Otto committed
798
799
800
801
802
803
<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>
804
805
806
807
808
809
810
811

<!-- 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
812
813
{% endhighlight %}

814
815
816
817
818
819
820
821
822
823
    <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
824

825
826
827
828
829
    <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
830
831
{% highlight html %}
<ul class="nav nav-tabs" id="myTab">
Chris Rebert's avatar
Chris Rebert committed
832
833
834
835
  <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
836
837
838
839
840
841
842
843
844
845
846
</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
847
    $('#myTab a:last').tab('show')
Mark Otto's avatar
Mark Otto committed
848
849
850
851
  })
</script>
{% endhighlight %}

852
    <h3>Events</h3>
853
    <div class="table-responsive">
854
855
856
857
858
859
860
861
862
      <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
863
           <td>show.bs.tab</td>
864
865
866
           <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
867
           <td>shown.bs.tab</td>
868
869
870
871
           <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>
872
    </div><!-- /.table-responsive -->
Mark Otto's avatar
Mark Otto committed
873
{% highlight js %}
fat's avatar
fat committed
874
$('a[data-toggle="tab"]').on('shown.bs.tab', function (e) {
Mark Otto's avatar
Mark Otto committed
875
876
877
878
  e.target // activated tab
  e.relatedTarget // previous tab
})
{% endhighlight %}
879
  </div>
Mark Otto's avatar
Mark Otto committed
880
881
882



883
884
885
886
887
888
  <!-- 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
889

890
891
892
893
894
895
896
    <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
897

898
899
900
    <h3>Four directions</h3>
    <div class="bs-example tooltip-demo">
      <div class="bs-example-tooltips">
901
        <button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</button>
902
903
        <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>
904
        <button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</button>
905
906
      </div>
    </div><!-- /example -->
Mark Otto's avatar
Mark Otto committed
907
908
{% highlight html %}
<button type="button" class="btn btn-default" data-toggle="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</button>
909

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

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

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

917
918
    <div class="bs-callout bs-callout-danger">
      <h4>Opt-in functionality</h4>
Julian Thilo's avatar
Julian Thilo committed
919
      <p>For performance reasons, the Tooltip and Popover data-apis are opt-in, meaning <strong>you must initialize them yourself</strong>.</p>
920
    </div>
921
922
923
924
    <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>
925
    <div class="bs-callout bs-callout-info">
Chris Rebert's avatar
Chris Rebert committed
926
      <h4>Tooltips on disabled elements require wrapper elements</h4>
927
      <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>
928
    </div>
Mark Otto's avatar
Mark Otto committed
929

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

    <h3>Markup</h3>
Mark Otto's avatar
Mark Otto committed
938
939
940
941
942
    <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>
943
{% highlight html linenos %}
Mark Otto's avatar
Mark Otto committed
944
945
946
947
948
<!-- HTML to write -->
<a href="#" data-toggle="tooltip" title="first tooltip">Hover over me</a>

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

956
957
    <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>
958
    <div class="table-responsive">
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
      <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>
985
           <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>
986
987
988
989
990
991
992
993
994
995
996
         </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
997
           <td>default title value if <code>title</code> attribute isn't present</td>
998
999
1000
         </tr>
         <tr>
           <td>trigger</td>
For faster browsing, not all history is shown. View entire blame