javascript.html 60.2 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

Jacob Thornton's avatar
Jacob Thornton committed
26
27
  </head>

28
  <body id="bootstrap-js">
Jacob Thornton's avatar
Jacob Thornton committed
29

30
    <!-- Navbar
Jacob Thornton's avatar
Jacob Thornton committed
31
    ================================================== -->
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
    <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>
53
        <p class="lead">Bring Bootstrap's components to life &mdash; now with 12 custom <a href="http://jquery.com/" target="_blank">jQuery</a> plugins.
54
55
56
57
58
59
60
61
62
63
64
65
66
      </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>
67
       <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>
68
69
70
     </div>
     <div class="span9">
      <h3>What's included</h3>
71
       <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>
72
       <table class="bordered-table striped-table">
73
74
75
76
77
78
79
80
         <thead>
           <tr>
             <th style="width: 150px;">File</th>
             <th>Description</th>
           </tr>
         </thead>
         <tbody>
           <tr>
81
82
             <td><a href="./javascript.html#transition">bootstrap-transition.js</a></td>
             <td>The transition plugin is required for adding animation to other bootstrap plugins. Include this plugin (only once) when sliding in modals or fading out alerts.</td>
83
84
           </tr>
           <tr>
85
86
             <td><a href="./javascript.html#modal">bootstrap-modal.js</a></td>
             <td>Our Modal plugin is a super slim take on the traditional modal js plugin! We took special care to include only the bare functionality that we require here at twitter.</td>
87
88
           </tr>
           <tr>
89
             <td><a href="./javascript.html#dropdown">bootstrap-dropdown.js</a></td>
90
             <td>This plugin is for adding generic dropdown interactions to things like navigation top bars and tabs.</td>
91
92
93
           </tr>
           <tr>
             <td><a href="./javascript.html#scrollspy">bootstrap-scrollspy.js</a></td>
94
             <td>The ScrollSpy plugin is for automatically updating nav targets based on scroll position.</td>
95
96
           </tr>
           <tr>
97
             <td><a href="./javascript.html#tab">bootstrap-tab.js</a></td>
98
             <td>This plugin adds quick, dynamic tab and pill functionality for transitioning through local content.</td>
99
100
           <tr>
             <td><a href="./javascript.html#twipsy">bootstrap-twipsy.js</a></td>
101
             <td>Inspired by the excellent jQuery.tipsy plugin written by Jason Frame; twipsy is an updated version, which doesn't rely on images, uses css3 for animations, data-attributes for local title storage, and now jquery 1.7's new event api!</td>
102
103
104
           </tr>
           <tr>
             <td><a href="./javascript.html#popover">bootstrap-popover.js</a></td>
105
             <td>The popover plugin provides a simple interface for adding popovers to your application. It extends the <a href="#twipsy">bootstrap-twipsy.js</a> plugin, so be sure to grab that file as well when including popovers in your project!</td>
106
           </tr>
107
108
109
110
111
           </tr>
           <tr>
             <td><a href="./javascript.html#alert">bootstrap-alert.js</a></td>
             <td>The alert plugin is a tiny class for adding close functionality to alerts.</td>
           </tr>
112
           <tr>
113
              <td><a href="./javascript.html#button">bootstrap-button.js</a></td>
114
              <td>This plugin offers additional functionality for managing button state in single buttons and button sets.</td>
115
            </tr>
116
117
118
119
            <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>
120
            <tr>
121
122
              <td><a href="./javascript.html#carousel">bootstrap-carousel.js</a></td>
              <td>A plugin for rotating through elements. A merry-go-round.</td>
123
            </tr>
124
125
126
127
            <tr>
              <td><a href="./javascript.html#typeahead">bootstrap-typeahead.js</a></td>
              <td>A basic, easily extended plugin for quickly creating elegant typeaheads.</td>
            </tr>
128
129
130
131
132
133
134
135
         </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>
     </div>
   </div>
</section>
136

Jacob Thornton's avatar
Jacob Thornton committed
137
138
139
140

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

141
    <section id="modal">
Jacob Thornton's avatar
Jacob Thornton committed
142
      <div class="page-header">
143
        <h1>Modals <small>bootstrap-modal.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
144
145
      </div>
      <div class="row">
146
        <div class="span3 columns">
147
          <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>
148
          <a href="../js/bootstrap-modal.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
149
        </div>
150
        <div class="span9 columns">
151
          <h3>Using bootstrap-modal</h3>
