javascript.html 38.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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

    <!-- Le javascript -->
    <!-- placed up here so that the inline demos can be next to their markup -->
    <script src="http://code.jquery.com/jquery-1.7.js"></script>
    <script src="http://autobahn.tablesorter.com/jquery.tablesorter.min.js"></script>
    <script src="assets/js/google-code-prettify/prettify.js"></script>
    <script>$(function () { prettyPrint() })</script>
    <script src="../js/bootstrap-transitions.js"></script>
    <script src="../js/bootstrap-alerts.js"></script>
    <script src="../js/bootstrap-modal.js"></script>
    <script src="../js/bootstrap-dropdown.js"></script>
    <script src="../js/bootstrap-scrollspy.js"></script>
    <script src="../js/bootstrap-tabs.js"></script>
    <script src="../js/bootstrap-twipsy.js"></script>
    <script src="../js/bootstrap-popover.js"></script>
    <script>
      $(function () {

        // twipsy demo
        $("a[rel=twipsy]").twipsy({
          live: true
        })

        //popover demo
        $("a[rel=popover]")
          .popover({
            offset: 10
          })
          .click(function(e) {
            e.preventDefault()
          })
      })
    </script>

Jacob Thornton's avatar
Jacob Thornton committed
59
60
  </head>

61
  <body id="bootstrap-js">
Jacob Thornton's avatar
Jacob Thornton committed
62

63
    <!-- Navbar
Jacob Thornton's avatar
Jacob Thornton committed
64
    ================================================== -->
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
    <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>
        <p class="lead">Bring Bootstrap's components to life with custom plugins for <a href="http://jquery.com/" target="_blank">jQuery</a> and <a href="http://ender.no.de" target="_blank">Ender</a></p>
      </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>
100
       <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>
101
102
103
104
     </div>
     <div class="span9">
      <h3>What's included</h3>
       <p>Bring some of Bootstrap's primary components to life with new custom plugins that work with <a href="http://jquery.com/" target="_blank">jQuery</a> and <a href="http://ender.no.de" target="_blank">Ender</a>. We encourage you to extend and modify them to fit your specific development needs.</p>
105
       <table class="striped-table">
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
         <thead>
           <tr>
             <th style="width: 150px;">File</th>
             <th>Description</th>
           </tr>
         </thead>
         <tbody>
           <tr>
             <td><a href="./javascript.html#modal">bootstrap-modal.js</a></td>
             <td>Our Modal plugin is a <strong>super</strong> slim take on the traditional modal js plugin! We took special care to include only the bare functionality that we require at twitter.</td>
           </tr>
           <tr>
             <td><a href="./javascript.html#alerts">bootstrap-alerts.js</a></td>
             <td>The alert plugin is a super tiny class for adding close functionality to alerts.</td>
           </tr>
           <tr>
122
             <td><a href="./javascript.html#dropdown">bootstrap-dropdown.js</a></td>
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
             <td>This plugin is for adding dropdown interaction to the bootstrap navbar or tabbed navigations.</td>
           </tr>
           <tr>
             <td><a href="./javascript.html#scrollspy">bootstrap-scrollspy.js</a></td>
             <td>The ScrollSpy plugin is for adding an auto updating nav based on scroll position to the bootstrap navbar.</td>
           </tr>
           <tr>
             <td><a href="./javascript.html#tabs">bootstrap-tabs.js</a></td>
             <td>This plugin adds quick, dynamic tab and pill functionality for cycling through local content.</td>
           </tr>
           <tr>
             <td><a href="./javascript.html#twipsy">bootstrap-twipsy.js</a></td>
             <td>Based on the excellent jQuery.tipsy plugin written by Jason Frame; twipsy is an updated version, which doesn't rely on images, uses css3 for animations, and data-attributes for local title storage!</td>
           </tr>
           <tr>
             <td><a href="./javascript.html#popover">bootstrap-popover.js</a></td>
             <td>The popover plugin provides a simple interface for adding popovers to your application. It extends the <a href="#twipsy">boostrap-twipsy.js</a> plugin, so be sure to grab that file as well when including popovers in your project!</td>
           </tr>
         </tbody>
       </table>
       <h3>Is javascript necessary?</h3>
       <p><strong>Nope!</strong> Bootstrap is designed first and foremost to be a CSS library. This javascript provides a basic interactive layer on top of the included styles.</p>
       <p>However, for those who do need javascript, we've provided the plugins above to help you understand how to integrate Bootstrap with javascript and to give you a quick, lightweight option for the basic functionality right away.</p>
       <p>For more information and to see some live demos, please refer to our <a href="./javascript.html">plugin documentation page</a>.</p>
     </div>
   </div>
