javascript.html 51.8 KB
Newer Older
Jacob Thornton's avatar
Jacob Thornton committed
1
2
3
4
5
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Bootstrap, from Twitter</title>
Raul Riera's avatar
Raul Riera committed
6
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
Jacob Thornton's avatar
Jacob Thornton committed
7
8
9
10
11
12
13
14
15
    <meta name="description" content="">
    <meta name="author" content="">

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

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

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

    <!-- Le javascript -->
    <!-- placed up here so that the inline demos can be next to their markup -->
28
29
    <!-- <script src="http://code.jquery.com/jquery-1.7.min.js"></script> -->
    <script src="../js/tests/vendor/jquery.js"></script>
30
31
32
33

    <script type="text/javascript">
      // NOT FINAL BY ANY MEANS, JUST MAH JANK CODE BRO
      $(document).ready(function() {
34
        $('.nav .active').click(function(e) {
35
          e.preventDefault();
36
          $(this).siblings().toggle();
37
38
39
40
        });
      });
    </script>

41
42
    <script src="assets/js/google-code-prettify/prettify.js"></script>
    <script>$(function () { prettyPrint() })</script>
43
    <script src="../js/bootstrap-transition.js"></script>
44
    <script src="../js/bootstrap-alert.js"></script>
45
46
47
    <script src="../js/bootstrap-modal.js"></script>
    <script src="../js/bootstrap-dropdown.js"></script>
    <script src="../js/bootstrap-scrollspy.js"></script>
48
    <script src="../js/bootstrap-tab.js"></script>
49
50
    <script src="../js/bootstrap-twipsy.js"></script>
    <script src="../js/bootstrap-popover.js"></script>
51
    <script src="../js/bootstrap-button.js"></script>
52
    <script src="../js/bootstrap-collapse.js"></script>
53
54
55
    <script>
      $(function () {
        // twipsy demo
56
57
        $('.twipsy-demo.well').twipsy({
          selector: "a[rel=twipsy]"
58
59
60
61
        })

        //popover demo
        $("a[rel=popover]")
62
          .popover()
63
64
65
66
67
68
          .click(function(e) {
            e.preventDefault()
          })
      })
    </script>

Jacob Thornton's avatar
Jacob Thornton committed
69
70
  </head>

71
  <body id="bootstrap-js">
Jacob Thornton's avatar
Jacob Thornton committed
72

73
    <!-- Navbar
Jacob Thornton's avatar
Jacob Thornton committed
74
    ================================================== -->
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
    <div class="navbar navbar-fixed">
      <div class="navbar-inner">
        <div class="container">
          <a class="brand" href="./index.html">Bootstrap</a>
          <ul class="nav">
            <li><a href="./index.html">Overview</a></li>
            <li><a href="./scaffolding.html">Scaffolding</a></li>
            <li><a href="./base-css.html">Base CSS</a></li>
            <li><a href="./components.html">Components</a></li>
            <li class="active"><a href="./javascript.html">Javascript plugins</a></li>
            <li><a href="./less.html">Using LESS</a></li>
          </ul>
        </div>
      </div>
    </div>

    <div class="container">
      <!-- Masthead
      ================================================== -->
      <header class="jumbotron subhead" id="overview">
        <h1>Javascript for Bootstrap</h1>
96
        <p class="lead">Bring Bootstrap's components to life with 12 custom, flexible <a href="http://jquery.com/" target="_blank">jQuery</a> plugins.
97
98
99
100
101
102
103
104
105
106
107
108
109
      </header>


<!-- Using Javascript w/ Bootstrap
 ================================================== -->

 <section id="javascript">
   <div class="page-header">
     <h1>Using javascript with Bootstrap <small>An index of plugins to get you started</small></h1>
   </div>
   <div class="row">
     <div class="span3">
       <h2>Getting started</h2>
110
       <p>Integrating javascript with the Bootstrap library is super easy. Here we go over the basics and provide you with some awesome plugins to get you started!</p>
111
112
113
     </div>
     <div class="span9">
      <h3>What's included</h3>
114
       <p>Bring some of Bootstrap's primary components to life with custom <a href="http://jquery.com/" target="_blank">jQuery</a> plugins. We encourage you to extend and modify them to fit your specific development needs.</p>
115
       <table class="striped-table">
116
117
118
119
120
121
122
123
124
125
126
127
         <thead>
           <tr>
             <th style="width: 150px;">File</th>
             <th>Description</th>
           </tr>
         </thead>
         <tbody>
           <tr>
             <td><a href="./javascript.html#modal">bootstrap-modal.js</a></td>
             <td>Our Modal plugin is a <strong>super</strong> slim take on the traditional modal js plugin! We took special care to include only the bare functionality that we require at twitter.</td>
           </tr>
           <tr>
128
             <td><a href="./javascript.html#alert">bootstrap-alert.js</a></td>
129
130
131
             <td>The alert plugin is a super tiny class for adding close functionality to alerts.</td>
           </tr>
           <tr>
132
             <td><a href="./javascript.html#dropdown">bootstrap-dropdown.js</a></td>