152
          <pre class="prettyprint linenums">$('#myModal').modal(options)</pre>
Jacob Thornton's avatar
Jacob Thornton committed
153
          <h3>Options</h3>
154
          <table class="bordered-table striped-table">
155
156
157
158
159
160
161
162
163
164
165
166
            <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>
167
               <td>true</td>
168
169
170
171
172
               <td>Includes a modal-backdrop element</td>
             </tr>
             <tr>
               <td>keyboard</td>
               <td>boolean</td>
173
               <td>true</td>
174
175
176
177
178
               <td>Closes the modal when escape key is pressed</td>
             </tr>
            </tbody>
          </table>
          <h3>Markup</h3>
179
180
          <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.</p>
          <p>Also, to add options to your modal instance, just include them as additional data attributes on either the control element or the modal markup itself.</p>
181
<pre class="prettyprint linenums">
182
&lt;a class="btn" data-toggle="modal" href="#myModal" &gt;Launch Modal&lt;/a&gt;
183
</pre>
184
          <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
185
          <h3>Methods</h3>
186
187
          <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
188
<pre class="prettyprint linenums">
189
$('#myModal').modal({
190
  keyboard: false
191
})</pre>
192
193
          <h4>.modal('toggle')</h4>
          <p>Manually toggles a modal.</p>
194
          <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre>
195
196
          <h4>.modal('show')</h4>
          <p>Manually opens a modal.</p>
197
          <pre class="prettyprint linenums">$('#myModal').modal('show')</pre>
198
199
          <h4>.modal('hide')</h4>
          <p>Manually hides a modal.</p>
200
          <pre class="prettyprint linenums">$('#myModal').modal('hide')</pre>
201
          <h3>Events</h3>
202
          <p>Bootstrap's modal class exposes a few events for hooking into modal functionality. </p>
203
          <table class="bordered-table striped-table">
204
205
            <thead>
             <tr>
206
               <th style="width: 150px;">Event</th>
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
               <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>