</section>
150

Jacob Thornton's avatar
Jacob Thornton committed
151
152
153
154

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

155
    <section id="modal">
Jacob Thornton's avatar
Jacob Thornton committed
156
      <div class="page-header">
157
        <h1>Modals <small>bootstrap-modal.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
158
159
      </div>
      <div class="row">
160
        <div class="span3 columns">
161
          <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>
162
          <a href="../js/bootstrap-modal.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
163
        </div>
164
        <div class="span9 columns">
165
          <h3>Using bootstrap-modal</h3>
166
          <pre class="prettyprint linenums">$('#my-modal').modal(options)</pre>
Jacob Thornton's avatar
Jacob Thornton committed
167
          <h3>Options</h3>
168
          <table class="striped-table">
169
170
171
172
173
174
175
176
177
178
179
180
            <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>
181
               <td>true</td>
182
183
184
185
186
               <td>Includes a modal-backdrop element</td>
             </tr>
             <tr>
               <td>keyboard</td>
               <td>boolean</td>
187
               <td>true</td>
188
189
190
191
192
               <td>Closes the modal when escape key is pressed</td>
             </tr>
             <tr>
               <td>show</td>
               <td>boolean</td>
193
               <td>true</td>
194
195
196
197
198
               <td>Opens modal on class initialization</td>
             </tr>
            </tbody>
          </table>
          <h3>Markup</h3>
199
          <p>You can activate modals on your page easily without having to write a single line of javascript. Just give an element a <code>data-controls-modal</code> attribute which corresponds to a modal element id, and when clicked, it will launch your modal. To add modal options, just include them as data attributes.</p>
200
201
202
<pre class="prettyprint linenums">
&lt;a class="btn" data-controls-modal="my-modal" data-backdrop="true" &gt;Launch Modal&lt;/a&gt;
</pre>
203
          <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
204
          <h3>Methods</h3>
205
206
          <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
207
<pre class="prettyprint linenums">
208
$('#my-modal').modal({
209
  keyboard: false
210
})</pre>
211
212
213
214
215
216
217
218
219
          <h4>.modal('toggle')</h4>
          <p>Manually toggles a modal.</p>
          <pre class="prettyprint linenums">$('#my-modal').modal('toggle')</pre>
          <h4>.modal('show')</h4>
          <p>Manually opens a modal.</p>
          <pre class="prettyprint linenums">$('#my-modal').modal('show')</pre>
          <h4>.modal('hide')</h4>
          <p>Manually hides a modal.</p>
          <pre class="prettyprint linenums">$('#my-modal').modal('hide')</pre>
220
          <h3>Events</h3>
221
          <p>Bootstrap's modal class exposes a few events for hooking into modal functionality. </p>
222
          <table class="striped-table">
223
224
            <thead>
             <tr>
225
               <th style="width: 150px;">Event</th>
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
               <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>