133
134
135
136
137
138
139
             <td>This plugin is for adding dropdown interaction to the bootstrap navbar or tabbed navigations.</td>
           </tr>
           <tr>
             <td><a href="./javascript.html#scrollspy">bootstrap-scrollspy.js</a></td>
             <td>The ScrollSpy plugin is for adding an auto updating nav based on scroll position to the bootstrap navbar.</td>
           </tr>
           <tr>
140
             <td><a href="./javascript.html#tab">bootstrap-tab.js</a></td>
141
142
143
144
145
146
147
148
149
150
             <td>This plugin adds quick, dynamic tab and pill functionality for cycling through local content.</td>
           </tr>
           <tr>
             <td><a href="./javascript.html#twipsy">bootstrap-twipsy.js</a></td>
             <td>Based on the excellent jQuery.tipsy plugin written by Jason Frame; twipsy is an updated version, which doesn't rely on images, uses css3 for animations, and data-attributes for local title storage!</td>
           </tr>
           <tr>
             <td><a href="./javascript.html#popover">bootstrap-popover.js</a></td>
             <td>The popover plugin provides a simple interface for adding popovers to your application. It extends the <a href="#twipsy">boostrap-twipsy.js</a> plugin, so be sure to grab that file as well when including popovers in your project!</td>
           </tr>
151
           <tr>
152
              <td><a href="./javascript.html#button">bootstrap-button.js</a></td>
153
154
              <td>This plugin offers additional functionality for managing button state.</td>
            </tr>
155
156
157
158
            <tr>
              <td><a href="./javascript.html#collapse">bootstrap-collapse.js</a></td>
              <td>The collapse plugin offers simple, generic collapsible element support for making accordions and other collapsible ui components.</td>
            </tr>
159
160
161
162
163
164
165
166
167
         </tbody>
       </table>
       <h3>Is javascript necessary?</h3>
       <p><strong>Nope!</strong> Bootstrap is designed first and foremost to be a CSS library. This javascript provides a basic interactive layer on top of the included styles.</p>
       <p>However, for those who do need javascript, we've provided the plugins above to help you understand how to integrate Bootstrap with javascript and to give you a quick, lightweight option for the basic functionality right away.</p>
       <p>For more information and to see some live demos, please refer to our <a href="./javascript.html">plugin documentation page</a>.</p>
     </div>
   </div>
</section>
168

Jacob Thornton's avatar
Jacob Thornton committed
169
170
171
172

    <!-- Modal
    ================================================== -->

173
    <section id="modal">
Jacob Thornton's avatar
Jacob Thornton committed
174
      <div class="page-header">
175
        <h1>Modals <small>bootstrap-modal.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
176
177
      </div>
      <div class="row">
178
        <div class="span3 columns">
179
          <p>Our Modal plugin is a super slim take on the traditional modal js plugin, taking special care to include only the bare functionality that we require here at twitter.</p>
180
          <a href="../js/bootstrap-modal.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
181
        </div>
182
        <div class="span9 columns">
183
          <h3>Using bootstrap-modal</h3>
184
          <pre class="prettyprint linenums">$('#myModal').modal(options)</pre>
Jacob Thornton's avatar
Jacob Thornton committed
185
          <h3>Options</h3>
186
          <table class="striped-table">
187
188
189
190
191
192
193
194
195
196
197
198
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 50px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>backdrop</td>
               <td>boolean</td>
199
               <td>true</td>
200
201
202
203
204
               <td>Includes a modal-backdrop element</td>
             </tr>
             <tr>
               <td>keyboard</td>
               <td>boolean</td>
205
               <td>true</td>
206
207
208
209
210
               <td>Closes the modal when escape key is pressed</td>
             </tr>
             <tr>
               <td>show</td>
               <td>boolean</td>
211
               <td>true</td>
212
213
214
215
216
               <td>Opens modal on class initialization</td>
             </tr>
            </tbody>
          </table>
          <h3>Markup</h3>
217
          <p>You can activate modals on your page easily without having to write a single line of javascript. Just set <code>data-toggle="modal"</code> on a controller element with a <code>data-target="#foo"</code> or <code>href="#foo"</code> which corresponds to a modal element id, and when clicked, it will launch your modal. To add modal options, just include them as additoinal data attributes.</p>
218
<pre class="prettyprint linenums">
219
&lt;a class="btn" data-toggle="modal" href="#myModal" &gt;Launch Modal&lt;/a&gt;
220
</pre>
221
          <p><span class="label notice">Notice</span> If you want your modal to animate in and out, just add a <code>.fade</code> class to the <code>.modal</code> element (refer to the demo to see this in action).</p>
Jacob Thornton's avatar
Jacob Thornton committed
222
          <h3>Methods</h3>
223
224
          <h4>.modal(options)</h4>
          <p>Activates your content as a modal. Accepts an optional options <code>object</code>.
