javascript.html 60.5 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
      </header>



58
59
60
61
62
63
64
65
66
      <!-- Using Javascript w/ Bootstrap
      ================================================== -->

      <section id="javascript">
        <div class="page-header">
          <h1>jQuery plugins <small>A dozen Bootstrap plugins to get you started</small></h1>
        </div>
      <div class="row">
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
67
          <h3><a href="./javascript.html#transition">Transitions</a> <small class="muted">*</small></h3>
68
69
70
71
          <p>For simple transition effects, include bootstrap-transition.js once to slide in modals or fade out alert messages.</p>
          <p class="muted"><strong>*</strong> Required for animation in plugins</p>
        </div>
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
72
          <h3><a href="./javascript.html#modal">Modals</a></h3>
73
74
75
          <p>A streamlined, but flexible, take on the traditional javascript modal plugin with only the minimum required functionality and smart defaults.</p>
        </div>
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
76
          <h3><a href="./javascript.html#dropdown">Dropdowns</a></h3>
77
78
79
          <p>Add dropdown menus to nearly anything in Bootstrap with this simple plugin. Bootstrap features full dropdown menu support on in the navbar, tabs, and pills.</p>
        </div>
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
80
          <h3><a href="./javascript.html#scrollspy">Scrollspy</a></h3>
81
82
83
84
85
          <p>Use scrollspy to automatically update the links in your navbar to show the current active link based on scroll position.</p>
        </div>
      </div> <!-- /row -->
      <div class="row">
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
86
          <h3><a href="./javascript.html#tab">Togglable tabs</a></h3>
87
88
89
          <p>Use this plugin to make tabs and pills more useful by allowing them to toggle through tabbable panes of local content.</p>
        </div>
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
90
          <h3><a href="./javascript.html#twipsy">Twipsy tooltips</a></h3>
91
92
93
          <p>A new take on the jQuery Tipsy plugin, Twipsy uses CSS3 animations, data attributes for titles, and the new event API in jQuery 1.7.</p>
        </div>
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
94
          <h3><a href="./javascript.html#popover">Popovers</a> <small class="muted">*</small></h3>
95
96
97
98
          <p>Add small overlays of content, like those on the iPad, to any element for housing secondary information.</p>
          <p class="muted"><strong>*</strong> Requires <a href="#twipsy">Twipsy</a> to be included</p>
        </div>
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
99
          <h3><a href="./javascript.html#alert">Alert messages</a></h3>
100
101
102
103
104
          <p>The alert plugin is a tiny class for adding close functionality to alerts.</p>
        </div>
      </div> <!-- /row -->
      <div class="row">
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
105
          <h3><a href="./javascript.html#button">Buttons</a></h3>
106
107
108
          <p>Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p>
        </div>
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
109
          <h3><a href="./javascript.html#collapse">Collapse</a></h3>
110
111
112
          <p>Get base styles and flexible support for collapsible components like accordions and navigation.</p>
        </div>
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
113
          <h3><a href="./javascript.html#carousel">Carousel</a></h3>
114
115
116
          <p>Create a merry-go-round of any content you wish to provide an interactive slideshow of content.</p>
        </div>
        <div class="span3">
Mark Otto's avatar
Mark Otto committed
117
          <h3><a href="./javascript.html#typeahead">Typeahead</a></h3>
118
119
120
121
122
123
          <p>A basic, easily extended plugin for quickly creating elegant typeaheads with any form text input.</p>
        </div>
      </div> <!-- /row -->
      <hr>
      <p class="muted"><span class="label warning">Note:</span> All plugins require the latest version of <a href="http://jquery.com/" target="_blank">jQuery</a> to be included.</p>
    </section>
124

Jacob Thornton's avatar
Jacob Thornton committed
125
126
127
128

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

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

