javascript.mustache 70.7 KB
Newer Older
Jacob Thornton's avatar
Jacob Thornton committed
1
2
3
      <!-- Masthead
      ================================================== -->
      <header class="jumbotron subhead" id="overview">
4
        <h1>{{_i}}Javascript for Bootstrap{{/i}}</h1>
5
        <p class="lead">{{_i}}Bring Bootstrap's components to life&mdash;now with 12 custom <a href="http://jquery.com/" target="_blank">jQuery</a> plugins.{{/i}}
Mark Otto's avatar
Mark Otto committed
6
        <div class="subnav">
7
          <ul class="nav nav-pills">
8
            <li><a href="#javascript">{{_i}}All plugins{{/i}}</a></li>
9
10
11
12
13
14
15
16
17
18
19
            <li><a href="#modals">{{_i}}Modal{{/i}}</a></li>
            <li><a href="#dropdowns">{{_i}}Dropdown{{/i}}</a></li>
            <li><a href="#scrollspy">{{_i}}Scrollspy{{/i}}</a></li>
            <li><a href="#tabs">{{_i}}Tab{{/i}}</a></li>
            <li><a href="#tooltips">{{_i}}Tooltip{{/i}}</a></li>
            <li><a href="#popovers">{{_i}}Popover{{/i}}</a></li>
            <li><a href="#alerts">{{_i}}Alert{{/i}}</a></li>
            <li><a href="#buttons">{{_i}}Button{{/i}}</a></li>
            <li><a href="#collapse">{{_i}}Collapse{{/i}}</a></li>
            <li><a href="#carousel">{{_i}}Carousel{{/i}}</a></li>
            <li><a href="#typeahead">{{_i}}Typeahead{{/i}}</a></li>
Mark Otto's avatar
Mark Otto committed
20
21
          </ul>
        </div>
Jacob Thornton's avatar
Jacob Thornton committed
22
      </header>
23
24


Jacob Thornton's avatar
Jacob Thornton committed
25
26
27
28
      <!-- Using Javascript w/ Bootstrap
      ================================================== -->
      <section id="javascript">
        <div class="page-header">
29
          <h1>{{_i}}jQuery plugins{{/i}} <small>{{_i}}A dozen Bootstrap plugins to get you started{{/i}}</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
30
31
32
33
        </div>
      <div class="row">
        <div class="span3">
          <label>
34
            <h3><a href="./javascript.html#modals">{{_i}}Modals{{/i}}</a></h3>
35
            <p>{{_i}}A streamlined, but flexible, take on the traditional javascript modal plugin with only the minimum required functionality and smart defaults.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
36
37
38
39
          </label>
        </div>
        <div class="span3">
          <label>
40
            <h3><a href="./javascript.html#dropdowns">{{_i}}Dropdowns{{/i}}</a></h3>
41
            <p>{{_i}}Add dropdown menus to nearly anything in Bootstrap with this simple plugin. Bootstrap features full dropdown menu support on in the navbar, tabs, and pills.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
42
43
44
45
          </label>
        </div>
        <div class="span3">
          <label>
46
            <h3><a href="./javascript.html#scrollspy">{{_i}}Scrollspy{{/i}}</a></h3>
47
            <p>{{_i}}Use scrollspy to automatically update the links in your navbar to show the current active link based on scroll position.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
48
49
50
51
          </label>
        </div>
        <div class="span3">
          <label>
52
            <h3><a href="./javascript.html#tabs">{{_i}}Togglable tabs{{/i}}</a></h3>
53
            <p>{{_i}}Use this plugin to make tabs and pills more useful by allowing them to toggle through tabbable panes of local content.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
54
55
56
57
58
59
          </label>
        </div>
      </div> <!-- /row -->
      <div class="row">
        <div class="span3">
          <label>
60
            <h3><a href="./javascript.html#tooltips">{{_i}}Tooltips{{/i}}</a></h3>
Kyle Robinson Young's avatar
Kyle Robinson Young committed
61
            <p>{{_i}}A new take on the jQuery Tipsy plugin, Tooltips don't rely on images, use CSS3 for animations, and data-attributes for local title storage.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
62
63
64
65
          </label>
        </div>
        <div class="span3">
          <label>
66
            <h3><a href="./javascript.html#popovers">{{_i}}Popovers{{/i}}</a> <small class="muted">*</small></h3>