Jacob Thornton's avatar
Jacob Thornton committed
225
<pre class="prettyprint linenums">
226
$('#myModal').modal({
227
  keyboard: false
228
})</pre>
229
230
          <h4>.modal('toggle')</h4>
          <p>Manually toggles a modal.</p>
231
          <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre>
232
233
          <h4>.modal('show')</h4>
          <p>Manually opens a modal.</p>
234
          <pre class="prettyprint linenums">$('#myModal').modal('show')</pre>
235
236
          <h4>.modal('hide')</h4>
          <p>Manually hides a modal.</p>
237
          <pre class="prettyprint linenums">$('#myModal').modal('hide')</pre>
238
          <h3>Events</h3>
239
          <p>Bootstrap's modal class exposes a few events for hooking into modal functionality. </p>
240
          <table class="striped-table">
241
242
            <thead>
             <tr>
243
               <th style="width: 150px;">Event</th>
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>show</td>
               <td>This event fires immediately when the <code>show</code> instance method is called.</td>
             </tr>
             <tr>
               <td>shown</td>
               <td>This event is fired when the modal has been made visible to the user (will wait for css transitions to complete).</td>
             </tr>
             <tr>
               <td>hide</td>
               <td>This event is fired immediately when the <code>hide</code> instance method has been called.</td>
             </tr>
             <tr>
               <td>hidden</td>
               <td>This event is fired when the modal has finished being hidden from the user (will wait for css transitions to complete).</td>
             </tr>
            </tbody>
          </table>

