javascript.html 29.9 KB
Newer Older
Jacob Thornton's avatar
Jacob Thornton committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>Bootstrap, from Twitter</title>
    <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 javascript -->
15
    <script src="http://code.jquery.com/jquery-1.6.4.min.js"></script>
Jacob Thornton's avatar
Jacob Thornton committed
16
17
    <script src="assets/js/google-code-prettify/prettify.js"></script>
    <script>$(function () { prettyPrint() })</script>
18
19
20
21
22
    <script src="../js/bootstrap-modal.js"></script>
    <script src="../js/bootstrap-alerts.js"></script>
    <script src="../js/bootstrap-twipsy.js"></script>
    <script src="../js/bootstrap-popover.js"></script>
    <script src="../js/bootstrap-dropdown.js"></script>
Jacob Thornton's avatar
Jacob Thornton committed
23
    <script src="../js/bootstrap-scrollspy.js"></script>
24
    <script src="../js/bootstrap-tabs.js"></script>
Jacob Thornton's avatar
Jacob Thornton committed
25
26

    <!-- Le styles -->
27
    <link href="../bootstrap.css" rel="stylesheet">
28
    <link href="assets/css/docs.css" rel="stylesheet">
Jacob Thornton's avatar
Jacob Thornton committed
29
    <link href="assets/js/google-code-prettify/prettify.css" rel="stylesheet">
Jacob Thornton's avatar
Jacob Thornton committed
30
31
32
33
34
35
36
37

    <!-- 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">
  </head>

38
  <body id="bootstrap-js">
Jacob Thornton's avatar
Jacob Thornton committed
39
40
41

    <!-- Topbar
    ================================================== -->
42
43
    <div class="navbar navbar-fixed" data-scrollspy="scrollspy">
      <div class="navbar-inner">
Jacob Thornton's avatar
Jacob Thornton committed
44
        <div class="container">
45
46
          <a class="brand" href="#">Bootstrap JS</a>
          <ul class="nav">
47
            <li><a href="#overview">Overview</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
48
            <li><a href="#modal">Modals</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
49
            <li><a href="#dropdown">Dropdown</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
50
            <li><a href="#scrollspy">ScrollSpy</a></li>
51
            <li><a href="#tabs">Tabs</a></li>
52
            <li><a href="#twipsy">Twipsy</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
53
            <li><a href="#popover">Popover</a></li>
54
            <li><a href="#alerts">Alerts</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
55
56
57
58
59
          </ul>
        </div>
      </div>
    </div>

60
61
62
63
64
65
66
67
68
69
70
71
72
73
    <!-- Masthead (blueprinty thing)
    ================================================== -->
    <header class="jumbotron subhead" id="overview">
      <div class="inner">
        <div class="container">
          <h1>Javascript for Bootstrap</h1>
          <p class="lead">
            Bring Bootstrap's 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>.
          </p>
          <p><a href="./index.html">&larr; Back to Bootstrap home</a></p>
        </div><!-- /container -->
      </div>
    </header>

Jacob Thornton's avatar
Jacob Thornton committed
74
75
76
77
78
    <div class="container">

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

79
    <section id="modal">
Jacob Thornton's avatar
Jacob Thornton committed
80
      <div class="page-header">
81
        <h1>Modals <small>bootstrap-modal.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
82
83
84
      </div>
      <div class="row">
        <div class="span4 columns">
85
          <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>
86
          <a href="../js/bootstrap-modal.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
87
88
        </div>
        <div class="span12 columns">
89
          <h3>Using bootstrap-modal</h3>
90
          <pre class="prettyprint linenums">$('#my-modal').modal(options)</pre>
Jacob Thornton's avatar
Jacob Thornton committed
91
          <h3>Options</h3>
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
          <table class="zebra-striped">
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 50px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>backdrop</td>
               <td>boolean</td>
               <td>false</td>
               <td>Includes a modal-backdrop element</td>
             </tr>
             <tr>
               <td>keyboard</td>
               <td>boolean</td>
               <td>false</td>
               <td>Closes the modal when escape key is pressed</td>
             </tr>
             <tr>
               <td>show</td>
               <td>boolean</td>
               <td>false</td>
               <td>Opens modal on class initialization</td>
             </tr>
            </tbody>
          </table>
          <h3>Markup</h3>
