javascript.html 29.8 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 styles -->
15
    <link href="../bootstrap.css" rel="stylesheet">
16
    <link href="assets/css/docs.css" rel="stylesheet">
Jacob Thornton's avatar
Jacob Thornton committed
17
    <link href="assets/js/google-code-prettify/prettify.css" rel="stylesheet">
Jacob Thornton's avatar
Jacob Thornton committed
18
19
20
21
22
23
24
25

    <!-- 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>

26
  <body id="bootstrap-js">
Jacob Thornton's avatar
Jacob Thornton committed
27

28
    <!-- Navbar
Jacob Thornton's avatar
Jacob Thornton committed
29
    ================================================== -->
30
31
    <div class="navbar navbar-fixed" data-scrollspy="scrollspy">
      <div class="navbar-inner">
Jacob Thornton's avatar
Jacob Thornton committed
32
        <div class="container">
33
          <a class="brand" href="./index.html">Bootstrap</a>
34
          <ul class="nav">
35
            <li><a href="#overview">Overview</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
36
            <li><a href="#modal">Modals</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
37
            <li><a href="#dropdown">Dropdown</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
38
            <li><a href="#scrollspy">ScrollSpy</a></li>
39
            <li><a href="#tabs">Tabs</a></li>
40
            <li><a href="#twipsy">Twipsy</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
41
            <li><a href="#popover">Popover</a></li>
42
            <li><a href="#alerts">Alerts</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
43
44
45
46
47
          </ul>
        </div>
      </div>
    </div>

48
  <div class="container">
49
50
51
    <!-- Masthead (blueprinty thing)
    ================================================== -->
    <header class="jumbotron subhead" id="overview">
52
53
      <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>
54
55
    </header>

Jacob Thornton's avatar
Jacob Thornton committed
56
57
58
59

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

60
    <section id="modal">
Jacob Thornton's avatar
Jacob Thornton committed
61
      <div class="page-header">
62
        <h1>Modals <small>bootstrap-modal.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
63
64
      </div>
      <div class="row">
65
        <div class="span3 columns">
66
          <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>
67
          <a href="../js/bootstrap-modal.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
68
        </div>
69
        <div class="span9 columns">
70
          <h3>Using bootstrap-modal</h3>
71
          <pre class="prettyprint linenums">$('#my-modal').modal(options)</pre>
Jacob Thornton's avatar
Jacob Thornton committed
72
          <h3>Options</h3>
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
100
101
102
103
          <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
104
          <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>
105
106
107
108
<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
109
          <h3>Methods</h3>
110
111
          <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
112
<pre class="prettyprint linenums">
113
$('#my-modal').modal({
Jacob Thornton's avatar
Jacob Thornton committed
114
  closeOnEscape: true
115
})</pre>
116
117
118
119
120
121
122
123
124
125
          <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>
126
127
          <p>Returns an elements modal class instance.</p>
          <pre class="prettyprint linenums">$('#my-modal').modal(true)</pre>
128
          <p><span class="label notice">Notice</span> Alternatively, this can be retrieved with <code>$().data('modal')</code>.</p>
129
          <h3>Events</h3>
130
          <p>Bootstrap's modal class exposes a few events for hooking into modal functionality. </p>
131
132
133
          <table class="zebra-striped">
            <thead>
             <tr>
134
               <th style="width: 150px;">Event</th>
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
               <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>