267
<pre class="prettyprint linenums">
268
$('#myModal').bind('hidden', function () {
269
270
  // do something ...
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
271
272
          <h3>Demo</h3>
          <!-- sample modal content -->
Jacob Thornton's avatar
Jacob Thornton committed
273
          <div id="myModal" class="modal hide fade">
Jacob Thornton's avatar
Jacob Thornton committed
274
            <div class="modal-header">
Jacob Thornton's avatar
Jacob Thornton committed
275
              <a href="#" class="close" data-dismiss="modal" >&times;</a>
Jacob Thornton's avatar
Jacob Thornton committed
276
              <h3>Modal Heading</h3>
Jacob Thornton's avatar
Jacob Thornton committed
277
278
279
280
281
            </div>
            <div class="modal-body">
              <p>One fine body…</p>
            </div>
            <div class="modal-footer">
282
              <a href="#" class="btn primary">Save changes</a>
Jacob Thornton's avatar
Jacob Thornton committed
283
              <a href="#" class="btn" data-dismiss="modal" >Close</a>
Jacob Thornton's avatar
Jacob Thornton committed
284
285
            </div>
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
286

287
          <a data-toggle="modal" href="#myModal" class="btn danger">
288
            Launch Modal
289
          </a>
Jacob Thornton's avatar
Jacob Thornton committed
290
291
292
        </div>
      </div>
    </section>
293
294


Jacob Thornton's avatar
Jacob Thornton committed
295
296
297
298
299
    <!-- Dropdown
    ================================================== -->

    <section id="dropdown">
      <div class="page-header">
Jacob Thornton's avatar
Jacob Thornton committed
300
        <h1>Dropdown <small>bootstrap-dropdown.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
301
302
      </div>
      <div class="row">
303
        <div class="span3 columns">
304
          <p>This plugin is for adding dropdown interaction to the Bootstrap navbar or tabbed navigations.</p>
305
          <a href="../js/bootstrap-dropdown.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
306
        </div>
307
        <div class="span9 columns">
308
          <h3>Using boostrap-dropdown.js</h3>
309
          <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre>
310
          <h3>Markup</h3>
311
          <p>To quickly add dropdown functionality to any element just add <code>data-toggle="dropdown"</code>. Any valid bootstrap dropdown will automatically be activated.</p>
312
313
314
<pre class="prettyprint linenums">
&lt;ul class="tabs"&gt;
  &lt;li class="active"&gt;&lt;a href="#"&gt;Home&lt;/a&gt;&lt;/li&gt;
315
316
  &lt;li class="dropdown"&gt;
    &lt;a href="#" class="dropdown-toggle" data-toggle="dropdown"&gt;Dropdown&lt;/a&gt;
317
318
319
320
321
322
323
324
325
326
    &lt;ul class="dropdown-menu"&gt;
      &lt;li&gt;&lt;a href="#"&gt;Secondary link&lt;/a&gt;&lt;/li&gt;
      &lt;li&gt;&lt;a href="#"&gt;Something else here&lt;/a&gt;&lt;/li&gt;
      &lt;li class="divider"&gt;&lt;/li&gt;
      &lt;li&gt;&lt;a href="#"&gt;Another link&lt;/a&gt;&lt;/li&gt;
    &lt;/ul&gt;
  &lt;/li&gt;
&lt;/ul&gt;</pre>
          <h3>Methods</h3>
          <h4>$().dropdown()</h4>
Jacob Thornton's avatar
Jacob Thornton committed
327
          <p>
328
          A programatic api for activating menus for a given navbar or tabbed navigation.
Jacob Thornton's avatar
Jacob Thornton committed
329
330
          </p>
          <h3>Demo</h3>
331
          <div id="navbar-example" class="navbar navbar-static">
332
333
334
335
336
337
338
            <div class="navbar-inner">
              <div class="container" style="width: auto;">
                <a class="brand" href="#">Project Name</a>
                <ul class="nav">
                  <li><a href="#">Link</a></li>
                  <li><a href="#">Link</a></li>
                </ul>
Mark Otto's avatar
Mark Otto committed
339
                <form class="form-search navbar-search pull-left" action="">
340
                  <input type="text" class="search-query span2" placeholder="Search">
341
342
343
                </form>
                <ul class="nav secondary-nav">
                  <li class="dropdown">
344
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown 1</a>
345
346
347
348
349
350
351
352
                    <ul class="dropdown-menu">
                      <li><a href="#">Secondary link</a></li>
                      <li><a href="#">Something else here</a></li>
                      <li class="divider"></li>
                      <li><a href="#">Another link</a></li>
                    </ul>
                  </li>
                  <li class="dropdown">
353
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown 2</a>
354
355
356
357
358
359
360
361
                    <ul class="dropdown-menu">
                      <li><a href="#">Secondary link</a></li>
                      <li><a href="#">Something else here</a></li>
                      <li class="divider"></li>
                      <li><a href="#">Another link</a></li>
                    </ul>
                  </li>
                </ul>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
362
363
364
365
366
367
368
              </div>
            </div>
          </div>
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
369
370
371
372
373
374
375
376
   <!-- ScrollSpy
    ================================================== -->

    <section id="scrollspy">
      <div class="page-header">
        <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
      </div>
      <div class="row">
377
        <div class="span3 columns">
378
          <p>This plugin is for adding the scrollspy (auto updating nav) interaction to the bootstrap navbar.</p>
Jacob Thornton's avatar
Jacob Thornton committed
379
380
          <a href="../js/bootstrap-scrollspy.js" target="_blank" class="btn primary">Download</a>
        </div>
381
        <div class="span9 columns">
Jacob Thornton's avatar
Jacob Thornton committed
382
          <h2>Using boostrap-scrollspy.js</h2>
383
          <pre class="prettyprint linenums">$('#navbar').dropdown()</pre>
384
          <h3>Markup</h3>
385
386
          <p>To easily add scrollspy behavior to your topbar navigation, just add <code>data-spy="scroll"</code> to the element you want to spy on (most typically this would be the body).
          <pre class="prettyprint linenums">&lt;body data-spy="scroll" &gt;...&lt;/body&gt;</pre>
387
           <p><span class="label notice">Notice</span> Navbar anchor tags must have resolvable id targets. For example, a <code>&lt;a href="#home"&gt;home&lt;/a&gt;</code> must correspond to something in the dom like <code>&lt;div id="home"&gt;&lt;/div&gt;</code>.
Jacob Thornton's avatar
Jacob Thornton committed
388
          <h3>Demo</h3>
389
390
391
392
          <p>
            Scroll the area below and watch the navigation update. The dropdown sub items will be highlighted as well. Try it!</p>
          <p>

393
          <div id="navbarExample" class="navbar navbar-static">
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
            <div class="navbar-inner">
              <div class="container" style="width: auto;">
                <a class="brand" href="#">Project Name</a>
                <ul class="nav">
                  <li><a href="#fat">@fat</a></li>
                  <li><a href="#mdo">@mdo</a></li>
                  <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown</a>
                    <ul class="dropdown-menu">
                      <li><a href="#one">one</a></li>
                      <li><a href="#two">two</a></li>
                      <li class="divider"></li>
                      <li><a href="#three">three</a></li>
                    </ul>
                  </li>
                </ul>
              </div>
            </div>
          </div>

414
          <div data-spy="scroll" data-target="#navbarExample" class="scrollspy-example">
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
            <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>

Jacob Thornton's avatar
Jacob Thornton committed
439
440
441
442
        </div>
      </div>
    </section>

Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
443
444
445
    <!-- Tabs
    ================================================== -->

446
    <section id="tab">
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
447
      <div class="page-header">
448
        <h1>Tab <small>bootstrap-tab.js</small></h1>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
449
450
      </div>
      <div class="row">
451
        <div class="span3 columns">
452
          <p>This plugin adds quick, dynamic tab and pill functionality.</p>
453
          <a href="../js/bootstrap-tab.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
454
        </div>
455
        <div class="span9 columns">
456
457
          <h3>Using boostrap-tab.js</h3>
          <pre class="prettyprint linenums">$('#myTab').tab('show')</pre>
458
          <h3>Markup</h3>
459
460
461
462
463
464
465
          <p>You can activate a tab or pill navigation without writing any javascript by simply specifying <code>data-toggle="tab"</code> or <code>data-toggle="pill"</code> on an element.</p>
<pre class="prettyprint linenums">
&lt;ul class="tabs"&gt;
  &lt;li&gt;&lt;a href="#home" data-toggle="tab"&gt;Home&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#profile" data-toggle="tab"&gt;Profile&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="http://twitter.com/fat"&gt;twitter&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;</pre>
466
          <h3>Methods</h3>
467
          <h4>$().tab</h4>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
468
          <p>
469
            Activates a tab element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the dom.
470
471
          </p>
<pre class="prettyprint linenums">
Jacob Thornton's avatar
Jacob Thornton committed
472
&lt;ul class="tabs"&gt;
473
474
475
476
477
478
  &lt;li class="active"&gt;&lt;a href="#home"&gt;Home&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#profile"&gt;Profile&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#messages"&gt;Messages&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#settings"&gt;Settings&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;

Jacob Thornton's avatar
Jacob Thornton committed
479
&lt;div class="pill-content"&gt;
480
481
482
483
  &lt;div class="active" id="home"&gt;...&lt;/div&gt;
  &lt;div id="profile"&gt;...&lt;/div&gt;
  &lt;div id="messages"&gt;...&lt;/div&gt;
  &lt;div id="settings"&gt;...&lt;/div&gt;
484
&lt;/div&gt;
485
486
487

&lt;script&gt;
  $(function () {
488
    $('.tabs a:last').tab('show')
489
490
  })
&lt;/script&gt;</pre>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
491
          </p>
492
493
494
495
496
497
498
499
500
501
          <h3>Events</h3>
          <table class="zebra-striped">
            <thead>
             <tr>
               <th style="width: 150px;">Event</th>
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
502
503
504
505
               <td>show</td>
               <td>This event fires on tab show, but before the new tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.</td>
            </tr>
            <tr>
506
               <td>shown</td>
507
               <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>
508
509
510
511
512
             </tr>
            </tbody>
          </table>

          <pre class="prettyprint linenums">
513
$('a[data-toggle="tab"]').bind('shown', function (e) {
514
515
516
  e.target // activated tab
  e.relatedTarget // previous tab
})</pre>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
517
          <h3>Demo</h3>
518
519
520
521
522
          <ul id="tab" class="tabs">
            <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>
523
524
525
            <li class="dropdown">
              <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown</a>
              <ul class="dropdown-menu">
526
527
                <li><a href="#dropdown1" data-toggle="tab">@fat</a></li>
                <li><a href="#dropdown2" data-toggle="tab">@mdo</a></li>
528
529
530
              </ul>
            </li>
          </ul>
531
          <div id="myTabContent" class="tab-content">
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
            <div class="active tab-pane" 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" 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" id="messages">
              <p>Banksy do proident, brooklyn photo booth delectus sunt artisan sed organic exercitation eiusmod four loko. Quis tattooed iphone esse aliqua. Master cleanse vero fixie mcsweeney's. Ethical portland aute, irony food truck pitchfork lomo eu anim. Aesthetic blog DIY, ethical beard leggings tofu consequat whatever cardigan nostrud. Helvetica you probably haven't heard of them carles, marfa veniam occaecat lomo before they sold out in shoreditch scenester sustainable thundercats. Consectetur tofu craft beer, mollit brunch fap echo park pitchfork mustache dolor.</p>
            </div>
            <div class="tab-pane" id="settings">
              <p>Sunt qui biodiesel mollit officia, fanny pack put a bird on it thundercats seitan squid ad wolf bicycle rights blog. Et aute readymade farm-to-table carles 8-bit, nesciunt nulla etsy adipisicing organic ea. Master cleanse mollit high life, next level Austin nesciunt american apparel twee mustache adipisicing reprehenderit hoodie portland irony. Aliqua tofu quinoa +1 commodo eiusmod. High life williamsburg cupidatat twee homo leggings. Four loko vinyl DIY consectetur nisi, marfa retro keffiyeh vegan. Fanny pack viral retro consectetur gentrify fap.</p>
            </div>
            <div class="tab-pane" 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" 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>
549
            </div>
Jacob Thornton's avatar
Jacob Thornton committed
550
551
552
553
554
          </div>
        </div>
      </div>
    </section>

555
556
557
558
559
560
561
562
    <!-- Tips
    ================================================== -->

    <section id="twipsy">
      <div class="page-header">
        <h1>Twipsy <small>bootstrap-twipsy.js</small></h1>
      </div>
      <div class="row">
563
        <div class="span3 columns">
564
          <p>Based on the excellent jQuery.tipsy plugin written by Jason Frame; twipsy is an updated version, which doesn't rely on images, uses css3 for animations, and data-attributes for title storage!</p>
565
          <a href="../js/bootstrap-twipsy.js" target="_blank" class="btn primary">Download</a>
566
        </div>
567
        <div class="span9 columns">
568
          <h3>Using bootstrap-twipsy.js</h3>
569
570
          <pre class="prettyprint linenums">$('#example').twipsy(options)</pre>
          <h3>Options</h3>
571
          <table class="striped-table">
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
            <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>animate</td>
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
               <td>placement</td>
               <td>string</td>
               <td>'above'</td>
               <td>how to position the tooltip - above | below | left | right</td>
             </tr>
             <tr>
               <td>live</td>
               <td>boolean</td>
               <td>false</td>
               <td>use event delegation instead of individual event handlers</td>
             </tr>
             <tr>
               <td>offset</td>
               <td>number</td>
               <td>0</td>
               <td>pixel offset of tooltip from target element</td>
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
611
612
613
614
615
616
617
618
619
620
             <tr>
               <td>delay</td>
               <td>number | object</td>
               <td>0</td>
               <td>
                <p>delay showing/hiding the tooltip (ms)</p>
                <p>If a number is supplied, delay is applied to both hide/show</p>
                <p>Object structure is: <code>delay: { show: 500, hide: 100 }</code></p>
               </td>
             </tr>
621
622
            </tbody>
          </table>
623
624
          <p><span class="label notice">Notice</span> Individual twipsy instance options can alternatively be specified through the use of data attributes.</code></p>
          <h3>Markup</h3>
625
          For performance reasons, the Twipsy and Popover data-apis are opt in. If you would like to use them just set the live flag to true, however we recommend you know what you are doing if you do that. :)
626
          <h3>Methods</h3>
627
          <h4>$().twipsy(options)</h4>
628
          <p>Attaches a twipsy handler to an element collection.</p>
629
          <h4>.twipsy('show')</h4>
630
          <p>Reveals an elements twipsy.</p>
631
632
          <pre class="prettyprint linenums">$('#element').twipsy('show')</pre>
          <h4>.twipsy('hide')</h4>
633
          <p>Hides an elements twipsy.</p>
634
          <pre class="prettyprint linenums">$('#element').twipsy('hide')</pre>
635
          <h3>Demo</h3>
636
637
          <div class="twipsy-demo well">
            <p class="muted">Tight pants next level keffiyeh <a href="#" rel='twipsy' title="first twipsy">you probably</a> haven't heard of them. Photo booth beard raw denim letterpress vegan messenger bag stumptown. Farm-to-table seitan, mcsweeney's fixie sustainable quinoa 8-bit american apparel <a href="#" rel='twipsy' title='Another twipsy'>have a</a> terry richardson vinyl chambray. Beard stumptown, cardigans banh mi lomo thundercats. Tofu biodiesel williamsburg marfa, four loko mcsweeney's cleanse vegan chambray. A <a href="#" rel='twipsy' title='Another one here too'>really ironic</a> artisan whatever keytar, scenester farm-to-table banksy Austin <a href="#" rel='twipsy' title='The last tip!'>twitter handle</a> freegan cred raw denim single-origin coffee viral.
Jacob Thornton's avatar
Jacob Thornton committed
638
639
            </p>
          </div>
640
641
642
643
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
644
645
646
647
648
649
650
651
    <!-- Popovers
    ================================================== -->

    <section id="popover">
      <div class="page-header">
        <h1>Popovers <small>bootstrap-popover.js</small></h1>
      </div>
      <div class="row">
652
        <div class="span3 columns">
Jacob Thornton's avatar
Jacob Thornton committed
653
          <p>The popover plugin provides a simple interface for adding popovers to your application. It extends the <a href="#twipsy">boostrap-twipsy.js</a> plugin, so be sure to grab that file as well when including popovers in your project!</p>
654
          <a href="../js/bootstrap-popover.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
655
        </div>
656
        <div class="span9 columns">
657
          <h3>Using boostrap-popover.js</h3>
Jacob Thornton's avatar
Jacob Thornton committed
658
659
          <pre class="prettyprint linenums">$('#example').popover(options)</pre>
          <h3>Options</h3>
660
          <table class="striped-table">
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
            <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>animate</td>
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
677
678
               <td>delay</td>
               <td>number | object</td>
679
               <td>0</td>
680
               <td>delay before showing/hiding the tooltip (ms)</td>
681
682
683
684
685
             </tr>
             <tr>
               <td>placement</td>
               <td>string</td>
               <td>'right'</td>
686
               <td>how to position the popover - above | below | left | right</td>
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
             </tr>
             <tr>
               <td>live</td>
               <td>boolean</td>
               <td>false</td>
               <td>use event delegation instead of individual event handlers</td>
             </tr>
             <tr>
               <td>offset</td>
               <td>number</td>
               <td>0</td>
               <td>pixel offset of tooltip from target element</td>
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
            </tbody>
          </table>
708
709
          <p><span class="label notice">Notice</span> Individual popover instance options can alternatively be specified through the use of data attributes.</code></p>
          <h3>Markup</h3>
710
711
712
          <p>
          For performance reasons, the Twipsy and Popover data-apis are opt in. If you would like to use them just set the live flag to true, however we recommend you know what you are doing if you do that. :)
          </p>