218
<pre class="prettyprint linenums">
219
$('#myModal').on('hidden', function () {
220
221
  // do something ...
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
222
223
          <h3>Demo</h3>
          <!-- sample modal content -->
Jacob Thornton's avatar
Jacob Thornton committed
224
          <div id="myModal" class="modal hide fade">
Jacob Thornton's avatar
Jacob Thornton committed
225
            <div class="modal-header">
Jacob Thornton's avatar
Jacob Thornton committed
226
              <a href="#" class="close" data-dismiss="modal" >&times;</a>
Jacob Thornton's avatar
Jacob Thornton committed
227
              <h3>Modal Heading</h3>
Jacob Thornton's avatar
Jacob Thornton committed
228
229
            </div>
            <div class="modal-body">
230
231
232
233
234
235
236
237
              <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
238
239
            </div>
            <div class="modal-footer">
240
              <a href="#" class="btn primary">Save changes</a>
Jacob Thornton's avatar
Jacob Thornton committed
241
              <a href="#" class="btn" data-dismiss="modal" >Close</a>
Jacob Thornton's avatar
Jacob Thornton committed
242
243
            </div>
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
244

245
          <a data-toggle="modal" href="#myModal" class="btn danger">
246
            Launch Modal
247
          </a>
Jacob Thornton's avatar
Jacob Thornton committed
248
249
250
        </div>
      </div>
    </section>
251
252


Jacob Thornton's avatar
Jacob Thornton committed
253
254
255
256
257
    <!-- Dropdown
    ================================================== -->

    <section id="dropdown">
      <div class="page-header">
Jacob Thornton's avatar
Jacob Thornton committed
258
        <h1>Dropdown <small>bootstrap-dropdown.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
259
260
      </div>
      <div class="row">
261
        <div class="span3 columns">
262
          <p>This plugin is for adding generic dropdown interactions to things like navigation top bars and tabs.</p>
263
          <a href="../js/bootstrap-dropdown.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
264
        </div>
265
        <div class="span9 columns">
266
          <h3>Using bootstrap-dropdown.js</h3>
267
          <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre>
268
          <h3>Markup</h3>
269
270
271
          <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>

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

Jacob Thornton's avatar
Jacob Thornton committed
321
322
323
324
325
326
327
328
   <!-- ScrollSpy
    ================================================== -->

    <section id="scrollspy">
      <div class="page-header">
        <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
      </div>
      <div class="row">
329
        <div class="span3 columns">
330
          <p>The ScrollSpy plugin is for automatically updating nav targets based on scroll position.</p>
Jacob Thornton's avatar
Jacob Thornton committed
331
332
          <a href="../js/bootstrap-scrollspy.js" target="_blank" class="btn primary">Download</a>
        </div>
333
        <div class="span9 columns">
334
          <h2>Using bootstrap-scrollspy.js</h2>
335
          <pre class="prettyprint linenums">$('#navbar').dropdown()</pre>
336
          <h3>Markup</h3>
337
338
          <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>
339
           <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
340
          <h3>Demo</h3>
341
342
343
344
          <p>
            Scroll the area below and watch the navigation update. The dropdown sub items will be highlighted as well. Try it!</p>
          <p>

345
          <div id="navbarExample" class="navbar navbar-static">
346
347
348
349
350
351
352
            <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">
353
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
354
355
356
357
358
359
360
361
362
363
364
365
                    <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>

366
          <div data-spy="scroll" data-target="#navbarExample" class="scrollspy-example">
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
            <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
391
392
393
394
        </div>
      </div>
    </section>

Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
395
396
397
    <!-- Tabs
    ================================================== -->

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

&lt;script&gt;
  $(function () {
440
    $('.tabs a:last').tab('show')
441
442
  })
&lt;/script&gt;</pre>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
443
          </p>
444
          <h3>Events</h3>
445
          <table class="bordered-table striped-table">
446
447
448
449
450
451
452
453
            <thead>
             <tr>
               <th style="width: 150px;">Event</th>
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
454
455
456
457
               <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>
458
               <td>shown</td>
459
               <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>
460
461
462
463
464
             </tr>
            </tbody>
          </table>

          <pre class="prettyprint linenums">
465
$('a[data-toggle="tab"]').on('shown', function (e) {
466
467
468
  e.target // activated tab
  e.relatedTarget // previous tab
})</pre>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
469
          <h3>Demo</h3>
470
471

          <ul id="tab" class="nav tabs">
472
473
474
475
            <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>
476
            <li class="dropdown">
Jacob Thornton's avatar
Jacob Thornton committed
477
              <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown <b class="caret"></b></a>
478
              <ul class="dropdown-menu">
479
480
                <li><a href="#dropdown1" data-toggle="tab">@fat</a></li>
                <li><a href="#dropdown2" data-toggle="tab">@mdo</a></li>
481
482
483
              </ul>
            </li>
          </ul>
484
          <div id="myTabContent" class="tab-content">
485
            <div class="tab-pane fade in active" id="home">
486
487
              <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>
488
            <div class="tab-pane fade" id="profile">
489
490
              <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>
491
            <div class="tab-pane fade" id="messages">
492
493
              <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>
494
            <div class="tab-pane fade" id="settings">
495
496
              <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>
497
            <div class="tab-pane fade" id="dropdown1">
498
499
              <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>
500
            <div class="tab-pane fade" id="dropdown2">
501
              <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>
502
            </div>
Jacob Thornton's avatar
Jacob Thornton committed
503
504
505
506
507
          </div>
        </div>
      </div>
    </section>

508
    <!-- Twipsy
509
510
511
512
513
514
515
    ================================================== -->

    <section id="twipsy">
      <div class="page-header">
        <h1>Twipsy <small>bootstrap-twipsy.js</small></h1>
      </div>
      <div class="row">
516
        <div class="span3 columns">
517
          <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>
518
          <a href="../js/bootstrap-twipsy.js" target="_blank" class="btn primary">Download</a>
519
        </div>
520
        <div class="span9 columns">
521
          <h3>Using bootstrap-twipsy.js</h3>
522
523
          <pre class="prettyprint linenums">$('#example').twipsy(options)</pre>
          <h3>Options</h3>
524
          <table class="bordered-table striped-table">
525
526
527
528
529
530
531
532
533
534
            <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
535
               <td>animation</td>
536
537
538
539
540
541
542
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
               <td>placement</td>
               <td>string</td>
543
544
               <td>'top'</td>
               <td>how to position the tooltip - top | bottom | left | right</td>
545
546
             </tr>
             <tr>
547
548
               <td>selector</td>
               <td>string</td>
549
               <td>false</td>
550
               <td>If a selector is provided, twipsy objects will be delegated to the specified targets.</td>
551
552
             </tr>
             <tr>
553
554
555
556
               <td>title</td>
               <td>string | function</td>
               <td>''</td>
               <td>default title value if `title` tag isn't present</td>
557
558
559
560
561
562
563
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
564
565
566
567
568
569
570
571
572
573
             <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>
574
575
            </tbody>
          </table>
576
577
          <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>
578
579
          <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>
580
          <h3>Methods</h3>
581
          <h4>$().twipsy(options)</h4>
582
          <p>Attaches a twipsy handler to an element collection.</p>
583
          <h4>.twipsy('show')</h4>
584
          <p>Reveals an elements twipsy.</p>
585
586
          <pre class="prettyprint linenums">$('#element').twipsy('show')</pre>
          <h4>.twipsy('hide')</h4>
587
          <p>Hides an elements twipsy.</p>
588
          <pre class="prettyprint linenums">$('#element').twipsy('hide')</pre>
589
          <h3>Demo</h3>
590
591
          <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
592
593
            </p>
          </div>
594
595
596
597
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
598
599
600
601
602
603
604
605
    <!-- Popovers
    ================================================== -->

    <section id="popover">
      <div class="page-header">
        <h1>Popovers <small>bootstrap-popover.js</small></h1>
      </div>
      <div class="row">
606
        <div class="span3 columns">
607
          <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>
608
          <a href="../js/bootstrap-popover.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
609
        </div>
610
        <div class="span9 columns">
611
          <h3>Using bootstrap-popover.js</h3>
Jacob Thornton's avatar
Jacob Thornton committed
612
613
          <pre class="prettyprint linenums">$('#example').popover(options)</pre>
          <h3>Options</h3>
614
          <table class="bordered-table striped-table">
615
616
617
618
619
620
621
622
623
624
            <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
625
               <td>animation</td>
626
627
628
629
630
631
632
633
               <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
634
               <td>how to position the popover - top | bottom | left | right</td>
635
636
             </tr>
             <tr>
637
638
               <td>selector</td>
               <td>string</td>
639
               <td>false</td>
640
               <td>if a selector is provided, twipsy objects will be delegated to the specified targets</td>
641
642
643
644
645
646
647
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
             <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>
670
671
            </tbody>
          </table>
672
673
          <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>
674
          <p>
675
          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.
676
          </p>
Jacob Thornton's avatar
Jacob Thornton committed
677
          <h3>Methods</h3>
678
          <h4>$().popover(options)</h4>
Jacob Thornton's avatar
Jacob Thornton committed
679
          <p>Initializes popovers for an element collection.</p>
680
          <h4>.popover('show')</h4>
681
          <p>Reveals an elements popover.</p>
682
683
          <pre class="prettyprint linenums">$('#element').popover('show')</pre>
          <h4>.popover('hide')</h4>
684
          <p>Hides an elements popover.</p>
685
          <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
686
          <h3>Demo</h3>
687
          <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
688
689
690
        </div>
      </div>
    </section>
691

692

693
    <!-- Alert
694
695
    ================================================== -->

696
    <section id="alert">
697
      <div class="page-header">
698
        <h1>Alert <small>bootstrap-alert.js</small></h1>
699
700
      </div>
      <div class="row">
701
        <div class="span3 columns">
702
703
704
          <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>
705
        <div class="span9 columns">
706
          <h3>Using bootstrap-alerts.js</h3>
707
          <pre class="prettyprint linenums">$(".alert-message").alert()</pre>
708
          <h3>Markup</h3>
709
710
          <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>
711
          <h3>Methods</h3>
712
          <h4>$().alert()</h4>
713
          <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>
714
          <h4>.alert('close')</h4>
715
          <p>Closes an alert.</p>
716
          <pre class="prettyprint linenums">$(".alert-message").alert('close')</pre>
717
718
          <h3>Events</h3>
          <p>Bootstrap's alert class exposes a few events for hooking into alert functionality. </p>
719
          <table class="bordered-table striped-table">
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
            <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>
741
          <h3>Demo</h3>
742
743
          <div class="alert-message warning fade in">
            <a class="close" data-dismiss="alert" href="#">&times;</a>
744
745
            <p><strong>Holy guacamole!</strong> Best check yo self, you’re not looking too good.</p>
          </div>
746
747
          <div class="alert-message block-message error fade in">
            <a class="close" data-dismiss="alert" href="#">&times;</a>
748
749
750
751
752
753
754
755
756
            <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
757

758
    <!-- Button
759
760
    ================================================== -->

761
    <section id="button">
762
      <div class="page-header">
763
        <h1>Button <small>bootstrap-button.js</small></h1>
764
765
766
767
      </div>
      <div class="row">
        <div class="span3 columns">
          <p>This plugin offers additional functionality for managing button state.</p>
768
          <a href="../js/bootstrap-button.js" target="_blank" class="btn primary">Download</a>
769
770
        </div>
        <div class="span9 columns">
771
          <h3>Using bootstrap-button.js</h3>
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
          <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>
802
803
804
          <p>
            <span class="label notice">Notice</span> Firefox persists the disabled state across page loads. A workaround for this is to use: <code>autocomplete="off"</code>. More info can be found <a href="https://github.com/twitter/bootstrap/issues/793">here</a>.
          </p>
805
806
807
808
809
810
811
           <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')
812
&lt;/script&gt;</pre>
813
          <h3>Demo</h3>
814
          <table class="bordered-table striped-table">
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
            <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>


857
    <!-- Collapse
858
859
    ================================================== -->

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

904
&lt;div id="demo" class="collapse in"&gt;&lt;/div&gt;</pre>
905
         <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>
906
          <h3>Methods</h3>
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
          <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>
923
          <table class="bordered-table striped-table">
924
925
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
            <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>
951

952
<pre class="prettyprint linenums">
953
$('#myCollapsible').on('hidden', function () {
954
955
  // do something ...
})</pre>
956
957
          <h3>Demo</h3>

958
959
960
961
962
963
            <!-- single collapse -->
            <p>
              <button class="btn danger" data-toggle="collapse" data-target="#collapseDemoWrap">
                simple collapsible
              </button>
            </p>
964

965
            <div id="collapseDemoWrap" class="collapse">
966
967
              <!-- group collapse -->
              <dl id="accordion" >
968
969
970
971
                <dt>
                  <a data-toggle="collapse" data-parent="#accordion" href="#collapseOne">
                    Collapsible Group Item #1
                  </a>
972
                </dt>
973
                <dd id="collapseOne" class="collapse in">
974
975
976
977
                  <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>
978
979
980
981
                <dt>
                  <a data-toggle="collapse" data-parent="#accordion" href="#collapseTwo">
                    Collapsible Group Item #2
                  </a>
982
                </dt>
983
                <dd id="collapseTwo" class="collapse">
984
985
986
987
                  <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>
988
989
990
991
                <dt>
                  <a data-toggle="collapse" data-parent="#accordion" href="#collapseThree">
                    Collapsible Group Item #3
                  </a>
992
                </dt>
993
                <dd id="collapseThree" class="collapse">
994
995
996
997
998
999
                  <p>
                  Tempor gentrify pariatur nihil salvia, irony synth incididunt odio commodo brunch aute. Four loko est vice echo park wes anderson jean shorts, tempor ea vero locavore. Seitan DIY dolore readymade williamsburg viral. Dolor fap master cleanse delectus, ad butcher labore duis vice mollit cillum exercitation eu banh mi. Austin banksy 3 wolf moon locavore sed, helvetica next level VHS you probably haven't heard of them ethical odio. Incididunt locavore minim, do seitan consequat qui thundercats labore before they sold out retro laborum. Esse twee readymade laboris fap vice, voluptate DIY.
                  </p>
                </dd>
              </dl>
            </div>
1000
        </div>
For faster browsing, not all history is shown. View entire blame