230
<pre class="prettyprint linenums">
231
$('#myModal').on('hidden', function () {
232
233
  // do something ...
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
234
235
          <h3>Demo</h3>
          <!-- sample modal content -->
Jacob Thornton's avatar
Jacob Thornton committed
236
          <div id="myModal" class="modal hide fade">
Jacob Thornton's avatar
Jacob Thornton committed
237
            <div class="modal-header">
Jacob Thornton's avatar
Jacob Thornton committed
238
              <a href="#" class="close" data-dismiss="modal" >&times;</a>
Jacob Thornton's avatar
Jacob Thornton committed
239
              <h3>Modal Heading</h3>
Jacob Thornton's avatar
Jacob Thornton committed
240
241
            </div>
            <div class="modal-body">
242
243
244
245
246
247
248
249
              <h4>Text in a modal</h4>
              <p>Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem.</p>

              <h4>Popover in a modal</h4>
              <p>This <a href="#" class="btn" rel="popover" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">button</a> should trigger a popover on hover.</p>

              <h4>Twipsy tooltips in a modal</h4>
              <p><a href="#" class="twipsy-test" title="Tooltip">This link</a> and <a href="#" class="twipsy-test" title="Tooltip">that link</a> should have Twipsy tooltips on hover.</p>
Jacob Thornton's avatar
Jacob Thornton committed
250
251
            </div>
            <div class="modal-footer">
252
              <a href="#" class="btn primary">Save changes</a>
Jacob Thornton's avatar
Jacob Thornton committed
253
              <a href="#" class="btn" data-dismiss="modal" >Close</a>
Jacob Thornton's avatar
Jacob Thornton committed
254
255
            </div>
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
256

257
          <a data-toggle="modal" href="#myModal" class="btn danger">
258
            Launch Modal
259
          </a>
Jacob Thornton's avatar
Jacob Thornton committed
260
261
262
        </div>
      </div>
    </section>
263
264


Jacob Thornton's avatar
Jacob Thornton committed
265
266
267
268
269
    <!-- Dropdown
    ================================================== -->

    <section id="dropdown">
      <div class="page-header">
Jacob Thornton's avatar
Jacob Thornton committed
270
        <h1>Dropdown <small>bootstrap-dropdown.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
271
272
      </div>
      <div class="row">
273
        <div class="span3 columns">
274
          <p>This plugin is for adding generic dropdown interactions to things like navigation top bars and tabs.</p>
275
          <a href="../js/bootstrap-dropdown.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
276
        </div>
277
        <div class="span9 columns">
278
          <h3>Using bootstrap-dropdown.js</h3>
279
          <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre>
280
          <h3>Markup</h3>
281
282
283
          <p>To quickly add dropdown functionality to any element just add <code>data-toggle="dropdown"</code> and any valid bootstrap dropdown will automatically be activated.</p>
          <p><span class="label notice">Notice</span> For added control and flexibility, optionally specify a <code>data-target="#fat"</code> or <code>href="#fat"</code> - this allows you to target specific dropdowns.</p>

284
285
286
<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;
287
  &lt;li id="secondary" class="dropdown"&gt;
288
    &lt;a href="#secondary" class="dropdown-toggle" data-toggle="dropdown"&gt;Dropdown &lt;b class="caret"&gt;&lt;/b&gt;&lt;/a&gt;
289
290
291
292
293
294
295
296
297
298
    &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
299
          <p>
300
          A programatic api for activating menus for a given navbar or tabbed navigation.
Jacob Thornton's avatar
Jacob Thornton committed
301
302
          </p>
          <h3>Demo</h3>
303
          <div id="navbar-example" class="navbar navbar-static">
304
305
306
307
308
309
310
            <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
311
                <form class="form-search navbar-search pull-left" action="">
312
                  <input type="text" class="search-query span2" placeholder="Search">
313
                </form>
314
                <ul class="nav pull-right">
315
                  <li id="fat-menu" class="dropdown">
316
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown 1 <b class="caret"></b></a>
317
                    <ul class="dropdown-menu">
318
319
                      <li><a href="#">Action</a></li>
                      <li><a href="#">Another action</a></li>
320
321
                      <li><a href="#">Something else here</a></li>
                      <li class="divider"></li>
322
                      <li><a href="#">Separated link</a></li>
323
324
325
                    </ul>
                  </li>
                </ul>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
326
327
328
329
330
331
332
              </div>
            </div>
          </div>
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
333
334
335
336
337
338
339
340
   <!-- ScrollSpy
    ================================================== -->

    <section id="scrollspy">
      <div class="page-header">
        <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
      </div>
      <div class="row">
341
        <div class="span3 columns">
342
          <p>The ScrollSpy plugin is for automatically updating nav targets based on scroll position.</p>
Jacob Thornton's avatar
Jacob Thornton committed
343
344
          <a href="../js/bootstrap-scrollspy.js" target="_blank" class="btn primary">Download</a>
        </div>
345
        <div class="span9 columns">
346
          <h2>Using bootstrap-scrollspy.js</h2>
347
          <pre class="prettyprint linenums">$('#navbar').dropdown()</pre>
348
          <h3>Markup</h3>
349
350
          <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>
351
           <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
352
          <h3>Demo</h3>
353
354
355
356
          <p>
            Scroll the area below and watch the navigation update. The dropdown sub items will be highlighted as well. Try it!</p>
          <p>

357
          <div id="navbarExample" class="navbar navbar-static">
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
            <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>

378
          <div data-spy="scroll" data-target="#navbarExample" class="scrollspy-example">
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
            <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
403
404
405
406
        </div>
      </div>
    </section>

Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
407
408
409
    <!-- Tabs
    ================================================== -->

410
    <section id="tab">
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
411
      <div class="page-header">
412
        <h1>Tab <small>bootstrap-tab.js</small></h1>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
413
414
      </div>
      <div class="row">
415
        <div class="span3 columns">
416
          <p>This plugin adds quick, dynamic tab and pill functionality for transitioning through local content.</p>
417
          <a href="../js/bootstrap-tab.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
418
        </div>
419
        <div class="span9 columns">
420
          <h3>Using bootstrap-tab.js</h3>
421
          <pre class="prettyprint linenums">$('#myTab').tab('show')</pre>
422
          <h3>Markup</h3>
423
424
425
426
427
428
429
          <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>
430
          <h3>Methods</h3>
431
          <h4>$().tab</h4>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
432
          <p>
433
            Activates a tab element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the dom.
434
435
          </p>
<pre class="prettyprint linenums">
Jacob Thornton's avatar
Jacob Thornton committed
436
&lt;ul class="tabs"&gt;
437
438
439
440
441
442
  &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
443
&lt;div class="pill-content"&gt;
444
445
446
447
  &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;
448
&lt;/div&gt;
449
450
451

&lt;script&gt;
  $(function () {
452
    $('.tabs a:last').tab('show')
453
454
  })
&lt;/script&gt;</pre>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
455
          </p>
456
          <h3>Events</h3>
457
          <table class="bordered-table striped-table">
458
459
460
461
462
463
464
465
            <thead>
             <tr>
               <th style="width: 150px;">Event</th>
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
466
467
468
469
               <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>
470
               <td>shown</td>
471
               <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>
472
473
474
475
476
             </tr>
            </tbody>
          </table>

          <pre class="prettyprint linenums">
477
$('a[data-toggle="tab"]').on('shown', function (e) {
478
479
480
  e.target // activated tab
  e.relatedTarget // previous tab
})</pre>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
481
          <h3>Demo</h3>
482
483
484
485
486
          <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>
487
488
489
            <li class="dropdown">
              <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown</a>
              <ul class="dropdown-menu">
490
491
                <li><a href="#dropdown1" data-toggle="tab">@fat</a></li>
                <li><a href="#dropdown2" data-toggle="tab">@mdo</a></li>
492
493
494
              </ul>
            </li>
          </ul>
495
          <div id="myTabContent" class="tab-content">
496
            <div class="tab-pane fade in active" id="home">
497
498
              <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>
499
            <div class="tab-pane fade" id="profile">
500
501
              <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>
502
            <div class="tab-pane fade" id="messages">
503
504
              <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>
505
            <div class="tab-pane fade" id="settings">
506
507
              <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>
508
            <div class="tab-pane fade" id="dropdown1">
509
510
              <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>
511
            <div class="tab-pane fade" id="dropdown2">
512
              <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>
513
            </div>
Jacob Thornton's avatar
Jacob Thornton committed
514
515
516
517
518
          </div>
        </div>
      </div>
    </section>

519
520
521
522
523
524
525
526
    <!-- Tips
    ================================================== -->

    <section id="twipsy">
      <div class="page-header">
        <h1>Twipsy <small>bootstrap-twipsy.js</small></h1>
      </div>
      <div class="row">
527
        <div class="span3 columns">
528
          <p>Inspired by the excellent jQuery.tipsy plugin written by Jason Frame; twipsy is an updated version, which doesn't rely on images, uses css3 for animations, data-attributes for local title storage, and now jquery 1.7's new event api!</p>
529
          <a href="../js/bootstrap-twipsy.js" target="_blank" class="btn primary">Download</a>
530
        </div>
531
        <div class="span9 columns">
532
          <h3>Using bootstrap-twipsy.js</h3>
533
534
          <pre class="prettyprint linenums">$('#example').twipsy(options)</pre>
          <h3>Options</h3>
535
          <table class="bordered-table striped-table">
536
537
538
539
540
541
542
543
544
545
            <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>
Jacob Thornton's avatar
Jacob Thornton committed
546
               <td>animation</td>
547
548
549
550
551
552
553
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
               <td>placement</td>
               <td>string</td>
554
555
               <td>'top'</td>
               <td>how to position the tooltip - top | bottom | left | right</td>
556
557
             </tr>
             <tr>
558
559
               <td>selector</td>
               <td>string</td>
560
               <td>false</td>
561
               <td>If a selector is provided, twipsy objects will be delegated to the specified targets.</td>
562
563
             </tr>
             <tr>
564
565
566
567
               <td>title</td>
               <td>string | function</td>
               <td>''</td>
               <td>default title value if `title` tag isn't present</td>
568
569
570
571
572
573
574
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
575
576
577
578
579
580
581
582
583
584
             <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>
585
586
            </tbody>
          </table>
587
588
          <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>
589
590
          <p>
          For performance reasons, the Twipsy and Popover data-apis are opt in. If you would like to use them just specify a selector option.</p>
591
          <h3>Methods</h3>
592
          <h4>$().twipsy(options)</h4>
593
          <p>Attaches a twipsy handler to an element collection.</p>
594
          <h4>.twipsy('show')</h4>
595
          <p>Reveals an elements twipsy.</p>
596
597
          <pre class="prettyprint linenums">$('#element').twipsy('show')</pre>
          <h4>.twipsy('hide')</h4>
598
          <p>Hides an elements twipsy.</p>
599
          <pre class="prettyprint linenums">$('#element').twipsy('hide')</pre>
600
          <h3>Demo</h3>
601
602
          <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
603
604
            </p>
          </div>
605
606
607
608
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
609
610
611
612
613
614
615
616
    <!-- Popovers
    ================================================== -->

    <section id="popover">
      <div class="page-header">
        <h1>Popovers <small>bootstrap-popover.js</small></h1>
      </div>
      <div class="row">
617
        <div class="span3 columns">
618
          <p>The popover plugin provides a simple interface for adding popovers to your application. It extends the <a href="#twipsy">bootstrap-twipsy.js</a> plugin, so be sure to grab that file as well when including popovers in your project!</p>
619
          <a href="../js/bootstrap-popover.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
620
        </div>
621
        <div class="span9 columns">
622
          <h3>Using bootstrap-popover.js</h3>
Jacob Thornton's avatar
Jacob Thornton committed
623
624
          <pre class="prettyprint linenums">$('#example').popover(options)</pre>
          <h3>Options</h3>
625
          <table class="bordered-table striped-table">
626
627
628
629
630
631
632
633
634
635
            <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>
Jacob Thornton's avatar
Jacob Thornton committed
636
               <td>animation</td>
637
638
639
640
641
642
643
644
               <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>'right'</td>
Jacob Thornton's avatar
Jacob Thornton committed
645
               <td>how to position the popover - top | bottom | left | right</td>
646
647
             </tr>
             <tr>
648
649
               <td>selector</td>
               <td>string</td>
650
               <td>false</td>
651
               <td>if a selector is provided, twipsy objects will be delegated to the specified targets</td>
652
653
654
655
656
657
658
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
             <tr>
               <td>title</td>
               <td>string | function</td>
               <td>''</td>
               <td>default title value if `title` attribute isn't present</td>
             </tr>
             <tr>
               <td>content</td>
               <td>string | function</td>
               <td>''</td>
               <td>default content value if `data-content` attribute isn't present</td>
             </tr>
             <tr>
               <td>delay</td>
               <td>number | object</td>
               <td>0</td>
               <td>
                <p>delay showing/hiding the popover (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>
681
682
            </tbody>
          </table>
683
684
          <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>
685
          <p>
686
          For performance reasons, the Twipsy and Popover data-apis are opt in. If you would like to use them just specify a the selector option.
687
          </p>
Jacob Thornton's avatar
Jacob Thornton committed
688
          <h3>Methods</h3>
689
          <h4>$().popover(options)</h4>
Jacob Thornton's avatar
Jacob Thornton committed
690
          <p>Initializes popovers for an element collection.</p>
691
          <h4>.popover('show')</h4>
692
          <p>Reveals an elements popover.</p>
693
694
          <pre class="prettyprint linenums">$('#element').popover('show')</pre>
          <h4>.popover('hide')</h4>
695
          <p>Hides an elements popover.</p>
696
          <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
697
          <h3>Demo</h3>
698
          <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
699
700
701
        </div>
      </div>
    </section>
702

703

704
    <!-- Alert
705
706
    ================================================== -->

707
    <section id="alert">
708
      <div class="page-header">
709
        <h1>Alert <small>bootstrap-alert.js</small></h1>
710
711
      </div>
      <div class="row">
712
        <div class="span3 columns">
713
714
715
          <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>
716
        <div class="span9 columns">
717
          <h3>Using bootstrap-alerts.js</h3>
718
          <pre class="prettyprint linenums">$(".alert-message").alert()</pre>
719
          <h3>Markup</h3>
720
721
          <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>
722
          <h3>Methods</h3>
723
          <h4>$().alert()</h4>
724
          <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>
725
          <h4>.alert('close')</h4>
726
          <p>Closes an alert.</p>
727
          <pre class="prettyprint linenums">$(".alert-message").alert('close')</pre>
728
729
          <h3>Events</h3>
          <p>Bootstrap's alert class exposes a few events for hooking into alert functionality. </p>
730
          <table class="bordered-table striped-table">
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
            <thead>
             <tr>
               <th style="width: 150px;">Event</th>
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>close</td>
               <td>This event fires immediately when the <code>close</code> instance method is called.</td>
             </tr>
             <tr>
               <td>closed</td>
               <td>This event is fired when the alert has been closed (will wait for css transitions to complete).</td>
             </tr>
            </tbody>
          </table>
<pre class="prettyprint linenums">
$('#my-alert').bind('closed', function () {
  // do something ...
})</pre>
752
          <h3>Demo</h3>
753
754
          <div class="alert-message warning fade in">
            <a class="close" data-dismiss="alert" href="#">&times;</a>
755
756
            <p><strong>Holy guacamole!</strong> Best check yo self, you’re not looking too good.</p>
          </div>
757
758
          <div class="alert-message block-message error fade in">
            <a class="close" data-dismiss="alert" href="#">&times;</a>
759
760
761
762
763
764
765
766
767
            <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
768

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

772
    <section id="button">
773
      <div class="page-header">
774
        <h1>Button <small>bootstrap-button.js</small></h1>
775
776
777
778
      </div>
      <div class="row">
        <div class="span3 columns">
          <p>This plugin offers additional functionality for managing button state.</p>
779
          <a href="../js/bootstrap-button.js" target="_blank" class="btn primary">Download</a>
780
781
        </div>
        <div class="span9 columns">
782
          <h3>Using bootstrap-button.js</h3>
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
          <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')
820
&lt;/script&gt;</pre>
821
          <h3>Demo</h3>
822
          <table class="bordered-table striped-table">
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
            <tbody>
             <tr>
               <td>Stateful</td>
               <td>
                  <button id="fat-btn" data-loading-text="loading..." class="btn">
                    Loading State
                  </button>
                </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>


865
    <!-- Collapse
866
867
    ================================================== -->

868
    <section id="collapse">
869
      <div class="page-header">
870
        <h1>collapse <small>bootstrap-collapse.js</small></h1>
871
872
873
      </div>
      <div class="row">
        <div class="span3 columns">
874
          <p>The collapse plugin offers simple, flexible collapsible element support for making accordions and other collapsible ui components.</p>
875
          <a href="../js/bootstrap-collapse.js" target="_blank" class="btn primary">Download</a>
876
877
        </div>
        <div class="span9 columns">
878
879
880
          <h3>Using bootstrap-collapse.js</h3>
          <pre class="prettyprint linenums">$(".collapse").collapse()</pre>
          <h3>Options</h3>
881
          <table class="bordered-table striped-table">
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
            <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>
905
          <h3>Markup</h3>
906
907
908
909
910
911
          <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;

912
&lt;div id="demo" class="collapse in"&gt;&lt;/div&gt;</pre>
913
         <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>
914
          <h3>Methods</h3>
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
          <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>
931
          <table class="bordered-table striped-table">
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
            <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>
959

960
<pre class="prettyprint linenums">
961
$('#myCollapsible').on('hidden', function () {
962
963
  // do something ...
})</pre>
964
965
          <h3>Demo</h3>

966
967
968
969
970
971
            <!-- single collapse -->
            <p>
              <button class="btn danger" data-toggle="collapse" data-target="#collapseDemoWrap">
                simple collapsible
              </button>
            </p>
972

973
            <div id="collapseDemoWrap" class="collapse">
974
975
              <!-- group collapse -->
              <dl id="accordion" >
976
977
978
979
                <dt>
                  <a data-toggle="collapse" data-parent="#accordion" href="#collapseOne">
                    Collapsible Group Item #1
                  </a>
980
                </dt>
981
                <dd id="collapseOne" class="collapse in">
982
983
984
985
                  <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>
986
987
988
989
                <dt>
                  <a data-toggle="collapse" data-parent="#accordion" href="#collapseTwo">
                    Collapsible Group Item #2
                  </a>
990
                </dt>
991
                <dd id="collapseTwo" class="collapse">
992
993
994
995
                  <p>
                  Blog +1 eiusmod, williamsburg chambray craft beer brooklyn. Trust fund squid whatever, sunt hoodie skateboard mustache 3 wolf moon art party wes anderson ad leggings officia. Skateboard keytar incididunt gluten-free retro sartorial, single-origin coffee et viral. Art party blog sunt, readymade fugiat 8-bit aesthetic ex echo park fanny pack keytar. Thundercats sustainable labore, mustache adipisicing tattooed dolore aute occaecat velit 8-bit raw denim letterpress. In occaecat freegan, next level single-origin coffee chambray excepteur nihil duis exercitation adipisicing ex sartorial twee squid. You probably haven't heard of them fugiat ea retro eiusmod quis cosby sweater, +1 fap sapiente biodiesel banksy.
                  </p>
                </dd>
996
997
998
999
                <dt>
                  <a data-toggle="collapse" data-parent="#accordion" href="#collapseThree">
                    Collapsible Group Item #3
                  </a>
1000
                </dt>
For faster browsing, not all history is shown. View entire blame