Jacob Thornton's avatar
Jacob Thornton committed
713
          <h3>Methods</h3>
714
          <h4>$().popover(options)</h4>
Jacob Thornton's avatar
Jacob Thornton committed
715
          <p>Initializes popovers for an element collection.</p>
716
          <h4>.popover('show')</h4>
717
          <p>Reveals an elements popover.</p>
718
719
          <pre class="prettyprint linenums">$('#element').popover('show')</pre>
          <h4>.popover('hide')</h4>
720
          <p>Hides an elements popover.</p>
721
          <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
722
          <h3>Demo</h3>
723
          <a href="#" class="btn danger" rel="popover" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">hover for popover</a>
Jacob Thornton's avatar
Jacob Thornton committed
724
725
726
        </div>
      </div>
    </section>
727

728

729
    <!-- Alert
730
731
    ================================================== -->

732
    <section id="alert">
733
      <div class="page-header">
734
        <h1>Alert <small>bootstrap-alert.js</small></h1>
735
736
      </div>
      <div class="row">
737
        <div class="span3 columns">
738
739
740
          <p>The alert plugin is a super tiny class for adding close functionality to alerts.</p>
          <a href="../js/bootstrap-alerts.js" target="_blank" class="btn primary">Download</a>
        </div>
741
        <div class="span9 columns">