Jacob Thornton's avatar
Jacob Thornton committed
123
          <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 as well.</p>
124
125
126
127
<pre class="prettyprint linenums">
&lt;a class="btn" data-controls-modal="my-modal" data-backdrop="true" &gt;Launch Modal&lt;/a&gt;
</pre>
          <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 your <code>.modal</code> element (refer to the demo to see this in action).</p>
Jacob Thornton's avatar
Jacob Thornton committed
128
          <h3>Methods</h3>
129
130
          <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
131
<pre class="prettyprint linenums">
132
$('#my-modal').modal({
Jacob Thornton's avatar
Jacob Thornton committed
133
  closeOnEscape: true
134
})</pre>
135
136
137
138
139
140
141
142
143
144
          <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>
          <h4>.modal(true)</h4>
145
146
          <p>Returns an elements modal class instance.</p>
          <pre class="prettyprint linenums">$('#my-modal').modal(true)</pre>
147
          <p><span class="label notice">Notice</span> Alternatively, this can be retrieved with <code>$().data('modal')</code>.</p>
148
          <h3>Events</h3>
149
          <p>Bootstrap's modal class exposes a few events for hooking into modal functionality. </p>
150
151
152
          <table class="zebra-striped">
            <thead>
             <tr>
153
               <th style="width: 150px;">Event</th>
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
               <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>