249
<pre class="prettyprint linenums">
250
251
252
$('#my-modal').bind('hidden', function () {
  // do something ...
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
253
254
          <h3>Demo</h3>
          <!-- sample modal content -->
255
          <div id="modal-from-dom" class="modal hide fade">
Jacob Thornton's avatar
Jacob Thornton committed
256
            <div class="modal-header">
257
              <a href="#" class="close" data-modal-dismiss="true" >&times;</a>
Jacob Thornton's avatar
Jacob Thornton committed
258
              <h3>Modal Heading</h3>
Jacob Thornton's avatar
Jacob Thornton committed
259
260
261
262
263
            </div>
            <div class="modal-body">
              <p>One fine body…</p>
            </div>
            <div class="modal-footer">
264
              <a href="#" class="btn primary">Save changes</a>
265
              <a href="#" class="btn" data-modal-dismiss="true" >Close</a>
Jacob Thornton's avatar
Jacob Thornton committed
266
267
            </div>
          </div>
268
          <button data-controls-modal="modal-from-dom" class="btn danger">Launch Modal</button>
Jacob Thornton's avatar
Jacob Thornton committed
269
270
271
        </div>
      </div>
    </section>
272
273


Jacob Thornton's avatar
Jacob Thornton committed
274
275
276
277
278
    <!-- Dropdown
    ================================================== -->

    <section id="dropdown">
      <div class="page-header">
Jacob Thornton's avatar
Jacob Thornton committed
279
        <h1>Dropdown <small>bootstrap-dropdown.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
280
281
      </div>
      <div class="row">
282
        <div class="span3 columns">
283
          <p>This plugin is for adding dropdown interaction to the Bootstrap navbar or tabbed navigations.</p>
284
          <a href="../js/bootstrap-dropdown.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
285
        </div>
286
        <div class="span9 columns">
287
          <h3>Using boostrap-dropdown.js</h3>
288
          <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre>
289
          <h3>Markup</h3>
290
          <p>To quickly add dropdown functionality to any element just add <code>data-toggle="dropdown"</code>. Any valid bootstrap dropdown will automatically be activated.</p>
291
292
293
<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;
294
295
  &lt;li class="dropdown"&gt;
    &lt;a href="#" class="dropdown-toggle" data-toggle="dropdown"&gt;Dropdown&lt;/a&gt;
296
297
298
299
300
301
302
303
304
305
    &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
306
          <p>
307
          A programatic api for activating menus for a given navbar or tabbed navigation.
Jacob Thornton's avatar
Jacob Thornton committed
308
309
          </p>
          <h3>Demo</h3>
310
          <div id="navbar-example" class="navbar navbar-static">
311
312
313
314
315
316
317
            <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
318
                <form class="form-search navbar-search pull-left" action="">
319
                  <input type="text" class="search-query span2" placeholder="Search">
320
321
322
                </form>
                <ul class="nav secondary-nav">
                  <li class="dropdown">
323
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown 1</a>
324
325
326
327
328
329
330
331
                    <ul class="dropdown-menu">
                      <li><a href="#">Secondary link</a></li>
                      <li><a href="#">Something else here</a></li>
                      <li class="divider"></li>
                      <li><a href="#">Another link</a></li>
                    </ul>
                  </li>
                  <li class="dropdown">
332
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown 2</a>
333
334
335
336
337
338
339
340
                    <ul class="dropdown-menu">
                      <li><a href="#">Secondary link</a></li>
                      <li><a href="#">Something else here</a></li>
                      <li class="divider"></li>
                      <li><a href="#">Another link</a></li>
                    </ul>
                  </li>
                </ul>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
341
342
343
344
345
346
347
              </div>
            </div>
          </div>
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
348
349
350
351
352
353
354
355
   <!-- ScrollSpy
    ================================================== -->

    <section id="scrollspy">
      <div class="page-header">
        <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
      </div>
      <div class="row">
356
        <div class="span3 columns">
357
          <p>This plugin is for adding the scrollspy (auto updating nav) interaction to the bootstrap navbar.</p>
Jacob Thornton's avatar
Jacob Thornton committed
358
359
          <a href="../js/bootstrap-scrollspy.js" target="_blank" class="btn primary">Download</a>
        </div>
360
        <div class="span9 columns">
Jacob Thornton's avatar
Jacob Thornton committed
361
          <h2>Using boostrap-scrollspy.js</h2>
362
          <pre class="prettyprint linenums">$('#navbar').dropdown()</pre>
363
          <h3>Markup</h3>
364
365
          <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>
366
           <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
367
          <h3>Demo</h3>
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
          <p>
            Scroll the area below and watch the navigation update. The dropdown sub items will be highlighted as well. Try it!</p>
          <p>

          <div id="navbar-example" class="navbar navbar-static">
            <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>

          <div data-spy="scroll" class="scrollspy-example">
            <h4 id="fat">@fat</h4>
            <p>
            Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.
            </p>
            <h4 id="mdo">@mdo</h4>
            <p>
            Veniam marfa mustache skateboard, adipisicing fugiat velit pitchfork beard. Freegan beard aliqua cupidatat mcsweeney's vero. Cupidatat four loko nisi, ea helvetica nulla carles. Tattooed cosby sweater food truck, mcsweeney's quis non freegan vinyl. Lo-fi wes anderson +1 sartorial. Carles non aesthetic exercitation quis gentrify. Brooklyn adipisicing craft beer vice keytar deserunt.
            </p>
            <h4 id="one">one</h4>
            <p>
            Occaecat commodo aliqua delectus. Fap craft beer deserunt skateboard ea. Lomo bicycle rights adipisicing banh mi, velit ea sunt next level locavore single-origin coffee in magna veniam. High life id vinyl, echo park consequat quis aliquip banh mi pitchfork. Vero VHS est adipisicing. Consectetur nisi DIY minim messenger bag. Cred ex in, sustainable delectus consectetur fanny pack iphone.
            </p>
            <h4 id="two">two</h4>
            <p>
            In incididunt echo park, officia deserunt mcsweeney's proident master cleanse thundercats sapiente veniam. Excepteur VHS elit, proident shoreditch +1 biodiesel laborum craft beer. Single-origin coffee wayfarers irure four loko, cupidatat terry richardson master cleanse. Assumenda you probably haven't heard of them art party fanny pack, tattooed nulla cardigan tempor ad. Proident wolf nesciunt sartorial keffiyeh eu banh mi sustainable. Elit wolf voluptate, lo-fi ea portland before they sold out four loko. Locavore enim nostrud mlkshk brooklyn nesciunt.
            </p>
            <h4 id="three">three</h4>
            <p>
            Ad leggings keytar, brunch id art party dolor labore. Pitchfork yr enim lo-fi before they sold out qui. Tumblr farm-to-table bicycle rights whatever. Anim keffiyeh carles cardigan. Velit seitan mcsweeney's photo booth 3 wolf moon irure. Cosby sweater lomo jean shorts, williamsburg hoodie minim qui you probably haven't heard of them et cardigan trust fund culpa biodiesel wes anderson aesthetic. Nihil tattooed accusamus, cred irony biodiesel keffiyeh artisan ullamco consequat.
            </p>
            <p>Keytar twee blog, culpa messenger bag marfa whatever delectus food truck. Sapiente synth id assumenda. Locavore sed helvetica cliche irony, thundercats you probably haven't heard of them consequat hoodie gluten-free lo-fi fap aliquip. Labore elit placeat before they sold out, terry richardson proident brunch nesciunt quis cosby sweater pariatur keffiyeh ut helvetica artisan. Cardigan craft beer seitan readymade velit. VHS chambray laboris tempor veniam. Anim mollit minim commodo ullamco thundercats.
            </p>
          </div>

Jacob Thornton's avatar
Jacob Thornton committed
418
419
420
421
        </div>
      </div>
    </section>

Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
422
423
424
425
426
427
428
429
    <!-- Tabs
    ================================================== -->

    <section id="tabs">
      <div class="page-header">
        <h1>Tabs <small>bootstrap-tabs.js</small></h1>
      </div>
      <div class="row">
430
        <div class="span3 columns">
431
          <p>This plugin adds quick, dynamic tab and pill functionality.</p>
432
          <a href="../js/bootstrap-tabs.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
433
        </div>
434
        <div class="span9 columns">
435
          <h3>Using boostrap-tabs.js</h3>
436
          <pre class="prettyprint linenums">$('.tabs').tabs()</pre>
437
438
          <h3>Markup</h3>
          <p>You can activate a tab or pill navigation without writing any javascript by simply giving them a <code>data-tabs</code> or <code>data-pills</code> attribute.</p>
439
          <pre class="prettyprint linenums"> &lt;ul class="tabs" data-tabs="tabs" &gt;...&lt;/ul&gt;</pre>
440
          <h3>Methods</h3>
441
          <h4>$().tabs or $().pills</h4>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
442
          <p>
Jacob Thornton's avatar
Jacob Thornton committed
443
            Activates tab and pill functionality for a given container. Tab links should reference id's in the document.
444
445
          </p>
<pre class="prettyprint linenums">
Jacob Thornton's avatar
Jacob Thornton committed
446
&lt;ul class="tabs"&gt;
447
448
449
450
451
452
  &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
453
&lt;div class="pill-content"&gt;
454
455
456
457
  &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;
458
&lt;/div&gt;
459
460
461
462
463
464

&lt;script&gt;
  $(function () {
    $('.tabs').tabs()
  })
&lt;/script&gt;</pre>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
465
          </p>
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
          <h3>Events</h3>
          <table class="zebra-striped">
            <thead>
             <tr>
               <th style="width: 150px;">Event</th>
               <th>Description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>change</td>
               <td>This event fires on tab change. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab respectively.</td>
             </tr>
            </tbody>
          </table>

          <pre class="prettyprint linenums">
$('.tabs a').bind('change', function (e) {
  e.target // activated tab
  e.relatedTarget // previous tab
})</pre>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
487
          <h3>Demo</h3>
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
          <ul class="tabs" data-tabs="tabs">
            <li class="active"><a href="#home">Home</a></li>
            <li><a href="#profile">Profile</a></li>
            <li><a href="#messages">Messages</a></li>
            <li><a href="#settings">Settings</a></li>
            <li class="dropdown">
              <a href="#" class="dropdown-toggle" data-toggle="dropdown">Dropdown</a>
              <ul class="dropdown-menu">
                <li><a href="#dropdown1">@fat</a></li>
                <li><a href="#dropdown2">@mdo</a></li>
              </ul>
            </li>
          </ul>
          <div id="my-tab-content" class="tab-content">
            <div class="active tab-pane" id="home">
              <p>Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.</p>
            </div>
            <div class="tab-pane" id="profile">
              <p>Food truck fixie locavore, accusamus mcsweeney's marfa nulla single-origin coffee squid. Exercitation +1 labore velit, blog sartorial PBR leggings next level wes anderson artisan four loko farm-to-table craft beer twee. Qui photo booth letterpress, commodo enim craft beer mlkshk aliquip jean shorts ullamco ad vinyl cillum PBR. Homo nostrud organic, assumenda labore aesthetic magna delectus mollit. Keytar helvetica VHS salvia yr, vero magna velit sapiente labore stumptown. Vegan fanny pack odio cillum wes anderson 8-bit, sustainable jean shorts beard ut DIY ethical culpa terry richardson biodiesel. Art party scenester stumptown, tumblr butcher vero sint qui sapiente accusamus tattooed echo park.</p>
            </div>
            <div class="tab-pane" id="messages">
              <p>Banksy do proident, brooklyn photo booth delectus sunt artisan sed organic exercitation eiusmod four loko. Quis tattooed iphone esse aliqua. Master cleanse vero fixie mcsweeney's. Ethical portland aute, irony food truck pitchfork lomo eu anim. Aesthetic blog DIY, ethical beard leggings tofu consequat whatever cardigan nostrud. Helvetica you probably haven't heard of them carles, marfa veniam occaecat lomo before they sold out in shoreditch scenester sustainable thundercats. Consectetur tofu craft beer, mollit brunch fap echo park pitchfork mustache dolor.</p>
            </div>
            <div class="tab-pane" id="settings">
              <p>Sunt qui biodiesel mollit officia, fanny pack put a bird on it thundercats seitan squid ad wolf bicycle rights blog. Et aute readymade farm-to-table carles 8-bit, nesciunt nulla etsy adipisicing organic ea. Master cleanse mollit high life, next level Austin nesciunt american apparel twee mustache adipisicing reprehenderit hoodie portland irony. Aliqua tofu quinoa +1 commodo eiusmod. High life williamsburg cupidatat twee homo leggings. Four loko vinyl DIY consectetur nisi, marfa retro keffiyeh vegan. Fanny pack viral retro consectetur gentrify fap.</p>
            </div>
            <div class="tab-pane" id="dropdown1">
              <p>Etsy mixtape wayfarers, ethical wes anderson tofu before they sold out mcsweeney's organic lomo retro fanny pack lo-fi farm-to-table readymade. Messenger bag gentrify pitchfork tattooed craft beer, iphone skateboard locavore carles etsy salvia banksy hoodie helvetica. DIY synth PBR banksy irony. Leggings gentrify squid 8-bit cred pitchfork. Williamsburg banh mi whatever gluten-free, carles pitchfork biodiesel fixie etsy retro mlkshk vice blog. Scenester cred you probably haven't heard of them, vinyl craft beer blog stumptown. Pitchfork sustainable tofu synth chambray yr.</p>
            </div>
            <div class="tab-pane" id="dropdown2">
              <p>Trust fund seitan letterpress, keytar raw denim keffiyeh etsy art party before they sold out master cleanse gluten-free squid scenester freegan cosby sweater. Fanny pack portland seitan DIY, art party locavore wolf cliche high life echo park Austin. Cred vinyl keffiyeh DIY salvia PBR, banh mi before they sold out farm-to-table VHS viral locavore cosby sweater. Lomo wolf viral, mustache readymade thundercats keffiyeh craft beer marfa ethical. Wolf salvia freegan, sartorial keffiyeh echo park vegan.</p>
519
            </div>
Jacob Thornton's avatar
Jacob Thornton committed
520
521
522
523
524
          </div>
        </div>
      </div>
    </section>

525
526
527
528
529
530
531
532
    <!-- Tips
    ================================================== -->

    <section id="twipsy">
      <div class="page-header">
        <h1>Twipsy <small>bootstrap-twipsy.js</small></h1>
      </div>
      <div class="row">
533
        <div class="span3 columns">
534
          <p>Based on the excellent jQuery.tipsy plugin written by Jason Frame; twipsy is an updated version, which doesn't rely on images, uses css3 for animations, and data-attributes for title storage!</p>
535
          <a href="../js/bootstrap-twipsy.js" target="_blank" class="btn primary">Download</a>
536
        </div>
537
        <div class="span9 columns">
538
          <h3>Using bootstrap-twipsy.js</h3>
539
540
          <pre class="prettyprint linenums">$('#example').twipsy(options)</pre>
          <h3>Options</h3>
541
          <table class="striped-table">
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>animate</td>
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
               <td>placement</td>
               <td>string</td>
               <td>'above'</td>
               <td>how to position the tooltip - above | below | left | right</td>
             </tr>
             <tr>
               <td>live</td>
               <td>boolean</td>
               <td>false</td>
               <td>use event delegation instead of individual event handlers</td>
             </tr>
             <tr>
               <td>offset</td>
               <td>number</td>
               <td>0</td>
               <td>pixel offset of tooltip from target element</td>
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
581
582
583
584
585
586
587
588
589
590
             <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>
591
592
            </tbody>
          </table>
593
594
595
596
          <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>
          <p>Twipsy's should contain a title tag which will be use to fill the tip content.<p>
          <pre class="prettyprint linenums">&lt;a href="#" rel='twipsy' title='twipsy text'&gt;@fat&lt;/a&gt;</pre>
597
          <h3>Methods</h3>
598
          <h4>$().twipsy(options)</h4>
599
          <p>Attaches a twipsy handler to an element collection.</p>
600
          <h4>.twipsy('show')</h4>
601
          <p>Reveals an elements twipsy.</p>
602
603
          <pre class="prettyprint linenums">$('#element').twipsy('show')</pre>
          <h4>.twipsy('hide')</h4>
604
          <p>Hides an elements twipsy.</p>
605
          <pre class="prettyprint linenums">$('#element').twipsy('hide')</pre>
606
          <h3>Demo</h3>
Jacob Thornton's avatar
Jacob Thornton committed
607
608
609
610
          <div class="well">
            <p class="muted">Tight pants next level keffiyeh <a href="#" rel='twipsy' title='Some title text'>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.
            </p>
          </div>
611
612
613
614
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
615
616
617
618
619
620
621
622
    <!-- Popovers
    ================================================== -->

    <section id="popover">
      <div class="page-header">
        <h1>Popovers <small>bootstrap-popover.js</small></h1>
      </div>
      <div class="row">
623
        <div class="span3 columns">
Jacob Thornton's avatar
Jacob Thornton committed
624
          <p>The popover plugin provides a simple interface for adding popovers to your application. It extends the <a href="#twipsy">boostrap-twipsy.js</a> plugin, so be sure to grab that file as well when including popovers in your project!</p>
625
          <a href="../js/bootstrap-popover.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
626
        </div>
627
        <div class="span9 columns">
628
          <h3>Using boostrap-popover.js</h3>
Jacob Thornton's avatar
Jacob Thornton committed
629
630
          <pre class="prettyprint linenums">$('#example').popover(options)</pre>
          <h3>Options</h3>
631
          <table class="striped-table">
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>animate</td>
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
648
649
               <td>delay</td>
               <td>number | object</td>
650
               <td>0</td>
651
               <td>delay before showing/hiding the tooltip (ms)</td>
652
653
654
655
656
             </tr>
             <tr>
               <td>placement</td>
               <td>string</td>
               <td>'right'</td>
657
               <td>how to position the popover - above | below | left | right</td>
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
             </tr>
             <tr>
               <td>live</td>
               <td>boolean</td>
               <td>false</td>
               <td>use event delegation instead of individual event handlers</td>
             </tr>
             <tr>
               <td>offset</td>
               <td>number</td>
               <td>0</td>
               <td>pixel offset of tooltip from target element</td>
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
            </tbody>
          </table>
679
680
681
682
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>
          <p>Popover's should contain a title tag and a data-content attribute.<p>
<pre class="prettyprint linenums">&lt;a href="#" class="btn" rel="popover" title="A Title" data-content="Some content"&gt;
  hover for popover
&lt;/a&gt;</pre>
Jacob Thornton's avatar
Jacob Thornton committed
685
          <h3>Methods</h3>
686
          <h4>$().popover(options)</h4>
Jacob Thornton's avatar
Jacob Thornton committed
687
          <p>Initializes popovers for an element collection.</p>
688
          <h4>.popover('show')</h4>
689
          <p>Reveals an elements popover.</p>
690
691
          <pre class="prettyprint linenums">$('#element').popover('show')</pre>
          <h4>.popover('hide')</h4>
692
          <p>Hides an elements popover.</p>
693
          <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
694
          <h3>Demo</h3>
695
          <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
696
697
698
        </div>
      </div>
    </section>
699

700
701
702
703
704
705
706
707
708

    <!-- Alerts
    ================================================== -->

    <section id="alerts">
      <div class="page-header">
        <h1>Alerts <small>bootstrap-alerts.js</small></h1>
      </div>
      <div class="row">
709
        <div class="span3 columns">
710
711
712
          <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>
713
        <div class="span9 columns">
714
          <h3>Using bootstrap-alerts.js</h3>
715
          <pre class="prettyprint linenums">$(".alert-message").alert()</pre>
716
          <h3>Markup</h3>
717
718
          <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>
719
          <h3>Methods</h3>
720
          <h4>$().alert()</h4>
721
          <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>
722
          <h4>.alert('close')</h4>
723
          <p>Closes an alert.</p>
724
          <pre class="prettyprint linenums">$(".alert-message").alert('close')</pre>
725
          <h3>Demo</h3>
726
727
          <div class="alert-message warning fade in">
            <a class="close" data-dismiss="alert" href="#">&times;</a>
728
729
            <p><strong>Holy guacamole!</strong> Best check yo self, you’re not looking too good.</p>
          </div>
730
731
          <div class="alert-message block-message error fade in">
            <a class="close" data-dismiss="alert" href="#">&times;</a>
732
733
734
735
736
737
738
739
740
            <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
741

742
743
      <!-- Footer
      ================================================== -->
744
      <footer class="footer">
Mark Otto's avatar
Mark Otto committed
745
746
        <p class="pull-right"><a href="#">Back to top</a></p>
        <p>
747
748
          Designed and built with all the love in the world <a href="http://twitter.com/twitter" target="_blank">@twitter</a> by <a href="http://twitter.com/mdo" target="_blank">@mdo</a> and <a href="http://twitter.com/fat" target="_blank">@fat</a>.<br>
          Code licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License v2.0</a>. Documentation licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.
Mark Otto's avatar
Mark Otto committed
749
        </p>
750
751
      </footer>
    </div><!-- /container -->
Jacob Thornton's avatar
Jacob Thornton committed
752
  </body>
Mark Otto's avatar
Mark Otto committed
753
</html>