742
          <h3>Using bootstrap-alerts.js</h3>
743
          <pre class="prettyprint linenums">$(".alert-message").alert()</pre>
744
          <h3>Markup</h3>
745
746
          <p>Just add <code>data-dismiss="alert"</code> to your close button to automatically give an alert close functionality.</p>
          <pre class="prettyprint linenums">&lt;a class="close" data-dismiss="alert" href="#"&gt;&amp;times;&lt;/a&gt;</pre>
747
          <h3>Methods</h3>
748
          <h4>$().alert()</h4>
749
          <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>
750
          <h4>.alert('close')</h4>
751
          <p>Closes an alert.</p>
752
          <pre class="prettyprint linenums">$(".alert-message").alert('close')</pre>
753
          <h3>Demo</h3>
754
755
          <div class="alert-message warning fade in">
            <a class="close" data-dismiss="alert" href="#">&times;</a>
756
757
            <p><strong>Holy guacamole!</strong> Best check yo self, you’re not looking too good.</p>
          </div>
758
759
          <div class="alert-message block-message error fade in">
            <a class="close" data-dismiss="alert" href="#">&times;</a>
760
761
762
763
764
765
766
767
768
            <p><strong>Oh snap! You got an error!</strong> 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>
            <div class="alert-actions">
              <a class="btn small" href="#">Take this action</a> <a class="btn small" href="#">Or do this</a>
            </div>
          </div>
        </div>
      </div>
    </section>