67
68
            <p>{{_i}}Add small overlays of content, like those on the iPad, to any element for housing secondary information.{{/i}}</p>
            <p class="muted"><strong>*</strong> {{_i}}Requires <a href="#tooltips">Tooltips</a> to be included{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
69
70
71
72
          </label>
        </div>
        <div class="span3">
          <label>
73
            <h3><a href="./javascript.html#alerts">{{_i}}Alert messages{{/i}}</a></h3>
74
            <p>{{_i}}The alert plugin is a tiny class for adding close functionality to alerts.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
75
76
77
78
          </label>
        </div>
        <div class="span3">
          <label>
79
            <h3><a href="./javascript.html#buttons">{{_i}}Buttons{{/i}}</a></h3>
80
            <p>{{_i}}Do more with buttons. Control button states or create groups of buttons for more components like toolbars.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
81
82
83
          </label>
        </div>
      </div> <!-- /row -->
84
      <div class="row" style="margin-bottom: 9px;">
Jacob Thornton's avatar
Jacob Thornton committed
85
86
        <div class="span3">
          <label>
87
            <h3><a href="./javascript.html#collapse">{{_i}}Collapse{{/i}}</a></h3>
88
            <p>{{_i}}Get base styles and flexible support for collapsible components like accordions and navigation.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
89
90
91
92
          </label>
        </div>
        <div class="span3">
          <label>
93
            <h3><a href="./javascript.html#carousel">{{_i}}Carousel{{/i}}</a></h3>
94
            <p>{{_i}}Create a merry-go-round of any content you wish to provide an interactive slideshow of content.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
95
96
97
98
          </label>
        </div>
        <div class="span3">
          <label>
99
            <h3><a href="./javascript.html#typeahead">Typeahead</a></h3>
100
            <p>{{_i}}A basic, easily extended plugin for quickly creating elegant typeaheads with any form text input.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
101
102
103
104
          </label>
        </div>
        <div class="span3">
          <label>
105
            <h3>{{_i}}Transitions{{/i}} <small class="muted">*</small></h3>
106
107
            <p>{{_i}}For simple transition effects, include bootstrap-transition.js once to slide in modals or fade out alerts.{{/i}}</p>
            <p class="muted"><strong>*</strong> {{_i}}Required for animation in plugins{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
108
109
110
          </label>
        </div>
      </div> <!-- /row -->
111
      <div class="alert alert-info"><strong>{{_i}}Heads up!{{/i}}</strong> {{_i}}All javascript plugins require the latest version of jQuery.{{/i}}</div>
Jacob Thornton's avatar
Jacob Thornton committed
112
    </section>
113
114
115



Jacob Thornton's avatar
Jacob Thornton committed
116
117
118
119
    <!-- Modal
    ================================================== -->
    <section id="modals">
      <div class="page-header">
120
        <h1>{{_i}}Modals{{/i}} <small>bootstrap-modal.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
121
122
123
      </div>
      <div class="row">
        <div class="span3 columns">
124
125
          <h3>{{_i}}About modals{{/i}}</h3>
          <p>{{_i}}A streamlined, but flexible, take on the traditional javascript modal plugin with only the minimum required functionality and smart defaults.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
126
          <a href="assets/js/bootstrap-modal.js" target="_blank" class="btn">{{_i}}Download file{{/i}}</a>
127
        </div>
Jacob Thornton's avatar
Jacob Thornton committed
128
        <div class="span9 columns">
129
130
          <h2>{{_i}}Static example{{/i}}</h2>
          <p>{{_i}}Below is a statically rendered modal.{{/i}}</p>
131
          <div class="well modal-example" style="background-color: #888; border: none;">
Jacob Thornton's avatar
Jacob Thornton committed
132
133
134
            <div class="modal" style="position: relative; top: auto; left: auto; margin: 0 auto; z-index: 1">
              <div class="modal-header">
                <a href="#" class="close" data-dismiss="modal">&times;</a>
135
                <h3>{{_i}}Modal header{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
136
137
              </div>
              <div class="modal-body">
138
                <p>{{_i}}One fine body…{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
139
140
              </div>
              <div class="modal-footer">
141
                <a href="#" class="btn btn-primary">{{_i}}Save changes{{/i}}</a>
142
                <a href="#" class="btn">{{_i}}Close{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
143
144
145
              </div>
            </div>
          </div> <!-- /well -->
146

147
148
          <h2>{{_i}}Live demo{{/i}}</h2>
          <p>{{_i}}Toggle a modal via javascript by clicking the button below. It will slide down and fade in from the top of the page.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
149
150
151
          <!-- sample modal content -->
          <div id="myModal" class="modal hide fade">
            <div class="modal-header">
152
              <a class="close" data-dismiss="modal" >&times;</a>
153
              <h3>{{_i}}Modal Heading{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
154
155
            </div>
            <div class="modal-body">
156
              <h4>{{_i}}Text in a modal{{/i}}</h4>
Jacob Thornton's avatar
Jacob Thornton committed
157
              <p>Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem.</p>
158

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

162
163
              <h4>{{_i}}Tooltips in a modal{{/i}}</h4>
              <p>{{_i}}<a href="#" class="tooltip-test" title="Tooltip">This link</a> and <a href="#" class="tooltip-test" title="Tooltip">that link</a> should have tooltips on hover.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
164
165
            </div>
            <div class="modal-footer">
166
              <a href="#" class="btn btn-primary">{{_i}}Save changes{{/i}}</a>
167
              <a href="#" class="btn" data-dismiss="modal" >{{_i}}Close{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
168
169
            </div>
          </div>
170
          <a data-toggle="modal" href="#myModal" class="btn btn-primary btn-large">{{_i}}Launch demo modal{{/i}}</a>
171

Jacob Thornton's avatar
Jacob Thornton committed
172
          <hr>
173

174
175
          <h2>{{_i}}Using bootstrap-modal{{/i}}</h2>
          <p>{{_i}}Call the modal via javascript:{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
176
          <pre class="prettyprint linenums">$('#myModal').modal(options)</pre>
177
          <h3>{{_i}}Options{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
178
179
180
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
181
182
183
184
               <th style="width: 100px;">{{_i}}Name{{/i}}</th>
               <th style="width: 50px;">{{_i}}type{{/i}}</th>
               <th style="width: 50px;">{{_i}}default{{/i}}</th>
               <th>{{_i}}description{{/i}}</th>
Jacob Thornton's avatar
Jacob Thornton committed
185
186
187
188
             </tr>
            </thead>
            <tbody>
             <tr>
189
190
191
192
               <td>{{_i}}backdrop{{/i}}</td>
               <td>{{_i}}boolean{{/i}}</td>
               <td>{{_i}}true{{/i}}</td>
               <td>{{_i}}Includes a modal-backdrop element{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
193
194
             </tr>
             <tr>
195
196
197
198
               <td>{{_i}}keyboard{{/i}}</td>
               <td>{{_i}}boolean{{/i}}</td>
               <td>{{_i}}true{{/i}}</td>
               <td>{{_i}}Closes the modal when escape key is pressed{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
199
200
201
             </tr>
            </tbody>
          </table>
202
203
204
          <h3>{{_i}}Markup{{/i}}</h3>
          <p>{{_i}}You can activate modals on your page easily without having to write a single line of javascript. Just set <code>data-toggle="modal"</code> on a controller element with a <code>data-target="#foo"</code> or <code>href="#foo"</code> which corresponds to a modal element id, and when clicked, it will launch your modal.</p>
          <p>Also, to add options to your modal instance, just include them as additional data attributes on either the control element or the modal markup itself.{{/i}}</p>
205
<pre class="prettyprint linenums">
206
&lt;a class="btn" data-toggle="modal" href="#myModal" &gt;{{_i}}Launch Modal{{/i}}&lt;/a&gt;
207
208
209
210
</pre>

<pre class="prettyprint linenums">
&lt;div class="modal"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
211
  &lt;div class="modal-header"&gt;
212
    &lt;a class="close" data-dismiss="modal"&gt;&times;&lt;/a&gt;
Jacob Thornton's avatar
Jacob Thornton committed
213
214
215
    &lt;h3&gt;Modal header&lt;/h3&gt;
  &lt;/div&gt;
  &lt;div class="modal-body"&gt;
216
    &lt;p&gt;{{_i}}One fine body…{{/i}}&lt;/p&gt;
Jacob Thornton's avatar
Jacob Thornton committed
217
218
  &lt;/div&gt;
  &lt;div class="modal-footer"&gt;
219
    &lt;a href="#" class="btn btn-primary"&gt;{{_i}}Save changes{{/i}}&lt;/a&gt;
220
    &lt;a href="#" class="btn"&gt;{{_i}}Close{{/i}}&lt;/a&gt;
Jacob Thornton's avatar
Jacob Thornton committed
221
  &lt;/div&gt;
222
223
&lt;/div&gt;
</pre>
224
225
226
          <div class="alert alert-info">
            <strong>{{_i}}Heads up!{{/i}}</strong> {{_i}}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) and include bootstrap-transition.js.{{/i}}
          </div>
227
228
229
          <h3{{_i}}>Methods{{/i}}</h3>
          <h4>.modal({{_i}}options{{/i}})</h4>
          <p>{{_i}}Activates your content as a modal. Accepts an optional options <code>object</code>.{{/i}}</p>
230
231
<pre class="prettyprint linenums">
$('#myModal').modal({
Jacob Thornton's avatar
Jacob Thornton committed
232
  keyboard: false
233
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
234
          <h4>.modal('toggle')</h4>
235
          <p>{{_i}}Manually toggles a modal.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
236
237
          <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre>
          <h4>.modal('show')</h4>
238
          <p>{{_i}}Manually opens a modal.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
239
240
          <pre class="prettyprint linenums">$('#myModal').modal('show')</pre>
          <h4>.modal('hide')</h4>
241
          <p>{{_i}}Manually hides a modal.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
242
          <pre class="prettyprint linenums">$('#myModal').modal('hide')</pre>
243
244
          <h3>{{_i}}Events{{/i}}</h3>
          <p>{{_i}}Bootstrap's modal class exposes a few events for hooking into modal functionality.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
245
246
247
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
248
249
               <th style="width: 150px;">{{_i}}Event{{/i}}</th>
               <th>{{_i}}Description{{/i}}</th>
Jacob Thornton's avatar
Jacob Thornton committed
250
251
252
253
             </tr>
            </thead>
            <tbody>
             <tr>
254
255
               <td>{{_i}}show{{/i}}</td>
               <td>{{_i}}This event fires immediately when the <code>show</code> instance method is called.{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
256
257
             </tr>
             <tr>
258
259
               <td>{{_i}}shown{{/i}}</td>
               <td>{{_i}}This event is fired when the modal has been made visible to the user (will wait for css transitions to complete).{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
260
261
             </tr>
             <tr>
262
263
               <td>{{_i}}hide{{/i}}</td>
               <td>{{_i}}This event is fired immediately when the <code>hide</code> instance method has been called.{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
264
265
             </tr>
             <tr>
266
267
               <td>{{_i}}hidden{{/i}}</td>
               <td>{{_i}}This event is fired when the modal has finished being hidden from the user (will wait for css transitions to complete).{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
268
269
270
             </tr>
            </tbody>
          </table>
271
272
273

<pre class="prettyprint linenums">
$('#myModal').on('hidden', function () {
274
  // {{_i}}do something…{{/i}}
275
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
276
277
278
        </div>
      </div>
    </section>
279
280
281



Jacob Thornton's avatar
Jacob Thornton committed
282
283
284
285
    <!-- Dropdown
    ================================================== -->
    <section id="dropdowns">
      <div class="page-header">
286
        <h1>{{_i}}Dropdowns{{/i}} <small>bootstrap-dropdown.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
287
288
289
      </div>
      <div class="row">
        <div class="span3 columns">
290
291
          <h3>{{_i}}About dropdowns{{/i}}</h3>
          <p>{{_i}}Add dropdown menus to nearly anything in Bootstrap with this simple plugin. Bootstrap features full dropdown menu support on in the navbar, tabs, and pills.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
292
          <a href="assets/js/bootstrap-dropdown.js" target="_blank" class="btn">{{_i}}Download file{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
293
294
        </div>
        <div class="span9 columns">
295
296
          <h2>{{_i}}Examples{{/i}}</h2>
          <p>{{_i}}Click on the dropdown nav links in the navbar and pills below to test dropdowns.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
297
298
299
          <div id="navbar-example" class="navbar navbar-static">
            <div class="navbar-inner">
              <div class="container" style="width: auto;">
300
                <a class="brand" href="#">{{_i}}Project Name{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
301
302
                <ul class="nav">
                  <li class="dropdown">
303
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown{{/i}} <b class="caret"></b></a>
Jacob Thornton's avatar
Jacob Thornton committed
304
                    <ul class="dropdown-menu">
305
306
307
                      <li><a href="#">{{_i}}Action{{/i}}</a></li>
                      <li><a href="#">{{_i}}Another action{{/i}}</a></li>
                      <li><a href="#">{{_i}}Something else here{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
308
                      <li class="divider"></li>
309
                      <li><a href="#">{{_i}}Separated link{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
310
311
312
                    </ul>
                  </li>
                  <li class="dropdown">
313
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown 2 {{/i}}<b class="caret"></b></a>
Jacob Thornton's avatar
Jacob Thornton committed
314
                    <ul class="dropdown-menu">
315
316
317
                      <li><a href="#">{{_i}}Action{{/i}}</a></li>
                      <li><a href="#">{{_i}}Another action{{/i}}</a></li>
                      <li><a href="#">{{_i}}Something else here{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
318
                      <li class="divider"></li>
319
                      <li><a href="#">{{_i}}Separated link{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
320
321
                    </ul>
                  </li>
322
                </ul>
Jacob Thornton's avatar
Jacob Thornton committed
323
324
                <ul class="nav pull-right">
                  <li id="fat-menu" class="dropdown">
325
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown 3{{/i}} <b class="caret"></b></a>
Jacob Thornton's avatar
Jacob Thornton committed
326
                    <ul class="dropdown-menu">
327
328
329
                      <li><a href="#">{{_i}}Action{{/i}}</a></li>
                      <li><a href="#">{{_i}}Another action{{/i}}</a></li>
                      <li><a href="#">{{_i}}Something else here{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
330
                      <li class="divider"></li>
331
                      <li><a href="#">{{_i}}Separated link{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
332
333
                    </ul>
                  </li>
334
                </ul>
Jacob Thornton's avatar
Jacob Thornton committed
335
336
337
              </div>
            </div>
          </div> <!-- /navbar-example -->
338

339
          <ul class="nav nav-pills">
340
            <li class="active"><a href="#">{{_i}}Regular link{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
341
            <li class="dropdown">
342
              <a class="dropdown-toggle" data-toggle="dropdown" href="#">{{_i}}Dropdown{{/i}} <b class="caret"></b></a>
Jacob Thornton's avatar
Jacob Thornton committed
343
              <ul id="menu1" class="dropdown-menu">
344
345
346
                <li><a href="#">{{_i}}Action{{/i}}</a></li>
                <li><a href="#">{{_i}}Another action{{/i}}</a></li>
                <li><a href="#">{{_i}}Something else here{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
347
                <li class="divider"></li>
348
                <li><a href="#">{{_i}}Separated link{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
349
350
351
              </ul>
            </li>
            <li class="dropdown">
352
              <a class="dropdown-toggle" data-toggle="dropdown" href="#">{{_i}}Dropdown 2{{/i}} <b class="caret"></b></a>
Jacob Thornton's avatar
Jacob Thornton committed
353
              <ul id="menu2" class="dropdown-menu">
354
355
356
                <li><a href="#">{{_i}}Action{{/i}}</a></li>
                <li><a href="#">{{_i}}Another action{{/i}}</a></li>
                <li><a href="#">{{_i}}Something else here{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
357
                <li class="divider"></li>
358
                <li><a href="#">{{_i}}Separated link{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
359
360
361
              </ul>
            </li>
            <li class="dropdown">
362
              <a class="dropdown-toggle" data-toggle="dropdown" href="#">{{_i}}Dropdown 3{{/i}} <b class="caret"></b></a>
Jacob Thornton's avatar
Jacob Thornton committed
363
              <ul id="menu3" class="dropdown-menu">
364
365
366
                <li><a href="#">{{_i}}Action{{/i}}</a></li>
                <li><a href="#">{{_i}}Another action{{/i}}</a></li>
                <li><a href="#">{{_i}}Something else here{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
367
                <li class="divider"></li>
368
                <li><a href="#">{{_i}}Separated link{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
369
370
371
              </ul>
            </li>
          </ul> <!-- /tabs -->
372

Jacob Thornton's avatar
Jacob Thornton committed
373
          <hr>
374

375
376
          <h2>{{_i}}Using{{/i}} bootstrap-dropdown.js</h2>
          <p>{{_i}}Call the dropdowns via javascript:{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
377
          <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre>
378
379
          <h3>{{_i}}Markup{{/i}}</h3>
          <p>{{_i}}To quickly add dropdown functionality to any element just add <code>data-toggle="dropdown"</code> and any valid bootstrap dropdown will automatically be activated.{{/i}}</p>
380
381
382
          <div class="alert alert-info">
            <strong>{{_i}}Heads up!{{/i}}</strong>{{_i}} You may optionally target a specific dropdown by using <code>data-target="#fat"</code> or <code>href="#fat"</code>.{{/i}}
          </div>
383
384
385

<pre class="prettyprint linenums">
&lt;ul class="nav pills"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
386
387
388
  &lt;li class="active"&gt;&lt;a href="#"&gt;Regular link&lt;/a&gt;&lt;/li&gt;
  &lt;li class="dropdown" id="menu1"&gt;
    &lt;a class="dropdown-toggle" data-toggle="dropdown" href="#menu1"&gt;
389
      {{_i}}Dropdown{{/i}}
Jacob Thornton's avatar
Jacob Thornton committed
390
391
392
      &lt;b class="caret"&gt;&lt;/b&gt;
    &lt;/a&gt;
    &lt;ul class="dropdown-menu"&gt;
393
394
395
      &lt;li&gt;&lt;a href="#"&gt;{{_i}}Action{{/i}}&lt;/a&gt;&lt;/li&gt;
      &lt;li&gt;&lt;a href="#"&gt;{{_i}}Another action{{/i}}&lt;/a&gt;&lt;/li&gt;
      &lt;li&gt;&lt;a href="#"&gt;{{_i}}Something else here{{/i}}&lt;/a&gt;&lt;/li&gt;
Jacob Thornton's avatar
Jacob Thornton committed
396
      &lt;li class="divider"&gt;&lt;/li&gt;
397
      &lt;li&gt;&lt;a href="#"&gt;{{_i}}Separated link{{/i}}&lt;/a&gt;&lt;/li&gt;
Jacob Thornton's avatar
Jacob Thornton committed
398
399
400
    &lt;/ul&gt;
  &lt;/li&gt;
  ...
401
&lt;/ul&gt;</pre>
402
          <h3>{{_i}}Methods{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
403
          <h4>$().dropdown()</h4>
404
          <p>{{_i}}A programatic api for activating menus for a given navbar or tabbed navigation.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
405
406
407
        </div>
      </div>
    </section>
408
409
410



Jacob Thornton's avatar
Jacob Thornton committed
411
412
413
414
   <!-- ScrollSpy
    ================================================== -->
    <section id="scrollspy">
      <div class="page-header">
415
        <h1>{{_i}}ScrollSpy{{/i}} <small>bootstrap-scrollspy.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
416
417
418
      </div>
      <div class="row">
        <div class="span3 columns">
419
          <p>{{_i}}The ScrollSpy plugin is for automatically updating nav targets based on scroll position.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
420
          <a href="assets/js/bootstrap-scrollspy.js" target="_blank" class="btn">{{_i}}Download file{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
421
422
        </div>
        <div class="span9 columns">
423
424
          <h2>{{_i}}Example navbar with scrollspy{{/i}}</h2>
          <p>{{_i}}Scroll the area below and watch the navigation update. The dropdown sub items will be highlighted as well. Try it!{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
425
426
427
          <div id="navbarExample" class="navbar navbar-static">
            <div class="navbar-inner">
              <div class="container" style="width: auto;">
428
                <a class="brand" href="#">{{_i}}Project Name{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
429
430
431
432
                <ul class="nav">
                  <li><a href="#fat">@fat</a></li>
                  <li><a href="#mdo">@mdo</a></li>
                  <li class="dropdown">
433
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown{{/i}} <b class="caret"></b></a>
Jacob Thornton's avatar
Jacob Thornton committed
434
                    <ul class="dropdown-menu">
435
436
                      <li><a href="#one">{{_i}}one{{/i}}</a></li>
                      <li><a href="#two">{{_i}}two{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
437
                      <li class="divider"></li>
438
                      <li><a href="#three">{{_i}}three{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
439
440
                    </ul>
                  </li>
441
                </ul>
Jacob Thornton's avatar
Jacob Thornton committed
442
443
              </div>
            </div>
444
          </div>
Jacob Thornton's avatar
Jacob Thornton committed
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
          <div data-spy="scroll" data-target="#navbarExample" data-offset="0" 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>
          <hr>
470
471
          <h2>{{_i}}Using bootstrap-scrollspy.js{{/i}}</h2>
          <p>{{_i}}Call the scrollspy via javascript:{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
472
          <pre class="prettyprint linenums">$('#navbar').scrollspy()</pre>
473
474
          <h3>{{_i}}Markup{{/i}}</h3>
          <p>{{_i}}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).{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
475
          <pre class="prettyprint linenums">&lt;body data-spy="scroll" &gt;...&lt;/body&gt;</pre>
476
477
478
479
          <div class="alert alert-info">
            <strong>{{_i}}Heads up!{{/i}}</strong>
            {{_i}}Navbar links 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>.{{/i}}
          </div>
480
          <h3>{{_i}}Options{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
481
482
483
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
484
485
486
487
               <th style="width: 100px;">{{_i}}Name{{/i}}</th>
               <th style="width: 100px;">{{_i}}type{{/i}}</th>
               <th style="width: 50px;">{{_i}}default{{/i}}</th>
               <th>{{_i}}description{{/i}}</th>
Jacob Thornton's avatar
Jacob Thornton committed
488
489
490
491
             </tr>
            </thead>
            <tbody>
             <tr>
492
493
494
495
               <td>{{_i}}offset{{/i}}</td>
               <td>{{_i}}number{{/i}}</td>
               <td>{{_i}}10{{/i}}</td>
               <td>{{_i}}Pixels to offset from top when calculating position of scroll.{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
496
497
498
             </tr>
            </tbody>
          </table>
499
500
        </div>
      </div>
Jacob Thornton's avatar
Jacob Thornton committed
501
    </section>
502
503
504



Jacob Thornton's avatar
Jacob Thornton committed
505
506
507
508
    <!-- Tabs
    ================================================== -->
    <section id="tabs">
      <div class="page-header">
509
        <h1>{{_i}}Togglable tabs{{/i}} <small>bootstrap-tab.js</small></h1>
510
      </div>
Jacob Thornton's avatar
Jacob Thornton committed
511
512
      <div class="row">
        <div class="span3 columns">
513
          <p>{{_i}}This plugin adds quick, dynamic tab and pill functionality for transitioning through local content.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
514
          <a href="assets/js/bootstrap-tab.js" target="_blank" class="btn">{{_i}}Download file{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
515
516
        </div>
        <div class="span9 columns">
517
518
          <h2>{{_i}}Example tabs{{/i}}</h2>
          <p>{{_i}}Click the tabs below to toggle between hidden panes, even via dropdown menus.{{/i}}</p>
519
          <ul id="tab" class="nav nav-tabs">
520
521
            <li class="active"><a href="#home" data-toggle="tab">{{_i}}Home{{/i}}</a></li>
            <li><a href="#profile" data-toggle="tab">{{_i}}Profile{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
522
            <li class="dropdown">
523
              <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown{{/i}} <b class="caret"></b></a>
Jacob Thornton's avatar
Jacob Thornton committed
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
              <ul class="dropdown-menu">
                <li><a href="#dropdown1" data-toggle="tab">@fat</a></li>
                <li><a href="#dropdown2" data-toggle="tab">@mdo</a></li>
              </ul>
            </li>
          </ul>
          <div id="myTabContent" class="tab-content">
            <div class="tab-pane fade in 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 fade" 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 fade" 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 fade" 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>
            </div>
          </div>
          <hr>
545
546
          <h2>{{_i}}Using bootstrap-tab.js{{/i}}</h2>
          <p>{{_i}}Enable tabbable tabs via javascript:{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
547
          <pre class="prettyprint linenums">$('#myTab').tab('show')</pre>
548
549
          <h3>{{_i}}Markup{{/i}}</h3>
          <p>{{_i}}You can activate a tab or pill navigation without writing any javascript by simply specifying <code>data-toggle="tab"</code> or <code>data-toggle="pill"</code> on an element.{{/i}}</p>
550
551
<pre class="prettyprint linenums">
&lt;ul class="tabs"&gt;
552
553
554
  &lt;li&gt;&lt;a href="#home" data-toggle="tab"&gt;{{_i}}Home{{/i}}&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#profile" data-toggle="tab"&gt;{{_i}}Profile{{/i}}&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#messages" data-toggle="tab"&gt;{{_i}}Messages{{/i}}&lt;/a&gt;&lt;/li&gt;
Kyle Robinson Young's avatar
Kyle Robinson Young committed
555
  &lt;li&gt;&lt;a href="#settings" data-toggle="tab"&gt;{{_i}}Settings{{/i}}&lt;/a&gt;&lt;/li&gt;
556
&lt;/ul&gt;</pre>
557
          <h3>{{_i}}Methods{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
558
559
          <h4>$().tab</h4>
          <p>
560
            {{_i}}Activates a tab element and content container. Tab should have either a `data-target` or an `href` targeting a container node in the dom.{{/i}}
Jacob Thornton's avatar
Jacob Thornton committed
561
          </p>
562
563
<pre class="prettyprint linenums">
&lt;ul class="tabs"&gt;
564
565
566
567
  &lt;li class="active"&gt;&lt;a href="#home"&gt;{{_i}}Home{{/i}}&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#profile"&gt;{{_i}}Profile{{/i}}&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#messages"&gt;{{_i}}Messages{{/i}}&lt;/a&gt;&lt;/li&gt;
  &lt;li&gt;&lt;a href="#settings"&gt;{{_i}}Settings{{/i}}&lt;/a&gt;&lt;/li&gt;
568
569
570
&lt;/ul&gt;

&lt;div class="tab-content"&gt;
Mark Otto's avatar
Mark Otto committed
571
572
573
574
  &lt;div class="tab-pane active" id="home"&gt;...&lt;/div&gt;
  &lt;div class="tab-pane" id="profile"&gt;...&lt;/div&gt;
  &lt;div class="tab-pane" id="messages"&gt;...&lt;/div&gt;
  &lt;div class="tab-pane" id="settings"&gt;...&lt;/div&gt;
575
576
577
&lt;/div&gt;

&lt;script&gt;
Jacob Thornton's avatar
Jacob Thornton committed
578
579
580
  $(function () {
    $('.tabs a:last').tab('show')
  })
581
&lt;/script&gt;</pre>
582
          <h3>{{_i}}Events{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
583
584
585
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
586
587
               <th style="width: 150px;">{{_i}}Event{{/i}}</th>
               <th>{{_i}}Description{{/i}}</th>
Jacob Thornton's avatar
Jacob Thornton committed
588
589
590
591
             </tr>
            </thead>
            <tbody>
             <tr>
592
593
               <td>{{_i}}show{{/i}}</td>
               <td>{{_i}}This event fires on tab show, but before the new tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
594
595
            </tr>
            <tr>
596
597
               <td>{{_i}}shown{{/i}}</td>
               <td>{{_i}}This event fires on tab show after a tab has been shown. Use <code>event.target</code> and <code>event.relatedTarget</code> to target the active tab and the previous active tab (if available) respectively.{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
598
599
600
             </tr>
            </tbody>
          </table>
601

Jacob Thornton's avatar
Jacob Thornton committed
602
          <pre class="prettyprint linenums">
603
$('a[data-toggle="tab"]').on('shown', function (e) {
Jacob Thornton's avatar
Jacob Thornton committed
604
605
  e.target // activated tab
  e.relatedTarget // previous tab
606
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
607
608
609
       </div>
      </div>
    </section>
610
611


Jacob Thornton's avatar
Jacob Thornton committed
612
613
614
615
    <!-- Tooltips
    ================================================== -->
    <section id="tooltips">
      <div class="page-header">
616
        <h1>{{_i}}Tooltips{{/i}} <small>bootstrap-tooltip.js</small></h1>
617
      </div>
Jacob Thornton's avatar
Jacob Thornton committed
618
619
      <div class="row">
        <div class="span3 columns">
620
621
          <h3>{{_i}}About Tooltips{{/i}}</h3>
          <p>{{_i}}Inspired by the excellent jQuery.tipsy plugin written by Jason Frame; Tooltips are an updated version, which don't rely on images, uss css3 for animations, and data-attributes for local title storage.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
622
          <a href="assets/js/bootstrap-tooltip.js" target="_blank" class="btn">{{_i}}Download file{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
623
624
        </div>
        <div class="span9 columns">
625
626
          <h2>{{_i}}Example use of Tooltips{{/i}}</h2>
          <p>{{_i}}Hover over the links below to see tooltips:{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
627
          <div class="tooltip-demo well">
628
            <p class="muted" style="margin-bottom: 0;">{{_i}}Tight pants next level keffiyeh <a href="#" rel='tooltip' title="first tooltip">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='tooltip' title='Another tooltip'>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='tooltip' title='Another one here too'>really ironic</a> artisan whatever keytar, scenester farm-to-table banksy Austin <a href="#" rel='tooltip' title='The last tip!'>twitter handle</a> freegan cred raw denim single-origin coffee viral.{{/i}}
Jacob Thornton's avatar
Jacob Thornton committed
629
630
631
            </p>
          </div>
          <hr>
632
633
634
635
          <h2>{{_i}}Using{{/i}} bootstrap-tooltip.js</h2>
          <p>{{_i}}Trigger the tooltip via javascript:{{/i}}</p>
          <pre class="prettyprint linenums">$('#example').tooltip({{_i}}options{{/i}})</pre>
          <h3>{{_i}}Options{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
636
637
638
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
639
640
               <th style="width: 100px;">{{_i}}Name{{/i}}</th>
               <th style="width: 100px;">{{_i}}type{{/i}}</th>
Jacob Thornton's avatar
Jacob Thornton committed
641
               <th style="width: 50px;">{{_i}}default{{/i}}</th>
642
               <th>{{_i}}description{{/i}}</th>
Jacob Thornton's avatar
Jacob Thornton committed
643
644
645
646
             </tr>
            </thead>
            <tbody>
             <tr>
647
648
               <td>{{_i}}animation{{/i}}</td>
               <td>{{_i}}boolean{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
649
               <td>true</td>
650
               <td>{{_i}}apply a css fade transition to the tooltip{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
651
652
             </tr>
             <tr>
653
654
               <td>{{_i}}placement{{/i}}</td>
               <td>{{_i}}string{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
655
               <td>'top'</td>
656
               <td>{{_i}}how to position the tooltip{{/i}} - top | bottom | left | right</td>
Jacob Thornton's avatar
Jacob Thornton committed
657
658
             </tr>
             <tr>
659
660
               <td>{{_i}}selector{{/i}}</td>
               <td>{{_i}}string{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
661
               <td>false</td>
662
               <td>{{_i}}If a selector is provided, tooltip objects will be delegated to the specified targets.{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
663
664
             </tr>
             <tr>
665
666
               <td>{{_i}}title{{/i}}</td>
               <td>{{_i}}string | function{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
667
               <td>''</td>
668
               <td>{{_i}}default title value if `title` tag isn't present{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
669
670
             </tr>
             <tr>
671
672
               <td>{{_i}}trigger{{/i}}</td>
               <td>{{_i}}string{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
673
               <td>'hover'</td>
674
               <td>{{_i}}how tooltip is triggered{{/i}} - hover | focus | manual</td>
Jacob Thornton's avatar
Jacob Thornton committed
675
676
             </tr>
             <tr>
677
678
               <td>{{_i}}delay{{/i}}</td>
               <td>{{_i}}number | object{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
679
680
               <td>0</td>
               <td>
681
                <p>{{_i}}delay showing and hiding the tooltip (ms){{/i}}</p>
682
683
                <p>{{_i}}If a number is supplied, delay is applied to both hide/show{{/i}}</p>
                <p>{{_i}}Object structure is: <code>delay: { show: 500, hide: 100 }</code>{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
684
685
686
687
               </td>
             </tr>
            </tbody>
          </table>
688
689
690
691
          <div class="alert alert-info">
            <strong>{{_i}}Heads up!{{/i}}</strong>
            {{_i}}Options for individual tooltips can alternatively be specified through the use of data attributes.{{/i}}
          </div>
692
693
694
695
696
          <h3>{{_i}}Markup{{/i}}</h3>
          <p>{{_i}}For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a selector option.{{/i}}</p>
          <h3>{{_i}}Methods{{/i}}</h3>
          <h4>$().tooltip({{_i}}options{{/i}})</h4>
          <p>{{_i}}Attaches a tooltip handler to an element collection.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
697
          <h4>.tooltip('show')</h4>
698
          <p>{{_i}}Reveals an elements tooltip.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
699
700
          <pre class="prettyprint linenums">$('#element').tooltip('show')</pre>
          <h4>.tooltip('hide')</h4>
701
          <p>{{_i}}Hides an elements tooltip.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
702
          <pre class="prettyprint linenums">$('#element').tooltip('hide')</pre>
703
704
705
          <h4>.tooltip('toggle')</h4>
          <p>{{_i}}Toggles an elements tooltip.{{/i}}</p>
          <pre class="prettyprint linenums">$('#element').tooltip('toggle')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
706
707
708
        </div>
      </div>
    </section>
709
710
711



Jacob Thornton's avatar
Jacob Thornton committed
712
713
714
715
    <!-- Popovers
    ================================================== -->
    <section id="popovers">
      <div class="page-header">
716
        <h1>{{_i}}Popovers{{/i}} <small>bootstrap-popover.js</small></h1>
717
      </div>
Jacob Thornton's avatar
Jacob Thornton committed
718
719
      <div class="row">
        <div class="span3 columns">
720
721
722
          <h3>{{_i}}About popovers{{/i}}</h3>
          <p>{{_i}}Add small overlays of content, like those on the iPad, to any element for housing secondary information.{{/i}}</p>
          <p class="muted"><strong>*</strong> {{_i}}Requires <a href="#tooltip">Tooltip</a> to be included{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
723
          <a href="assets/js/bootstrap-popover.js" target="_blank" class="btn">{{_i}}Download file{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
724
725
        </div>
        <div class="span9 columns">
726
727
          <h2>{{_i}}Example hover popover{{/i}}</h2>
          <p>{{_i}}Hover over the button to trigger the popover.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
728
          <div class="well">
729
            <a href="#" class="btn btn-danger" rel="popover" title="A Title" data-content="And here's some amazing content. It's very engaging. right?">{{_i}}hover for popover{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
730
731
          </div>
          <hr>
732
733
734
735
          <h2>{{_i}}Using bootstrap-popover.js{{/i}}</h2>
          <p>{{_i}}Enable popovers via javascript:{{/i}}</p>
          <pre class="prettyprint linenums">$('#example').popover({{_i}}options{{/i}})</pre>
          <h3>{{_i}}Options{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
736
737
738
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
739
740
741
742
               <th style="width: 100px;">{{_i}}Name{{/i}}</th>
               <th style="width: 100px;">{{_i}}type{{/i}}</th>
               <th style="width: 50px;">{{_i}}default{{/i}}</th>
               <th>{{_i}}description{{/i}}</th>
Jacob Thornton's avatar
Jacob Thornton committed
743
744
745
746
             </tr>
            </thead>
            <tbody>
             <tr>
747
748
               <td>{{_i}}animation{{/i}}</td>
               <td>{{_i}}boolean{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
749
               <td>true</td>
750
               <td>{{_i}}apply a css fade transition to the tooltip{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
751
752
             </tr>
             <tr>
753
754
               <td>{{_i}}placement{{/i}}</td>
               <td>{{_i}}string{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
755
               <td>'right'</td>
756
               <td>{{_i}}how to position the popover{{/i}} - top | bottom | left | right</td>
Jacob Thornton's avatar
Jacob Thornton committed
757
758
             </tr>
             <tr>
759
760
               <td>{{_i}}selector{{/i}}</td>
               <td>{{_i}}string{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
761
               <td>false</td>
762
               <td>{{_i}}if a selector is provided, tooltip objects will be delegated to the specified targets{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
763
764
             </tr>
             <tr>
765
766
               <td>{{_i}}trigger{{/i}}</td>
               <td>{{_i}}string{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
767
               <td>'hover'</td>
768
               <td>{{_i}}how tooltip is triggered{{/i}} - hover | focus | manual</td>
Jacob Thornton's avatar
Jacob Thornton committed
769
770
             </tr>
             <tr>
771
772
               <td>{{_i}}title{{/i}}</td>
               <td>{{_i}}string | function{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
773
               <td>''</td>
774
               <td>{{_i}}default title value if `title` attribute isn't present{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
775
776
             </tr>
             <tr>
777
778
               <td>{{_i}}content{{/i}}</td>
               <td>{{_i}}string | function{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
779
               <td>''</td>
780
               <td>{{_i}}default content value if `data-content` attribute isn't present{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
781
782
             </tr>
             <tr>
783
784
               <td>{{_i}}delay{{/i}}</td>
               <td>{{_i}}number | object{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
785
786
               <td>0</td>
               <td>
787
                <p>{{_i}}delay showing and hiding the popover (ms){{/i}}</p>
788
789
                <p>{{_i}}If a number is supplied, delay is applied to both hide/show{{/i}}</p>
                <p>{{_i}}Object structure is: <code>delay: { show: 500, hide: 100 }</code>{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
790
791
792
793
               </td>
             </tr>
            </tbody>
          </table>
794
795
796
797
          <div class="alert alert-info">
            <strong>{{_i}}Heads up!{{/i}}</strong>
            {{_i}}Options for individual popovers can alternatively be specified through the use of data attributes.{{/i}}
          </div>
798
          <h3>{{_i}}Markup{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
799
          <p>
800
          {{_i}}For performance reasons, the Tooltip and Popover data-apis are opt in. If you would like to use them just specify a the selector option.{{/i}}
Jacob Thornton's avatar
Jacob Thornton committed
801
          </p>
802
803
804
          <h3>{{_i}}Methods{{/i}}</h3>
          <h4>$().popover({{_i}}options{{/i}})</h4>
          <p>{{_i}}Initializes popovers for an element collection.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
805
          <h4>.popover('show')</h4>
806
          <p>{{_i}}Reveals an elements popover.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
807
808
          <pre class="prettyprint linenums">$('#element').popover('show')</pre>
          <h4>.popover('hide')</h4>
809
          <p>{{_i}}Hides an elements popover.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
810
          <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
811
812
813
          <h4>.popover('toggle')</h4>
          <p>{{_i}}Toggles an elements popover.{{/i}}</p>
          <pre class="prettyprint linenums">$('#element').popover('toggle')</pre>
Jacob Thornton's avatar
Jacob Thornton committed
814
815
816
        </div>
      </div>
    </section>
817
818
819



Jacob Thornton's avatar
Jacob Thornton committed
820
821
822
823
    <!-- Alert
    ================================================== -->
    <section id="alerts">
      <div class="page-header">
824
        <h1>{{_i}}Alert messages{{/i}} <small>bootstrap-alert.js</small></h1>
825
      </div>
Jacob Thornton's avatar
Jacob Thornton committed
826
827
      <div class="row">
        <div class="span3 columns">
828
829
          <h3>{{_i}}About alerts{{/i}}</h3>
          <p>{{_i}}The alert plugin is a tiny class for adding close functionality to alerts.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
830
          <a href="assets/js/bootstrap-alert.js" target="_blank" class="btn">{{_i}}Download{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
831
832
        </div>
        <div class="span9 columns">
833
834
          <h2>{{_i}}Example alerts{{/i}}</h2>
          <p>{{_i}}The alerts plugin works on regular alert messages, and block messages.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
835
836
          <div class="alert fade in">
            <a class="close" data-dismiss="alert" href="#">&times;</a>
Mark Otto's avatar
Mark Otto committed
837
            <strong>{{_i}}Holy guacamole!{{/i}}</strong> {{_i}}Best check yo self, you're not looking too good.{{/i}}
Jacob Thornton's avatar
Jacob Thornton committed
838
839
840
          </div>
          <div class="alert alert-block alert-error fade in">
            <a class="close" data-dismiss="alert" href="#">&times;</a>
841
842
            <h4 class="alert-heading">{{_i}}Oh snap! You got an error!{{/i}}</h4>
            <p>{{_i}}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.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
843
            <p>
844
              <a class="btn btn-danger small" href="#">{{_i}}Take this action{{/i}}</a> <a class="btn small" href="#">{{_i}}Or do this{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
845
846
847
            </p>
          </div>
          <hr>
848
849
          <h2>{{_i}}Using bootstrap-alerts.js{{/i}}</h2>
          <p>{{_i}}Enable dismissal of an alert via javascript:{{/i}}</p>
850
          <pre class="prettyprint linenums">$(".alert").alert()</pre>
851
852
          <h3>{{_i}}Markup{{/i}}</h3>
          <p>{{_i}}Just add <code>data-dismiss="alert"</code> to your close button to automatically give an alert close functionality.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
853
          <pre class="prettyprint linenums">&lt;a class="close" data-dismiss="alert" href="#"&gt;&amp;times;&lt;/a&gt;</pre>
854
          <h3>{{_i}}Methods{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
855
          <h4>$().alert()</h4>
856
          <p>{{_i}}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.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
857
          <h4>.alert('close')</h4>
858
          <p>{{_i}}Closes an alert.{{/i}}</p>
859
          <pre class="prettyprint linenums">$(".alert").alert('close')</pre>
860
861
          <h3>{{_i}}Events{{/i}}</h3>
          <p>{{_i}}Bootstrap's alert class exposes a few events for hooking into alert functionality.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
862
863
864
          <table class="table table-bordered table-striped">
            <thead>
             <tr>
865
866
               <th style="width: 150px;">{{_i}}Event{{/i}}</th>
               <th>{{_i}}Description{{/i}}</th>
Jacob Thornton's avatar
Jacob Thornton committed
867
868
869
870
             </tr>
            </thead>
            <tbody>
             <tr>
871
872
               <td>{{_i}}close{{/i}}</td>
               <td>{{_i}}This event fires immediately when the <code>close</code> instance method is called.{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
873
874
             </tr>
             <tr>
875
876
               <td>{{_i}}closed{{/i}}</td>
               <td>{{_i}}This event is fired when the alert has been closed (will wait for css transitions to complete).{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
877
878
879
             </tr>
            </tbody>
          </table>
880
881
<pre class="prettyprint linenums">
$('#my-alert').bind('closed', function () {
882
  // {{_i}}do something…{{/i}}
883
})</pre>
Jacob Thornton's avatar
Jacob Thornton committed
884
885
886
        </div>
      </div>
    </section>
887
888
889



Jacob Thornton's avatar
Jacob Thornton committed
890
891
892
893
    <!-- Buttons
    ================================================== -->
    <section id="buttons">
      <div class="page-header">
894
        <h1>{{_i}}Buttons{{/i}} <small>bootstrap-button.js</small></h1>
Jacob Thornton's avatar
Jacob Thornton committed
895
896
897
      </div>
      <div class="row">
        <div class="span3 columns">
898
899
          <h3>{{_i}}About{{/i}}</h3>
          <p>{{_i}}Do more with buttons. Control button states or create groups of buttons for more components like toolbars.{{/i}}</p>
Mark Otto's avatar
Mark Otto committed
900
          <a href="assets/js/bootstrap-button.js" target="_blank" class="btn">{{_i}}Download file{{/i}}</a>
Jacob Thornton's avatar
Jacob Thornton committed
901
902
        </div>
        <div class="span9 columns">
903
904
          <h2>{{_i}}Example uses{{/i}}</h2>
          <p>{{_i}}Use the buttons plugin for states and toggles.{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
905
906
907
          <table class="table table-bordered table-striped">
            <tbody>
             <tr>
908
               <td>{{_i}}Stateful{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
909
               <td>
910
                  <button id="fat-btn" data-loading-text="loading..." class="btn btn-primary">
911
                    {{_i}}Loading State{{/i}}
Jacob Thornton's avatar
Jacob Thornton committed
912
913
914
915
                  </button>
                </td>
             </tr>
             <tr>
916
               <td>{{_i}}Single toggle{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
917
               <td>
918
                  <button class="btn btn-primary" data-toggle="button">{{_i}}Single Toggle{{/i}}</button>
Jacob Thornton's avatar
Jacob Thornton committed
919
920
921
                </td>
             </tr>
             <tr>
922
               <td>{{_i}}Checkbox{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
923
924
               <td>
                  <div class="btn-group" data-toggle="buttons-checkbox">
925
926
927
                    <button class="btn btn-primary">{{_i}}Left{{/i}}</button>
                    <button class="btn btn-primary">{{_i}}Middle{{/i}}</button>
                    <button class="btn btn-primary">{{_i}}Right{{/i}}</button>
Jacob Thornton's avatar
Jacob Thornton committed
928
929
930
931
                  </div>
               </td>
             </tr>
             <tr>
932
               <td>{{_i}}Radio{{/i}}</td>
Jacob Thornton's avatar
Jacob Thornton committed
933
934
               <td>
                  <div class="btn-group" data-toggle="buttons-radio">
935
936
937
                    <button class="btn btn-primary">{{_i}}Left{{/i}}</button>
                    <button class="btn btn-primary">{{_i}}Middle{{/i}}</button>
                    <button class="btn btn-primary">{{_i}}Right{{/i}}</button>
Jacob Thornton's avatar
Jacob Thornton committed
938
939
940
941
942
943
                  </div>
               </td>
             </tr>
            </tbody>
          </table>
          <hr>
944
945
          <h2>{{_i}}Using bootstrap-button.js{{/i}}</h2>
          <p>{{_i}}Enable buttons via javascript:{{/i}}</p>
Jacob Thornton's avatar
Jacob Thornton committed
946
          <pre class="prettyprint linenums">$('.tabs').button()</pre>
947
948
            <h3>{{_i}}Markup{{/i}}</h3>
          <p>{{_i}}Data attributes are integral to the button plugin. Check out the example code below for the various markup types.{{/i}}</p>
949
<pre class="prettyprint linenums">
Mark Otto's avatar
Mark Otto committed
950
&lt;!-- {{_i}}Add data-toggle="button" to activate toggling on a single button{{/i}} --&gt;
951
952
&lt;button class="btn" data-toggle="button"&gt;Single Toggle&lt;/button&gt;

Mark Otto's avatar
Mark Otto committed
953
&lt;!-- {{_i}}Add data-toggle="buttons-checkbox" for checkbox style toggling on btn-group{{/i}} --&gt;
954
&lt;div class="btn-group" data-toggle="buttons-checkbox"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
955
956
957
  &lt;button class="btn"&gt;Left&lt;/button&gt;
  &lt;button class="btn"&gt;Middle&lt;/button&gt;
  &lt;button class="btn"&gt;Right&lt;/button&gt;
958
959
&lt;/div&gt;

Mark Otto's avatar
Mark Otto committed
960
&lt;!-- {{_i}}Add data-toggle="buttons-radio" for radio style toggling on btn-group{{/i}} --&gt;
961
&lt;div class="btn-group" data-toggle="buttons-radio"&gt;
Jacob Thornton's avatar
Jacob Thornton committed
962
963
964
  &lt;button class="btn"&gt;Left&lt;/button&gt;
  &lt;button class="btn"&gt;Middle&lt;/button&gt;
  &lt;button class="btn"&gt;Right&lt;/button&gt;
965
966
&lt;/div&gt;
</pre>
967
          <h3>{{_i}}Methods{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
968
          <h4>$().button('toggle')</h4>
969
          <p>{{_i}}Toggles push state. Gives btn the look that it hass been activated.{{/i}}</p>
970
971
972
973
          <div class="alert alert-info">
            <strong>{{_i}}Heads up!{{/i}}</strong>
            {{_i}}You can enable auto toggling of a button by using the <code>data-toggle</code> attribute.{{/i}}
          </div>
974
          <pre class="prettyprint linenums">&lt;button class="btn" data-toggle="button" &gt;&lt;/button&gt;</pre>
Jacob Thornton's avatar
Jacob Thornton committed
975
          <h4>$().button('loading')</h4>
976
          <p>{{_i}}Sets button state to loading - disables button and swaps text to loading text. Loading text should be defined on the button element using the data attribute <code>data-loading-text</code>.{{/i}}
Jacob Thornton's avatar
Jacob Thornton committed
977
          </p>
978
979
980
981
982
983
984
985
986
          <pre class="prettyprint linenums">&lt;button class="btn" data-loading-text="loading stuff..." &gt;...&lt;/button&gt;</pre>
          <div class="alert alert-info">
            <strong>{{_i}}Heads up!{{/i}}</strong>
            {{_i}}<a href="https://github.com/twitter/bootstrap/issues/793">Firefox persists the disabled state across page loads</a>. A workaround for this is to use <code>autocomplete="off"</code>.{{/i}}
          </div>
          <h4>$().button('reset')</h4>
          <p>{{_i}}Resets button state - swaps text to original text.{{/i}}</p>
          <h4>$().button(string)</h4>
          <p>{{_i}}Resets button state - swaps text to any data defined text state.{{/i}}</p>
987
988
<pre class="prettyprint linenums">&lt;button class="btn" data-complete-text="finished!" &gt;...&lt;/button&gt;
&lt;script&gt;
Jacob Thornton's avatar
Jacob Thornton committed
989
  $('.btn').button('complete')
990
&lt;/script&gt;</pre>
Jacob Thornton's avatar
Jacob Thornton committed
991
992
993
        </div>
      </div>
    </section>
994
995
996



Jacob Thornton's avatar
Jacob Thornton committed
997
998
999
1000
    <!-- Collapse
    ================================================== -->
    <section id="collapse">
      <div class="page-header">
For faster browsing, not all history is shown. View entire blame