177
<pre class="prettyprint linenums">
178
179
180
$('#my-modal').bind('hidden', function () {
  // do something ...
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
181
182
          <h3>Demo</h3>
          <!-- sample modal content -->
183
          <div id="modal-from-dom" class="modal hide fade">
Jacob Thornton's avatar
Jacob Thornton committed
184
            <div class="modal-header">
185
              <a href="#" class="close" data-modal-dismiss="true" >&times;</a>
Jacob Thornton's avatar
Jacob Thornton committed
186
              <h3>Modal Heading</h3>
Jacob Thornton's avatar
Jacob Thornton committed
187
188
189
190
191
            </div>
            <div class="modal-body">
              <p>One fine body…</p>
            </div>
            <div class="modal-footer">
192
              <a href="#" class="btn primary">Save changes</a>
193
              <a href="#" class="btn" data-modal-dismiss="true" >Close</a>
Jacob Thornton's avatar
Jacob Thornton committed
194
195
            </div>
          </div>
196
          <button data-controls-modal="modal-from-dom" data-backdrop="true" data-keyboard="true" class="btn danger">Launch Modal</button>
Jacob Thornton's avatar
Jacob Thornton committed
197
198
199
        </div>
      </div>
    </section>
200
201


Jacob Thornton's avatar
Jacob Thornton committed
202
203
204
205
206
    <!-- Dropdown
    ================================================== -->

    <section id="dropdown">
      <div class="page-header">
Jacob Thornton's avatar
Jacob Thornton committed
207
        <h1>Dropdown <small>bootstrap-dropdown.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
208
209
210
      </div>
      <div class="row">
        <div class="span4 columns">
Jacob Thornton's avatar
Jacob Thornton committed
211
          <p>This plugin is for adding dropdown interaction to the bootstrap topbar or tabbed navigations.</p>
212
          <a href="../js/bootstrap-dropdown.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
213
214
        </div>
        <div class="span12 columns">
215
          <h3>Using boostrap-dropdown.js</h3>
Jacob Thornton's avatar
Jacob Thornton committed
216
          <pre class="prettyprint linenums">$('#topbar').dropdown()</pre>
217
218
219
220
221
          <h3>Markup</h3>
          <p>To quickly add dropdown functionality to any nav element, use the <code>data-dropdown</code> attribute. Any valid bootstrap dropdown will automatically be activated.</p>
<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;
222
  &lt;li class="dropdown" data-dropdown="true" &gt;
223
224
225
226
227
228
229
230
231
232
233
    &lt;a href="#" class="dropdown-toggle"&gt;Dropdown&lt;/a&gt;
    &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
234
          <p>
235
          A programatic api for activating menus for a given topbar or tabbed navigation.
Jacob Thornton's avatar
Jacob Thornton committed
236
237
          </p>
          <h3>Demo</h3>
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
          <div id="topbar-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="#">Link</a></li>
                  <li><a href="#">Link</a></li>
                </ul>
                <form action="" class="search-form navbar-search">
                  <input type="text" placeholder="Search">
                </form>
                <ul class="nav secondary-nav">
                  <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-dropdown="true">Dropdown 1</a>
                    <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">
                    <a href="#" class="dropdown-toggle" data-dropdown="true">Dropdown 2</a>
                    <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
269
270
271
272
273
274
275
              </div>
            </div>
          </div>
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
   <!-- ScrollSpy
    ================================================== -->

    <section id="scrollspy">
      <div class="page-header">
        <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
      </div>
      <div class="row">
        <div class="span4 columns">
          <p>This plugin is for adding the scrollspy (auto updating nav) interaction to the bootstrap topbar.</p>
          <a href="../js/bootstrap-scrollspy.js" target="_blank" class="btn primary">Download</a>
        </div>
        <div class="span12 columns">
          <h2>Using boostrap-scrollspy.js</h2>
          <pre class="prettyprint linenums">$('#topbar').dropdown()</pre>
291
292
          <h3>Markup</h3>
          <p>To easily add scrollspy behavior to your nav, just add the <code>data-scrollspy</code> attribute to the <code>.topbar</code>.
293
          <pre class="prettyprint linenums">&lt;div class="topbar" data-scrollspy="scrollspy" &gt;...&lt;/div&gt;</pre>
294
295
          <h3>Methods</h3>
          <h4>$().scrollspy()</h4>
Jacob Thornton's avatar
Jacob Thornton committed
296
297
298
299
          <p>
          Auto activates navigation buttons by users scroll position.
          </p>
          <pre class="prettyprint linenums">$('body > .topbar').scrollSpy()</pre>
300
           <p><span class="label notice">Notice</span> Topbar 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
301
          </p>
302
          <h4>.scrollspy('refresh')</h4>
303
          <p>The scrollspy caches nav buttons and section coordinates for performance. If you need to update this cache (likely if you have dynamic content) just call this refresh method. If you used the data attribute to define your scrollspy, just call refresh on the body.</p>
304
          <pre class="prettyprint linenums">$('body').scrollspy('refresh')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
305
          <h3>Demo</h3>
306
          <p>Checkout the the topbar navigation on this page.</p>
Jacob Thornton's avatar
Jacob Thornton committed
307
308
309
310
        </div>
      </div>
    </section>

Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
311
312
313
314
315
316
317
318
319
    <!-- Tabs
    ================================================== -->

    <section id="tabs">
      <div class="page-header">
        <h1>Tabs <small>bootstrap-tabs.js</small></h1>
      </div>
      <div class="row">
        <div class="span4 columns">
320
          <p>This plugin adds quick, dynamic tab and pill functionality.</p>
321
          <a href="../js/bootstrap-tabs.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
322
323
        </div>
        <div class="span12 columns">
324
          <h3>Using boostrap-tabs.js</h3>
325
          <pre class="prettyprint linenums">$('.tabs').tabs()</pre>
326
327
          <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>
328
          <pre class="prettyprint linenums"> &lt;ul class="tabs" data-tabs="tabs" &gt;...&lt;/ul&gt;</pre>
329
          <h3>Methods</h3>
330
          <h4>$().tabs or $().pills</h4>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
331
          <p>
Jacob Thornton's avatar
Jacob Thornton committed
332
            Activates tab and pill functionality for a given container. Tab links should reference id's in the document.
333
334
          </p>
<pre class="prettyprint linenums">
Jacob Thornton's avatar
Jacob Thornton committed
335
&lt;ul class="tabs"&gt;
336
337
338
339
340
341
  &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
342
&lt;div class="pill-content"&gt;
343
344
345
346
  &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;
347
&lt;/div&gt;
348
349
350
351
352
353

&lt;script&gt;
  $(function () {
    $('.tabs').tabs()
  })
&lt;/script&gt;</pre>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
354
355
          </p>
          <h3>Demo</h3>
356
          <ul class="tabs" data-tabs="tabs" >
357
358
359
360
361
362
            <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>
          </ul>
          <div id="my-tab-content" class="tab-content">
363
364
365
366
367
368
369
370
371
372
373
374
            <div class="active" id="home">
              <p>Raw denim you probably haven't heard of them jean shorts Austin. Nesciunt tofu stumptown aliqua, retro synth master cleanse. Mustache cliche tempor, williamsburg carles vegan helvetica. Reprehenderit butcher retro keffiyeh dreamcatcher synth. Cosby sweater eu banh mi, qui irure terry richardson ex squid. Aliquip placeat salvia cillum iphone. Seitan aliquip quis cardigan american apparel, butcher voluptate nisi qui.</p>
            </div>
            <div 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 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 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>
Jacob Thornton's avatar
Jacob Thornton committed
375
376
377
378
379
          </div>
        </div>
      </div>
    </section>

380
381
382
383
384
385
386
387
388
389
    <!-- Tips
    ================================================== -->

    <section id="twipsy">
      <div class="page-header">
        <h1>Twipsy <small>bootstrap-twipsy.js</small></h1>
      </div>
      <div class="row">
        <div class="span4 columns">
          <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>
390
          <a href="../js/bootstrap-twipsy.js" target="_blank" class="btn primary">Download</a>
391
392
        </div>
        <div class="span12 columns">
393
          <h3>Using bootstrap-twipsy.js</h3>
394
395
          <pre class="prettyprint linenums">$('#example').twipsy(options)</pre>
          <h3>Options</h3>
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
          <table class="zebra-striped">
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>animate</td>
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
               <td>delayIn</td>
               <td>number</td>
               <td>0</td>
               <td>delay before showing tooltip (ms)</td>
             </tr>
             <tr>
               <td>delayOut</td>
               <td>number</td>
               <td>0</td>
               <td>delay before hiding tooltip (ms)</td>
             </tr>
             <tr>
               <td>fallback</td>
               <td>string</td>
               <td>''</td>
               <td>text to use when no tooltip title is present</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>html</td>
               <td>boolean</td>
               <td>false</td>
               <td>allows html content within tooltip</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>title</td>
               <td>string | function</td>
457
               <td>'title'</td>
458
459
460
461
462
463
464
465
466
467
               <td>attribute or method for retrieving title text</td>
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
            </tbody>
          </table>
468
          <h3>Methods</h3>
469
          <h4>$().twipsy(options)</h4>
470
          <p>Attaches a twipsy handler to an element collection.</p>
471
          <h4>.twipsy('show')</h4>
472
          <p>Reveals an elements twipsy.</p>
473
474
          <pre class="prettyprint linenums">$('#element').twipsy('show')</pre>
          <h4>.twipsy('hide')</h4>
475
          <p>Hides an elements twipsy.</p>
476
477
478
479
480
          <pre class="prettyprint linenums">$('#element').twipsy('hide')</pre>
          <h4>.twipsy(true)</h4>
          <p>Returns an elements twipsy class instance.</p>
          <pre class="prettyprint linenums">$('#element').twipsy(true)</pre>
          <p><span class="label notice">Notice</span> Alternatively, this can be retrieved with <code>$().data('twipsy')</code>.</p>
481
          <h3>Demo</h3>
Jacob Thornton's avatar
Jacob Thornton committed
482
483
484
485
          <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>
486
487
488
489
490
491
492
493
494
495
496
          <script>
            $(function () {
              $("a[rel=twipsy]").twipsy({
                live: true
              })
            })
          </script>
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
497
498
499
500
501
502
503
504
505
506
    <!-- Popovers
    ================================================== -->

    <section id="popover">
      <div class="page-header">
        <h1>Popovers <small>bootstrap-popover.js</small></h1>
      </div>
      <div class="row">
        <div class="span4 columns">
          <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>
507
          <a href="../js/bootstrap-popover.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
508
509
        </div>
        <div class="span12 columns">
510
          <h3>Using boostrap-popover.js</h3>
Jacob Thornton's avatar
Jacob Thornton committed
511
512
          <pre class="prettyprint linenums">$('#example').popover(options)</pre>
          <h3>Options</h3>
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
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
581
582
583
584
585
586
587
588
589
590
          <table class="zebra-striped">
            <thead>
             <tr>
               <th style="width: 100px;">Name</th>
               <th style="width: 100px;">type</th>
               <th style="width: 50px;">default</th>
               <th>description</th>
             </tr>
            </thead>
            <tbody>
             <tr>
               <td>animate</td>
               <td>boolean</td>
               <td>true</td>
               <td>apply a css fade transition to the tooltip</td>
             </tr>
             <tr>
               <td>delayIn</td>
               <td>number</td>
               <td>0</td>
               <td>delay before showing tooltip (ms)</td>
             </tr>
             <tr>
               <td>delayOut</td>
               <td>number</td>
               <td>0</td>
               <td>delay before hiding tooltip (ms)</td>
             </tr>
             <tr>
               <td>fallback</td>
               <td>string</td>
               <td>''</td>
               <td>text to use when no tooltip title is present</td>
             </tr>
             <tr>
               <td>placement</td>
               <td>string</td>
               <td>'right'</td>
               <td>how to position the tooltip - above | below | left | right</td>
             </tr>
             <tr>
               <td>html</td>
               <td>boolean</td>
               <td>false</td>
               <td>allows html content within tooltip</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>title</td>
               <td>string | function</td>
               <td>'title'</td>
               <td>attribute or method for retrieving title text</td>
             </tr>
             <tr>
               <td>content</td>
               <td>string | function</td>
               <td>'data-content'</td>
               <td>attribute or method for retrieving content text</td>
             </tr>
             <tr>
               <td>trigger</td>
               <td>string</td>
               <td>'hover'</td>
               <td>how tooltip is triggered - hover | focus | manual</td>
             </tr>
            </tbody>
          </table>
Jacob Thornton's avatar
Jacob Thornton committed
591
          <h3>Methods</h3>
592
          <h4>$().popover(options)</h4>
Jacob Thornton's avatar
Jacob Thornton committed
593
          <p>Initializes popovers for an element collection.</p>
594
          <h4>.popover('show')</h4>
595
          <p>Reveals an elements popover.</p>
596
597
          <pre class="prettyprint linenums">$('#element').popover('show')</pre>
          <h4>.popover('hide')</h4>
598
          <p>Hides an elements popover.</p>
599
          <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
600
          <h3>Demo</h3>
601
          <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
602
603
          <script>
            $(function () {
604
605
606
607
608
609
610
              $("a[rel=popover]")
                .popover({
                  offset: 10
                })
                .click(function(e) {
                  e.preventDefault()
                })
Jacob Thornton's avatar
Jacob Thornton committed
611
612
613
614
615
            })
          </script>
        </div>
      </div>
    </section>
616

617
618
619
620
621
622
623
624
625
626
627
628
629
630

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

    <section id="alerts">
      <div class="page-header">
        <h1>Alerts <small>bootstrap-alerts.js</small></h1>
      </div>
      <div class="row">
        <div class="span4 columns">
          <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>
        <div class="span12 columns">
631
          <h3>Using bootstrap-alerts.js</h3>
632
          <pre class="prettyprint linenums">$(".alert-message").alert()</pre>
633
634
          <h3>Markup</h3>
          <p>Just add a <code>data-alert</code> attribute to your alert messages to automatically give them close functionality.</p>
635
          <h3>Methods</h3>
636
          <h4>$().alert()</h4>
637
          <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>
638
          <h4>.alert('close')</h4>
639
          <p>Closes an alert.</p>
640
          <pre class="prettyprint linenums">$(".alert-message").alert('close')</pre>
641
          <h3>Demo</h3>
642
          <div class="alert-message warning fade in" data-alert="alert" >
643
            <a class="close" data-alert-dismiss="true" href="#">&times;</a>
644
645
            <p><strong>Holy guacamole!</strong> Best check yo self, you’re not looking too good.</p>
          </div>
646
          <div class="alert-message block-message error fade in" data-alert="alert" >
647
            <a class="close" data-alert-dismiss="true" href="#">&times;</a>
648
649
650
651
652
653
654
655
656
            <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
657
658
659
660
661
662
663
664
665
666
667
668
669

    </div><!-- /container -->

    <footer class="footer">
      <div class="container">
        <p class="pull-right"><a href="#">Back to top</a></p>
        <p>
          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 />
          Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License v2.0</a>.
        </p>
      </div>
    </footer>

Jacob Thornton's avatar
Jacob Thornton committed
670
  </body>
Mark Otto's avatar
Mark Otto committed
671
</html>