Mark Otto's avatar
Mark Otto committed
769

770
    <!-- Button
771
772
    ================================================== -->

773
    <section id="button">
774
      <div class="page-header">
775
        <h1>Button <small>bootstrap-button.js</small></h1>
776
777
778
779
      </div>
      <div class="row">
        <div class="span3 columns">
          <p>This plugin offers additional functionality for managing button state.</p>
780
          <a href="../js/bootstrap-button.js" target="_blank" class="btn primary">Download</a>
781
782
        </div>
        <div class="span9 columns">
783
          <h3>Using bootstrap-button.js</h3>
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
          <pre class="prettyprint linenums">$('.tabs').button()</pre>
            <h3>Markup</h3>
          <p>Data attributes are integral to the button plugin. Check out the example code below for the various markup types.</p>
<pre class="prettyprint linenums">
&lt;!-- Add data-toggle="button" to activate toggling on a single button --&gt;
&lt;button class="btn" data-toggle="button"&gt;Single Toggle&lt;/button&gt;

&lt;!-- Add data-toggle="buttons-checkbox" for checkbox style toggling on btn-group --&gt;
&lt;div class="btn-group" data-toggle="buttons-checkbox"&gt;
  &lt;button class="btn"&gt;Left&lt;/button&gt;
  &lt;button class="btn"&gt;Middle&lt;/button&gt;
  &lt;button class="btn"&gt;Right&lt;/button&gt;
&lt;/div&gt;

&lt;!-- Add data-toggle="buttons-radio" for radio style toggling on btn-group --&gt;
&lt;div class="btn-group" data-toggle="buttons-radio"&gt;
  &lt;button class="btn"&gt;Left&lt;/button&gt;
  &lt;button class="btn"&gt;Middle&lt;/button&gt;
  &lt;button class="btn"&gt;Right&lt;/button&gt;
&lt;/div&gt;
</pre>
          <h3>Methods</h3>
          <h4>$().button('toggle')</h4>
          <p>Toggles push state. Gives btn the look that it's been activated.</p>
          <p><span class="label notice">Notice</span> You can enable auto toggling of a button by using the <code>data-toggle</code> attribute.</p>
          <pre class="prettyprint linenums">&lt;button class="btn" data-toggle="button" &gt;...&lt;/button&gt;</pre>
          <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>
           <pre class="prettyprint linenums">&lt;button class="btn" data-loading-text="loading stuff..." &gt;...&lt;/button&gt;</pre>
           <h4>$().button('reset')</h4>
           <p>Resets button state - swaps text to original text.</p>
           <h4>$().button(string)</h4>
           <p>Resets button state - swaps text to any data defined text state.</p>