158
<pre class="prettyprint linenums">
159
160
161
$('#my-modal').bind('hidden', function () {
  // do something ...
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
162
163
          <h3>Demo</h3>
          <!-- sample modal content -->
164
          <div id="modal-from-dom" class="modal hide fade">
Jacob Thornton's avatar
Jacob Thornton committed
165
            <div class="modal-header">
166
              <a href="#" class="close" data-modal-dismiss="true" >&times;</a>
Jacob Thornton's avatar
Jacob Thornton committed
167
              <h3>Modal Heading</h3>
Jacob Thornton's avatar
Jacob Thornton committed
168
169
170
171
172
            </div>
            <div class="modal-body">
              <p>One fine body…</p>
            </div>
            <div class="modal-footer">
173
              <a href="#" class="btn primary">Save changes</a>
174
              <a href="#" class="btn" data-modal-dismiss="true" >Close</a>
Jacob Thornton's avatar
Jacob Thornton committed
175
176
            </div>
          </div>
177
          <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
178
179
180
        </div>
      </div>
    </section>
181
182


Jacob Thornton's avatar
Jacob Thornton committed
183
184
185
186
187
    <!-- Dropdown
    ================================================== -->

    <section id="dropdown">
      <div class="page-header">
Jacob Thornton's avatar
Jacob Thornton committed
188
        <h1>Dropdown <small>bootstrap-dropdown.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
189
190
      </div>
      <div class="row">
191
        <div class="span3 columns">
192
          <p>This plugin is for adding dropdown interaction to the Bootstrap navbar or tabbed navigations.</p>
193
          <a href="../js/bootstrap-dropdown.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
194
        </div>
195
        <div class="span9 columns">
196
          <h3>Using boostrap-dropdown.js</h3>
197
          <pre class="prettyprint linenums">$('#navbar').dropdown()</pre>
198
199
200
201
202
          <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;
203
  &lt;li class="dropdown" data-dropdown="true" &gt;
204
205
206
207
208
209
210
211
212
213
214
    &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
215
          <p>
216
          A programatic api for activating menus for a given navbar or tabbed navigation.
Jacob Thornton's avatar
Jacob Thornton committed
217
218
          </p>
          <h3>Demo</h3>
219
          <div id="navbar-example" class="navbar navbar-static">
220
221
222
223
224
225
226
            <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
227
                <form class="form-search navbar-search pull-left" action="">
228
                  <input type="text" class="search-query span2" placeholder="Search">
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
                </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
250
251
252
253
254
255
256
              </div>
            </div>
          </div>
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
257
258
259
260
261
262
263
264
   <!-- ScrollSpy
    ================================================== -->

    <section id="scrollspy">
      <div class="page-header">
        <h1>ScrollSpy <small>bootstrap-scrollspy.js</small></h1>
      </div>
      <div class="row">
265
        <div class="span3 columns">
266
          <p>This plugin is for adding the scrollspy (auto updating nav) interaction to the bootstrap navbar.</p>
Jacob Thornton's avatar
Jacob Thornton committed
267
268
          <a href="../js/bootstrap-scrollspy.js" target="_blank" class="btn primary">Download</a>
        </div>
269
        <div class="span9 columns">
Jacob Thornton's avatar
Jacob Thornton committed
270
          <h2>Using boostrap-scrollspy.js</h2>
271
          <pre class="prettyprint linenums">$('#navbar').dropdown()</pre>
272
          <h3>Markup</h3>
273
274
          <p>To easily add scrollspy behavior to your nav, just add the <code>data-scrollspy</code> attribute to the <code>.navbar</code>.
          <pre class="prettyprint linenums">&lt;div class="navbar" data-scrollspy="scrollspy" &gt;...&lt;/div&gt;</pre>
275
276
          <h3>Methods</h3>
          <h4>$().scrollspy()</h4>
Jacob Thornton's avatar
Jacob Thornton committed
277
278
279
          <p>
          Auto activates navigation buttons by users scroll position.
          </p>
280
281
          <pre class="prettyprint linenums">$('body > .navbar').scrollSpy()</pre>
           <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
282
          </p>
283
          <h4>.scrollspy('refresh')</h4>
284
          <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>
285
          <pre class="prettyprint linenums">$('body').scrollspy('refresh')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
286
          <h3>Demo</h3>
287
          <p>Checkout the the navbar navigation on this page.</p>
Jacob Thornton's avatar
Jacob Thornton committed
288
289
290
291
        </div>
      </div>
    </section>

Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
292
293
294
295
296
297
298
299
    <!-- Tabs
    ================================================== -->

    <section id="tabs">
      <div class="page-header">
        <h1>Tabs <small>bootstrap-tabs.js</small></h1>
      </div>
      <div class="row">
300
        <div class="span3 columns">
301
          <p>This plugin adds quick, dynamic tab and pill functionality.</p>
302
          <a href="../js/bootstrap-tabs.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
303
        </div>
304
        <div class="span9 columns">
305
          <h3>Using boostrap-tabs.js</h3>
306
          <pre class="prettyprint linenums">$('.tabs').tabs()</pre>
307
308
          <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>
309
          <pre class="prettyprint linenums"> &lt;ul class="tabs" data-tabs="tabs" &gt;...&lt;/ul&gt;</pre>
310
          <h3>Methods</h3>
311
          <h4>$().tabs or $().pills</h4>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
312
          <p>
Jacob Thornton's avatar
Jacob Thornton committed
313
            Activates tab and pill functionality for a given container. Tab links should reference id's in the document.
314
315
          </p>
<pre class="prettyprint linenums">
Jacob Thornton's avatar
Jacob Thornton committed
316
&lt;ul class="tabs"&gt;
317
318
319
320
321
322
  &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
323
&lt;div class="pill-content"&gt;
324
325
326
327
  &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;
328
&lt;/div&gt;
329
330
331
332
333
334

&lt;script&gt;
  $(function () {
    $('.tabs').tabs()
  })
&lt;/script&gt;</pre>
Jacob Thornton's avatar
tabssss    
Jacob Thornton committed
335
336
          </p>
          <h3>Demo</h3>
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
          <div class="tabbable">
            <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>
            </ul>
            <div class="tab-content" id="myTabContent">
              <div class="tab-pane 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 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>
357
            </div>
Jacob Thornton's avatar
Jacob Thornton committed
358
359
360
361
362
          </div>
        </div>
      </div>
    </section>

363
364
365
366
367
368
369
370
    <!-- Tips
    ================================================== -->

    <section id="twipsy">
      <div class="page-header">
        <h1>Twipsy <small>bootstrap-twipsy.js</small></h1>
      </div>
      <div class="row">
371
        <div class="span3 columns">
372
          <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>
373
          <a href="../js/bootstrap-twipsy.js" target="_blank" class="btn primary">Download</a>
374
        </div>
375
        <div class="span9 columns">
376
          <h3>Using bootstrap-twipsy.js</h3>
377
378
          <pre class="prettyprint linenums">$('#example').twipsy(options)</pre>
          <h3>Options</h3>
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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
          <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>
440
               <td>'title'</td>
441
442
443
444
445
446
447
448
449
450
               <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>
451
          <h3>Methods</h3>
452
          <h4>$().twipsy(options)</h4>
453
          <p>Attaches a twipsy handler to an element collection.</p>
454
          <h4>.twipsy('show')</h4>
455
          <p>Reveals an elements twipsy.</p>
456
457
          <pre class="prettyprint linenums">$('#element').twipsy('show')</pre>
          <h4>.twipsy('hide')</h4>
458
          <p>Hides an elements twipsy.</p>
459
460
461
462
463
          <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>
464
          <h3>Demo</h3>
Jacob Thornton's avatar
Jacob Thornton committed
465
466
467
468
          <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>
469
470
471
472
473
474
475
476
477
478
479
          <script>
            $(function () {
              $("a[rel=twipsy]").twipsy({
                live: true
              })
            })
          </script>
        </div>
      </div>
    </section>

Jacob Thornton's avatar
Jacob Thornton committed
480
481
482
483
484
485
486
487
    <!-- Popovers
    ================================================== -->

    <section id="popover">
      <div class="page-header">
        <h1>Popovers <small>bootstrap-popover.js</small></h1>
      </div>
      <div class="row">
488
        <div class="span3 columns">
Jacob Thornton's avatar
Jacob Thornton committed
489
          <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>
490
          <a href="../js/bootstrap-popover.js" target="_blank" class="btn primary">Download</a>
Jacob Thornton's avatar
Jacob Thornton committed
491
        </div>
492
        <div class="span9 columns">
493
          <h3>Using boostrap-popover.js</h3>
Jacob Thornton's avatar
Jacob Thornton committed
494
495
          <pre class="prettyprint linenums">$('#example').popover(options)</pre>
          <h3>Options</h3>
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
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
          <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
574
          <h3>Methods</h3>
575
          <h4>$().popover(options)</h4>
Jacob Thornton's avatar
Jacob Thornton committed
576
          <p>Initializes popovers for an element collection.</p>
577
          <h4>.popover('show')</h4>
578
          <p>Reveals an elements popover.</p>
579
580
          <pre class="prettyprint linenums">$('#element').popover('show')</pre>
          <h4>.popover('hide')</h4>
581
          <p>Hides an elements popover.</p>
582
          <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
583
          <h3>Demo</h3>
584
          <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
585
586
          <script>
            $(function () {
587
588
589
590
591
592
593
              $("a[rel=popover]")
                .popover({
                  offset: 10
                })
                .click(function(e) {
                  e.preventDefault()
                })
Jacob Thornton's avatar
Jacob Thornton committed
594
595
596
597
598
            })
          </script>
        </div>
      </div>
    </section>
599

600
601
602
603
604
605
606
607
608

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

    <section id="alerts">
      <div class="page-header">
        <h1>Alerts <small>bootstrap-alerts.js</small></h1>
      </div>
      <div class="row">
609
        <div class="span3 columns">
610
611
612
          <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>
613
        <div class="span9 columns">
614
          <h3>Using bootstrap-alerts.js</h3>
615
          <pre class="prettyprint linenums">$(".alert-message").alert()</pre>
616
617
          <h3>Markup</h3>
          <p>Just add a <code>data-alert</code> attribute to your alert messages to automatically give them close functionality.</p>
618
          <h3>Methods</h3>
619
          <h4>$().alert()</h4>
620
          <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>
621
          <h4>.alert('close')</h4>
622
          <p>Closes an alert.</p>
623
          <pre class="prettyprint linenums">$(".alert-message").alert('close')</pre>
624
          <h3>Demo</h3>
625
          <div class="alert-message warning fade in" data-alert="alert" >
626
            <a class="close" data-alert-dismiss="true" href="#">&times;</a>
627
628
            <p><strong>Holy guacamole!</strong> Best check yo self, you’re not looking too good.</p>
          </div>
629
          <div class="alert-message block-message error fade in" data-alert="alert" >
630
            <a class="close" data-alert-dismiss="true" href="#">&times;</a>
631
632
633
634
635
636
637
638
639
            <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
640

641
      <footer class="footer">
Mark Otto's avatar
Mark Otto committed
642
643
644
645
646
        <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>
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
      </footer>

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


    <!-- Le javascript -->
    <script src="http://code.jquery.com/jquery-1.6.4.min.js"></script>
    <script src="assets/js/google-code-prettify/prettify.js"></script>
    <script>$(function () { prettyPrint() })</script>
    <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>
    <script src="../js/bootstrap-scrollspy.js"></script>
    <script src="../js/bootstrap-tabs.js"></script>
Mark Otto's avatar
Mark Otto committed
663

Jacob Thornton's avatar
Jacob Thornton committed
664
  </body>
Mark Otto's avatar
Mark Otto committed
665
</html>