<pre class="prettyprint linenums">&lt;button class="btn" data-complete-text="finished!" &gt;...&lt;/button&gt;
&lt;script&gt;
  $('.btn').button('complete')
&lt;/scrip&gt;</pre>
          <h3>Demo</h3>
          <table class="striped-table">
            <tbody>
             <tr>
               <td>Stateful</td>
               <td>
                  <button id="fat-btn" data-loading-text="loading..." class="btn">
                    Loading State
                  </button>
                  <script>
                    $(function() {
                      var btn = $('#fat-btn').click(function () {
                        btn.button('loading')
                        setTimeout(function () {
                          btn.button('reset')
                        }, 3000)
                      })
                    })
                  </script>
                </td>
             </tr>
             <tr>
               <td>Single Toggle</td>
               <td>
                  <button class="btn" data-toggle="button">Single Toggle</button>
                </td>
             </tr>
             <tr>
               <td>Checkbox</td>
               <td>
                  <div class="btn-group" data-toggle="buttons-checkbox">
                    <button class="btn">Left</button>
                    <button class="btn">Middle</button>
                    <button class="btn">Right</button>
                  </div>
               </td>
             </tr>
             <tr>
               <td>Radio</td>
               <td>
                  <div class="btn-group" data-toggle="buttons-radio">
                    <button class="btn">Left</button>
                    <button class="btn">Middle</button>
                    <button class="btn">Right</button>
                  </div>
               </td>
             </tr>
            </tbody>
          </table>
        </div>
      </div>
    </section>


876
    <!-- Collapse
877
878
    ================================================== -->

879
    <section id="collapse">
880
      <div class="page-header">
881
        <h1>collapse <small>bootstrap-collapse.js</small></h1>
882
883
884
      </div>
      <div class="row">
        <div class="span3 columns">
885
          <p>The collapse plugin offers simple, flexible collapsible element support for making accordions and other collapsible ui components.</p>
886
887
888
          <a href="../js/bootstrap-collapsible.js" target="_blank" class="btn primary">Download</a>
        </div>
        <div class="span9 columns">
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
          <h3>Using bootstrap-collapse.js</h3>
          <pre class="prettyprint linenums">$(".collapse").collapse()</pre>
          <h3>Options</h3>
          <table class="striped-table">
            <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>
               <td>If selector then all collapsible elements under the specified parent will be closed when this collasabile item is shown. (similar to traditional accordion behavior)</td>
             </tr>
             <tr>
               <td>toggle</td>
               <td>boolean</td>
               <td>true</td>
               <td>Toggles the collapsible element on invocation</td>
             </tr>
            </tbody>
          </table>
916
          <h3>Markup</h3>
917
918
919
920
921
922
          <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>
          <pre class="prettyprint linenums">
&lt;button class="btn danger" data-toggle="collapse" data-target="#demo"&gt;
  simple collapsible
&lt;/button&gt;

923
&lt;div id="demo" class="collapse in"&gt;&lt;/div&gt;</pre>
924
         <p><span class="label notice">Notice</span> To add accordion like group management to a collapsible control just add the additional data attribute <code>data-parent="#selector"</code>. Refer to the demo below to see this in action.</p>
925
          <h3>Methods</h3>
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
          <h4>.collapse(options)</h4>
          <p>Activates your content as a collapsible element. Accepts an optional options <code>object</code>.
<pre class="prettyprint linenums">
$('#myCollapsible').collapse({
  toggle: false
})</pre>
          <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>
          <table class="striped-table">
            <thead>
             <tr>
               <th style="width: 150px;">Event</th>
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>show</td>
               <td>This event fires immediately when the <code>show</code> instance method is called.</td>
             </tr>
             <tr>
               <td>shown</td>
               <td>This event is fired when a collapse element has been made visible to the user (will wait for css transitions to complete).</td>
             </tr>
             <tr>
               <td>hide</td>
               <td>
                This event is fired immediately when the <code>hide</code> method has been called.
               </td>
             </tr>
             <tr>
               <td>hidden</td>
               <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>
970

971
972
973
974
<pre class="prettyprint linenums">
$('#myCollapsible').bind('hidden', function () {
  // do something ...
})</pre>
975
976
          <h3>Demo</h3>

977
978
979
980
981
982
            <!-- single collapse -->
            <p>
              <button class="btn danger" data-toggle="collapse" data-target="#collapseDemoWrap">
                simple collapsible
              </button>
            </p>
983

984
            <div id="collapseDemoWrap" class="collapse">
985
986
              <!-- group collapse -->
              <dl id="accordion" >
987
988
989
990
                <dt>
                  <a data-toggle="collapse" data-parent="#accordion" href="#collapseOne">
                    Collapsible Group Item #1
                  </a>
991
                </dt>
992
                <dd id="collapseOne" class="collapse in">
993
994
995
996
                  <p>
                  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.
                  </p>
                </dd>
997
998
999
1000
                <dt>
                  <a data-toggle="collapse" data-parent="#accordion" href="#collapseTwo">
                    Collapsible Group Item #2
                  </a>
For faster browsing, not all history is shown. View entire blame