javascript.mustache 70.1 KB
Newer Older
1
2
3
4
5
<!-- Masthead
================================================== -->
<header class="jumbotron subhead" id="overview">
  <h1>{{_i}}Javascript for Bootstrap{{/i}}</h1>
  <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}}
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  <div class="navbar navbar-subnav">
    <div class="navbar-inner">
      <ul class="nav">
        <li><a href="#transitions">{{_i}}Transitions{{/i}}</a></li>
        <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>
        <li><a href="#affix">{{_i}}Affix{{/i}}</a></li>
      </ul>
    </div>
Mark Otto's avatar
Mark Otto committed
24
  </div>
25
26
27
</header>


28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
<div class="row">
  <div class="span3 bs-docs-sidebar">
    <ul class="nav nav-list bs-docs-sidenav">
      <li><a href="#transitions">{{_i}}Transitions{{/i}}</a></li>
      <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>
      <li><a href="#affix">{{_i}}Affix{{/i}}</a></li>
    </ul>
  </div>
  <div class="span9">


49

50
51
52
53
54
55
56

<!-- Overview
================================================== -->
<section id="overview">
  <div class="page-header">
    <h1>{{_i}}Javascript in Bootstrap{{/i}}</h1>
  </div>
57

58
59
  <h3>{{_i}}Individual or compiled{{/i}}</h3>
  <p>{{_i}}If you have downloaded the latest version of Bootstrap, both <strong>bootstrap.js</strong> and <strong>bootstrap.min.js</strong> contain all of these plugins.{{/i}}</p>
60
61

  <h3>{{_i}}Data attributes{{/i}}</h3>
62
  <p>{{_i}}...{{/i}}</p>
63

64
65
66
67
68
69
70
71
72
73
74
75
  <h3>{{_i}}Programmatic API{{/i}}</h3>
  <p>{{_i}}...{{/i}}</p>


  {{! Thought: consider porting much of the JS readme here? }}

</section>



<!-- Transitions
================================================== -->
76
<section id="transitions">
77
78
79
80
  <div class="page-header">
    <h1>{{_i}}Transitions{{/i}} <small>bootstrap-transition.js</small></h1>
  </div>
  <h3>{{_i}}About transitions{{/i}}</h3>
81
82
83
84
85
86
87
88
89
90
91
  <p>{{_i}}For simple transition effects, include bootstrap-transition.js once alongside the other JS files. If you're using the compiled (or minified) bootstrap.js, there is no need to include this&mdash;it's already there.{{/i}}</p>
  <h3>{{_i}}Use cases{{/i}}</h3>
  <p>{{_i}}A few examples of the transition plugin:{{/i}}</p>
  <ul>
    <li>{{_i}}Sliding or fading in modals{{/i}}</li>
    <li>{{_i}}Fading out tabs{{/i}}</li>
    <li>{{_i}}Fading out alerts{{/i}}</li>
    <li>{{_i}}Sliding carousel panes{{/i}}</li>
  </ul>

  {{! Ideas: include docs for .fade.in, .slide.in, etc }}
92
</section>
93
94
95



96
97
98
99
100
101
102
<!-- Modal
================================================== -->
<section id="modals">
  <div class="page-header">
    <h1>{{_i}}Modals{{/i}} <small>bootstrap-modal.js</small></h1>
  </div>

103

104
105
  <h2>{{_i}}Examples{{/i}}</h2>
  <p>{{_i}}Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults.{{/i}}</p>
106

107
  <h3>{{_i}}Static example{{/i}}</h3>
108
  <p>{{_i}}A rendered modal with header, body, and set of actions in the footer.{{/i}}</p>
109
110
111
112
113
  <div class="bs-docs-example" style="background-color: #f5f5f5;">
    <div class="modal" style="position: relative; top: auto; left: auto; margin: 0 auto 20px; z-index: 1; max-width: 100%;">
      <div class="modal-header">
        <button type="button" class="close" data-dismiss="modal">&times;</button>
        <h3>{{_i}}Modal header{{/i}}</h3>
Jacob Thornton's avatar
Jacob Thornton committed
114
      </div>
115
116
117
118
119
120
121
122
123
      <div class="modal-body">
        <p>{{_i}}One fine body…{{/i}}</p>
      </div>
      <div class="modal-footer">
        <a href="#" class="btn">{{_i}}Close{{/i}}</a>
        <a href="#" class="btn btn-primary">{{_i}}Save changes{{/i}}</a>
      </div>
    </div>
  </div>{{! /example }}
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<pre class="prettyprint linenums">
&lt;div class="modal hide fade"&gt;
  &lt;div class="modal-header"&gt;
    &lt;button type="button" class="close" data-dismiss="modal"&gt;&amp;times;&lt;/button&gt;
    &lt;h3&gt;{{_i}}Modal header{{/i}}&lt;/h3&gt;
  &lt;/div&gt;
  &lt;div class="modal-body"&gt;
    &lt;p&gt;{{_i}}One fine body…{{/i}}&lt;/p&gt;
  &lt;/div&gt;
  &lt;div class="modal-footer"&gt;
    &lt;a href="#" class="btn"&gt;{{_i}}Close{{/i}}&lt;/a&gt;
    &lt;a href="#" class="btn btn-primary"&gt;{{_i}}Save changes{{/i}}&lt;/a&gt;
  &lt;/div&gt;
&lt;/div&gt;
</pre>

  <h3>{{_i}}Live demo{{/i}}</h3>
141
142
  <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>
  <!-- sample modal content -->
143
  <div id="myModal" class="modal hide" tabindex="-1" role="dialog" aria-labelledby="myModalLabel">
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
    <div class="modal-header">
      <button type="button" class="close" data-dismiss="modal">&times;</button>
      <h3 id="myModalLabel">{{_i}}Modal Heading{{/i}}</h3>
    </div>
    <div class="modal-body">
      <h4>{{_i}}Text in a modal{{/i}}</h4>
      <p>Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem.</p>

      <h4>{{_i}}Popover in a modal{{/i}}</h4>
      <p>{{_i}}This <a href="#" role="button" 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>

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

      <hr>

      <h4>{{_i}}Overflowing text to show optional scrollbar{{/i}}</h4>
      <p>{{_i}}We set a fixed <code>max-height</code> on the <code>.modal-body</code>. Watch it overflow with all this extra lorem ipsum text we've included.{{/i}}</p>
      <p>Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.</p>
      <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.</p>
      <p>Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.</p>
      <p>Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.</p>
      <p>Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor.</p>
      <p>Aenean lacinia bibendum nulla sed consectetur. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Donec sed odio dui. Donec ullamcorper nulla non metus auctor fringilla.</p>
    </div>
    <div class="modal-footer">
      <a href="#" role="button" class="btn" data-dismiss="modal" >{{_i}}Close{{/i}}</a>
      <a href="#" role="button" class="btn btn-primary">{{_i}}Save changes{{/i}}</a>
    </div>
  </div>
  <div class="bs-docs-example" style="padding-bottom: 24px;">
    <a data-toggle="modal" href="#myModal" class="btn btn-primary btn-large">{{_i}}Launch demo modal{{/i}}</a>
  </div>{{! /example }}
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
<pre class="prettyprint linenums">
&lt;-- Button to trigger modal --&gt;
&lt;a href="#myModal" role="button" class="btn" data-toggle="modal"&gt;{{_i}}Launch demo modal{{/i}}&lt;/a&gt;

&lt;-- Modal --&gt;
&lt;div class="modal" id="myModal" tabindex="-1" role="dialog" aria-labelledby="myModalLabel"&gt;
  &lt;div class="modal-header"&gt;
    &lt;button type="button" class="close" data-dismiss="modal"&gt;&times;&lt;/button&gt;
    &lt;h3 id="myModalLabel"&gt;Modal header&lt;/h3&gt;
  &lt;/div&gt;
  &lt;div class="modal-body"&gt;
    &lt;p&gt;{{_i}}One fine body…{{/i}}&lt;/p&gt;
  &lt;/div&gt;
  &lt;div class="modal-footer"&gt;
    &lt;a href="#" role="button" class="btn"&gt;{{_i}}Close{{/i}}&lt;/a&gt;
    &lt;a href="#" role="button" class="btn btn-primary"&gt;{{_i}}Save changes{{/i}}&lt;/a&gt;
  &lt;/div&gt;
&lt;/div&gt;
</pre>
196
197


198
199
200
201
  <hr class="bs-docs-separator">


  <h2>{{_i}}Usage{{/i}}</h2>
202
203
204
205
206
207
208
209
210

  <h3>{{_i}}Via data attributes{{/i}}</h3>
  <p>{{_i}}Activate a modal without writing javascript. Set <code>data-toggle="modal"</code> on a controller element, like a button, along with a <code>data-target="#foo"</code> or <code>href="#foo"</code> to target a specific modal to toggle.{{/i}}</p>
<pre class="prettyprint linenums">
&lt;button type="button" data-toggle="modal" data-target="#myModal"&gt;Launch modal&lt;/button&gt;
</pre>

  <h3>{{_i}}Via javascript{{/i}}</h3>
  <p>{{_i}}Call a modal with id <code>myModal</code> with a single line of javascript:{{/i}}</p>
211
  <pre class="prettyprint linenums">$('#myModal').modal(options)</pre>
212

213
  <h3>{{_i}}Options{{/i}}</h3>
214
  <p>{{_i}}Options can be passed via data attributes or javascript. For data attributes, append the option name to <code>data-</code>, as in <code>data-backdrop=""</code>.{{/i}}</p>
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <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>
     </tr>
    </thead>
    <tbody>
     <tr>
       <td>{{_i}}backdrop{{/i}}</td>
       <td>{{_i}}boolean{{/i}}</td>
       <td>{{_i}}true{{/i}}</td>
       <td>{{_i}}Includes a modal-backdrop element. Alternatively, specify <code>static</code> for a backdrop which doesn't close the modal on click.{{/i}}</td>
     </tr>
     <tr>
       <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>
     </tr>
     <tr>
       <td>{{_i}}show{{/i}}</td>
       <td>{{_i}}boolean{{/i}}</td>
       <td>{{_i}}true{{/i}}</td>
       <td>{{_i}}Shows the modal when initialized.{{/i}}</td>
     </tr>
     <tr>
       <td>{{_i}}remote{{/i}}</td>
       <td>{{_i}}path{{/i}}</td>
       <td>{{_i}}false{{/i}}</td>
       <td><p>{{_i}}If a remote url is provided, content will be loaded via jQuery's <code>load</code> method and injected into the <code>.modal-body</code>. If you're using the data api, you may alternatively use the <code>href</code> tag to specify the remote source. An example of this is shown below:{{/i}}</p>
248
<pre class="prettyprint linenums"><code>&lt;a data-toggle="modal" href="remote.html" data-target="#modal"&gt;click me&lt;/a&gt;</code></pre></td>
249
250
251
     </tr>
    </tbody>
  </table>
252

253
254
255
  <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>
256
257
<pre class="prettyprint linenums">
$('#myModal').modal({
Jacob Thornton's avatar
Jacob Thornton committed
258
  keyboard: false
259
})</pre>
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
  <h4>.modal('toggle')</h4>
  <p>{{_i}}Manually toggles a modal.{{/i}}</p>
  <pre class="prettyprint linenums">$('#myModal').modal('toggle')</pre>
  <h4>.modal('show')</h4>
  <p>{{_i}}Manually opens a modal.{{/i}}</p>
  <pre class="prettyprint linenums">$('#myModal').modal('show')</pre>
  <h4>.modal('hide')</h4>
  <p>{{_i}}Manually hides a modal.{{/i}}</p>
  <pre class="prettyprint linenums">$('#myModal').modal('hide')</pre>
  <h3>{{_i}}Events{{/i}}</h3>
  <p>{{_i}}Bootstrap's modal class exposes a few events for hooking into modal functionality.{{/i}}</p>
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <th style="width: 150px;">{{_i}}Event{{/i}}</th>
       <th>{{_i}}Description{{/i}}</th>
     </tr>
    </thead>
    <tbody>
     <tr>
       <td>{{_i}}show{{/i}}</td>
       <td>{{_i}}This event fires immediately when the <code>show</code> instance method is called.{{/i}}</td>
     </tr>
     <tr>
       <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>
     </tr>
     <tr>
       <td>{{_i}}hide{{/i}}</td>
       <td>{{_i}}This event is fired immediately when the <code>hide</code> instance method has been called.{{/i}}</td>
     </tr>
     <tr>
       <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>
     </tr>
    </tbody>
  </table>
297
298
<pre class="prettyprint linenums">
$('#myModal').on('hidden', function () {
299
  // {{_i}}do something…{{/i}}
300
})</pre>
301
</section>
302
303
304



305
306
307
308
309
310
311
312
313
<!-- Dropdown
================================================== -->
<section id="dropdowns">
  <div class="page-header">
    <h1>{{_i}}Dropdowns{{/i}} <small>bootstrap-dropdown.js</small></h1>
  </div>


  <h2>{{_i}}Examples{{/i}}</h2>
314
  <p>{{_i}}Add dropdown menus to nearly anything with this simple plugin, including the navbar, tabs, and pills.{{/i}}</p>
315

316
  <h3>{{_i}}Within a navbar{{/i}}</h3>
317
318
319
320
321
322
  <div class="bs-docs-example">
    <div id="navbar-example" class="navbar navbar-static">
      <div class="navbar-inner">
        <div class="container" style="width: auto;">
          <a class="brand" href="#">{{_i}}Project Name{{/i}}</a>
          <ul class="nav" role="navigation">
Jacob Thornton's avatar
Jacob Thornton committed
323
            <li class="dropdown">
324
325
326
327
              <a id="drop1" href="#" role="button" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown{{/i}} <b class="caret"></b></a>
              <ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
                <li><a tabindex="-1" href="http://google.com">{{_i}}Action{{/i}}</a></li>
                <li><a tabindex="-1" href="#anotherAction">{{_i}}Another action{{/i}}</a></li>
328
                <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
329
                <li class="divider"></li>
330
                <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
331
332
333
              </ul>
            </li>
            <li class="dropdown">
334
335
              <a href="#" id="drop2" role="button" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown 2 {{/i}}<b class="caret"></b></a>
              <ul class="dropdown-menu" role="menu" aria-labelledby="drop2">
336
337
338
                <li><a tabindex="-1" href="#">{{_i}}Action{{/i}}</a></li>
                <li><a tabindex="-1" href="#">{{_i}}Another action{{/i}}</a></li>
                <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
339
                <li class="divider"></li>
340
                <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
341
342
              </ul>
            </li>
343
344
345
346
347
          </ul>
          <ul class="nav pull-right">
            <li id="fat-menu" class="dropdown">
              <a href="#" id="drop3" role="button" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown 3{{/i}} <b class="caret"></b></a>
              <ul class="dropdown-menu" role="menu" aria-labelledby="drop3">
348
349
350
                <li><a tabindex="-1" href="#">{{_i}}Action{{/i}}</a></li>
                <li><a tabindex="-1" href="#">{{_i}}Another action{{/i}}</a></li>
                <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
351
                <li class="divider"></li>
352
                <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
Jacob Thornton's avatar
Jacob Thornton committed
353
354
              </ul>
            </li>
355
356
357
358
359
360
          </ul>
        </div>
      </div>
    </div> <!-- /navbar-example -->
  </div> {{! /example }}

361
  <h3>{{_i}}Within tabs{{/i}}</h3>
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
  <div class="bs-docs-example">
    <ul class="nav nav-pills">
      <li class="active"><a href="#">{{_i}}Regular link{{/i}}</a></li>
      <li class="dropdown">
        <a class="dropdown-toggle" id="drop4" role="button" data-toggle="dropdown" href="#">{{_i}}Dropdown{{/i}} <b class="caret"></b></a>
        <ul id="menu1" class="dropdown-menu" role="menu" aria-labelledby="drop4">
          <li><a tabindex="-1" href="#">{{_i}}Action{{/i}}</a></li>
          <li><a tabindex="-1" href="#">{{_i}}Another action{{/i}}</a></li>
          <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
          <li class="divider"></li>
          <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
        </ul>
      </li>
      <li class="dropdown">
        <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">{{_i}}Dropdown 2{{/i}} <b class="caret"></b></a>
        <ul id="menu2" class="dropdown-menu" role="menu" aria-labelledby="drop5">
          <li><a tabindex="-1" href="#">{{_i}}Action{{/i}}</a></li>
          <li><a tabindex="-1" href="#">{{_i}}Another action{{/i}}</a></li>
          <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
          <li class="divider"></li>
          <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
        </ul>
      </li>
      <li class="dropdown">
        <a class="dropdown-toggle" id="drop5" role="button" data-toggle="dropdown" href="#">{{_i}}Dropdown 3{{/i}} <b class="caret"></b></a>
        <ul id="menu3" class="dropdown-menu" role="menu" aria-labelledby="drop5">
          <li><a tabindex="-1" href="#">{{_i}}Action{{/i}}</a></li>
          <li><a tabindex="-1" href="#">{{_i}}Another action{{/i}}</a></li>
          <li><a tabindex="-1" href="#">{{_i}}Something else here{{/i}}</a></li>
          <li class="divider"></li>
          <li><a tabindex="-1" href="#">{{_i}}Separated link{{/i}}</a></li>
        </ul>
      </li>
    </ul> <!-- /tabs -->
  </div> {{! /example }}
397
398


399
400
  <hr class="bs-docs-separator">

401

402
403
404
405
  <h2>{{_i}}Usage{{/i}}</h2>

  <h3>{{_i}}Via data attributes{{/i}}</h3>
  <p>{{_i}}Add <code>data-toggle="dropdown"</code> to a link or button to toggle a dropdown.{{/i}}</p>
406
<pre class="prettyprint linenums">
407
408
409
410
411
412
413
&lt;div class="dropdown"&gt;
  &lt;a class="dropdown-toggle" href="#"&gt;Dropdown trigger&lt;/a&gt;
  &lt;ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"&gt;
    ...
  &lt;/ul&gt;
&lt;/div&gt;
</pre>
414
  <p>{{_i}}To keep URLs intact, use the <code>data-target</code> attribute instead of <code>href="#"</code>.{{/i}}</p>
415
<pre class="prettyprint linenums">
416
417
418
419
420
421
422
423
424
&lt;div class="dropdown"&gt;
  &lt;a class="dropdown-toggle" id="dLabel" role="button" data-toggle="dropdown" data-target="#" href="/page.html"&gt;
    {{_i}}Dropdown{{/i}}
    &lt;b class="caret"&gt;&lt;/b&gt;
  &lt;/a&gt;
  &lt;ul class="dropdown-menu" role="menu" aria-labelledby="dLabel"&gt;
    ...
  &lt;/ul&gt;
&lt;/div&gt;
425
</pre>
426
427
428
429
430

  <h3>{{_i}}Via javascript{{/i}}</h3>
  <p>{{_i}}Call the dropdowns via javascript:{{/i}}</p>
  <pre class="prettyprint linenums">$('.dropdown-toggle').dropdown()</pre>

431
432
433
  <h3>{{_i}}Options{{/i}}</h3>
  <p><em>{{_i}}None{{/i}}</em></p>

434
435
436
437
  <h3>{{_i}}Methods{{/i}}</h3>
  <h4>$().dropdown()</h4>
  <p>{{_i}}A programatic api for activating menus for a given navbar or tabbed navigation.{{/i}}</p>
</section>
438
439
440



441
442
443
444
445
446
447
448
<!-- ScrollSpy
================================================== -->
<section id="scrollspy">
  <div class="page-header">
    <h1>{{_i}}ScrollSpy{{/i}} <small>bootstrap-scrollspy.js</small></h1>
  </div>


449
450
  <h2>{{_i}}Example in navbar{{/i}}</h2>
  <p>{{_i}}The ScrollSpy plugin is for automatically updating nav targets based on scroll position. Scroll the area below the navbar and watch the active class change. The dropdown sub items will be highlighted as well.{{/i}}</p>
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
  <div class="bs-docs-example">
    <div id="navbarExample" class="navbar navbar-static">
      <div class="navbar-inner">
        <div class="container" style="width: auto;">
          <a class="brand" href="#">{{_i}}Project Name{{/i}}</a>
          <ul class="nav">
            <li><a href="#fat">@fat</a></li>
            <li><a href="#mdo">@mdo</a></li>
            <li class="dropdown">
              <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown{{/i}} <b class="caret"></b></a>
              <ul class="dropdown-menu">
                <li><a href="#one">{{_i}}one{{/i}}</a></li>
                <li><a href="#two">{{_i}}two{{/i}}</a></li>
                <li class="divider"></li>
                <li><a href="#three">{{_i}}three{{/i}}</a></li>
              </ul>
            </li>
          </ul>
Jacob Thornton's avatar
Jacob Thornton committed
469
        </div>
470
471
472
473
      </div>
    </div>
    <div data-spy="scroll" data-target="#navbarExample" data-offset="0" class="scrollspy-example">
      <h4 id="fat">@fat</h4>
474
      <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>
475
      <h4 id="mdo">@mdo</h4>
476
      <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>
477
      <h4 id="one">one</h4>
478
      <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>
479
      <h4 id="two">two</h4>
480
      <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>
481
      <h4 id="three">three</h4>
482
      <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>
483
484
485
486
487
      <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>
  </div>{{! /example }}

488
489
490
491
492
493
494
495
496
497
498

  <hr class="bs-docs-separator">


  <h2>{{_i}}Usage{{/i}}</h2>

  <h3>{{_i}}Via data attributes{{/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) and <code>data-target=".navbar"</code> to select which nav to use.{{/i}}</p>
  <pre class="prettyprint linenums">&lt;body data-spy="scroll" data-target=".navbar"&gt;...&lt;/body&gt;</pre>

  <h3>{{_i}}Via javascript{{/i}}</h3>
499
500
  <p>{{_i}}Call the scrollspy via javascript:{{/i}}</p>
  <pre class="prettyprint linenums">$('#navbar').scrollspy()</pre>
501

502
503
504
505
  <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>
506

507
508
509
  <h3>{{_i}}Methods{{/i}}</h3>
  <h4>.scrollspy('refresh')</h4>
  <p>{{_i}}When using scrollspy in conjunction with adding or removing of elements from the DOM, you'll need to call the refresh method like so:{{/i}}</p>
510
511
512
513
514
<pre class="prettyprint linenums">
$('[data-spy="scroll"]').each(function () {
  var $spy = $(this).scrollspy('refresh')
});
</pre>
515

516
  <h3>{{_i}}Options{{/i}}</h3>
517
  <p>{{_i}}Options can be passed via data attributes or javascript. For data attributes, append the option name to <code>data-</code>, as in <code>data-offset=""</code>.{{/i}}</p>
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <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>
     </tr>
    </thead>
    <tbody>
     <tr>
       <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>
     </tr>
    </tbody>
  </table>
536
537

  <h3>{{_i}}Events{{/i}}</h3>
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <th style="width: 150px;">{{_i}}Event{{/i}}</th>
       <th>{{_i}}Description{{/i}}</th>
     </tr>
    </thead>
    <tbody>
     <tr>
       <td>{{_i}}activate{{/i}}</td>
       <td>{{_i}}This event fires whenever a new item becomes activated by the scrollspy.{{/i}}</td>
    </tr>
    </tbody>
  </table>
</section>

554
555


556
557
558
559
560
561
<!-- Tabs
================================================== -->
<section id="tabs">
  <div class="page-header">
    <h1>{{_i}}Togglable tabs{{/i}} <small>bootstrap-tab.js</small></h1>
  </div>
562

563
564

  <h2>{{_i}}Example tabs{{/i}}</h2>
565
  <p>{{_i}}Add quick, dynamic tab functionality to transiton through panes of local content, even via dropdown menus.{{/i}}</p>
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
  <div class="bs-docs-example">
    <ul id="myTab" class="nav nav-tabs">
      <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>
      <li class="dropdown">
        <a href="#" class="dropdown-toggle" data-toggle="dropdown">{{_i}}Dropdown{{/i}} <b class="caret"></b></a>
        <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>
581
      </div>
582
583
584
585
586
587
588
589
590
591
592
593
      <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>
  </div>{{! /example }}

594
595
596
597
598

  <hr class="bs-docs-separator">


  <h2>{{_i}}Usage{{/i}}</h2>
599
600
  <p>{{_i}}Enable tabbable tabs via javascript (each tab needs to be activated individually):{{/i}}</p>
<pre class="prettyprint linenums">
601
602
603
604
$('#myTab a').click(function (e) {
  e.preventDefault();
  $(this).tab('show');
})</pre>
605
  <p>{{_i}}You can activate individual tabs in several ways:{{/i}}</p>
606
<pre class="prettyprint linenums">
Mark Otto's avatar
Mark Otto committed
607
608
609
610
$('#myTab a[href="#profile"]').tab('show'); // Select tab by name
$('#myTab a:first').tab('show'); // Select first tab
$('#myTab a:last').tab('show'); // Select last tab
$('#myTab li:eq(2) a').tab('show'); // Select third tab (0-indexed)
611
</pre>
612

613
614
  <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. Adding the <code>nav</code> and <code>nav-tabs</code> classes to the tab <code>ul</code> will apply the bootstrap tab styling.{{/i}}</p>
615
<pre class="prettyprint linenums">
616
&lt;ul class="nav nav-tabs"&gt;
617
618
619
  &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
620
  &lt;li&gt;&lt;a href="#settings" data-toggle="tab"&gt;{{_i}}Settings{{/i}}&lt;/a&gt;&lt;/li&gt;
621
&lt;/ul&gt;</pre>
622

623
624
625
626
627
  <h3>{{_i}}Methods{{/i}}</h3>
  <h4>$().tab</h4>
  <p>
    {{_i}}Activates a tab element and content container. Tab should have either a <code>data-target</code> or an <code>href</code> targeting a container node in the DOM.{{/i}}
  </p>
628
<pre class="prettyprint linenums">
629
&lt;ul class="nav nav-tabs" id="myTab"&gt;
630
631
632
633
  &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;
634
635
636
&lt;/ul&gt;

&lt;div class="tab-content"&gt;
Mark Otto's avatar
Mark Otto committed
637
638
639
640
  &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;
641
642
643
&lt;/div&gt;

&lt;script&gt;
Jacob Thornton's avatar
Jacob Thornton committed
644
  $(function () {
Mark Otto's avatar
Mark Otto committed
645
    $('#myTab a:last').tab('show');
Jacob Thornton's avatar
Jacob Thornton committed
646
  })
647
&lt;/script&gt;</pre>
648

649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
  <h3>{{_i}}Events{{/i}}</h3>
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <th style="width: 150px;">{{_i}}Event{{/i}}</th>
       <th>{{_i}}Description{{/i}}</th>
     </tr>
    </thead>
    <tbody>
     <tr>
       <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>
    </tr>
    <tr>
       <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>
     </tr>
    </tbody>
  </table>
<pre class="prettyprint linenums">
669
$('a[data-toggle="tab"]').on('shown', function (e) {
Jacob Thornton's avatar
Jacob Thornton committed
670
671
  e.target // activated tab
  e.relatedTarget // previous tab
672
})</pre>
673
</section>
674
675


676
677
678
679
680
681
682
683
<!-- Tooltips
================================================== -->
<section id="tooltips">
  <div class="page-header">
    <h1>{{_i}}Tooltips{{/i}} <small>bootstrap-tooltip.js</small></h1>
  </div>


684
685
  <h2>{{_i}}Examples{{/i}}</h2>
  <p>{{_i}}Inspired by the excellent jQuery.tipsy plugin written by Jason Frame; Tooltips are an updated version, which don't rely on images, use CSS3 for animations, and data-attributes for local title storage.{{/i}}</p>
686
687
  <p>{{_i}}Hover over the links below to see tooltips:{{/i}}</p>
  <div class="bs-docs-example tooltip-demo">
688
    <p class="muted" style="margin-bottom: 0;">{{_i}}Tight pants next level keffiyeh <a href="#" rel="tooltip" title="Default 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 really ironic artisan <a href="#" rel="tooltip" title="Another one here too">whatever keytar</a>, 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}}
689
690
691
    </p>
  </div>{{! /example }}

692
693
694
695
696
697
698
699
700
701
  <h3>{{_i}}Four directions{{/i}}</h3>
  <div class="bs-docs-example tooltip-demo">
    <ul class="bs-docs-tooltip-examples">
      <li><a href="#" rel="tooltip" data-placement="top" title="Tooltip on top">Tooltip on top</a></li>
      <li><a href="#" rel="tooltip" data-placement="right" title="Tooltip on right">Tooltip on right</a></li>
      <li><a href="#" rel="tooltip" data-placement="bottom" title="Tooltip on bottom">Tooltip on bottom</a></li>
      <li><a href="#" rel="tooltip" data-placement="left" title="Tooltip on left">Tooltip on left</a></li>
    </ul>
  </div>{{! /example }}

702
703
704
705
706

  <hr class="bs-docs-separator">


  <h2>{{_i}}Usage{{/i}}</h2>
707
708
  <p>{{_i}}Trigger the tooltip via javascript:{{/i}}</p>
  <pre class="prettyprint linenums">$('#example').tooltip({{_i}}options{{/i}})</pre>
709

710
  <h3>{{_i}}Options{{/i}}</h3>
711
  <p>{{_i}}Options can be passed via data attributes or javascript. For data attributes, append the option name to <code>data-</code>, as in <code>data-animation=""</code>.{{/i}}</p>
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <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>
     </tr>
    </thead>
    <tbody>
     <tr>
       <td>{{_i}}animation{{/i}}</td>
       <td>{{_i}}boolean{{/i}}</td>
       <td>true</td>
       <td>{{_i}}apply a css fade transition to the tooltip{{/i}}</td>
     </tr>
     <tr>
       <td>{{_i}}html{{/i}}</td>
       <td>{{_i}}boolean{{/i}}</td>
       <td>true</td>
       <td>{{_i}}Insert html into the tooltip. If false, jquery's <code>text</code> method will be used to insert content into the dom. Use text if you're worried about XSS attacks.{{/i}}</td>
     </tr>
     <tr>
       <td>{{_i}}placement{{/i}}</td>
       <td>{{_i}}string|function{{/i}}</td>
       <td>'top'</td>
       <td>{{_i}}how to position the tooltip{{/i}} - top | bottom | left | right</td>
     </tr>
     <tr>
       <td>{{_i}}selector{{/i}}</td>
       <td>{{_i}}string{{/i}}</td>
       <td>false</td>
       <td>{{_i}}If a selector is provided, tooltip objects will be delegated to the specified targets.{{/i}}</td>
     </tr>
     <tr>
       <td>{{_i}}title{{/i}}</td>
       <td>{{_i}}string | function{{/i}}</td>
       <td>''</td>
       <td>{{_i}}default title value if `title` tag isn't present{{/i}}</td>
     </tr>
     <tr>
       <td>{{_i}}trigger{{/i}}</td>
       <td>{{_i}}string{{/i}}</td>
       <td>'hover'</td>
       <td>{{_i}}how tooltip is triggered{{/i}} - hover | focus | manual</td>
     </tr>
     <tr>
       <td>{{_i}}delay{{/i}}</td>
       <td>{{_i}}number | object{{/i}}</td>
       <td>0</td>
       <td>
        <p>{{_i}}delay showing and hiding the tooltip (ms) - does not apply to manual trigger type{{/i}}</p>
        <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>
       </td>
     </tr>
    </tbody>
  </table>
  <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>
774

775
776
  <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>
777
<pre class="prettyprint linenums">
778
&lt;a href="#" rel="tooltip" title="{{_i}}first tooltip{{/i}}"&gt;{{_i}}hover over me{{/i}}&lt;/a&gt;
779
</pre>
780
781
782
783
784
785
786
787
788
789
790
791
792

  <h3>{{_i}}Methods{{/i}}</h3>
  <h4>$().tooltip({{_i}}options{{/i}})</h4>
  <p>{{_i}}Attaches a tooltip handler to an element collection.{{/i}}</p>
  <h4>.tooltip('show')</h4>
  <p>{{_i}}Reveals an element's tooltip.{{/i}}</p>
  <pre class="prettyprint linenums">$('#element').tooltip('show')</pre>
  <h4>.tooltip('hide')</h4>
  <p>{{_i}}Hides an element's tooltip.{{/i}}</p>
  <pre class="prettyprint linenums">$('#element').tooltip('hide')</pre>
  <h4>.tooltip('toggle')</h4>
  <p>{{_i}}Toggles an element's tooltip.{{/i}}</p>
  <pre class="prettyprint linenums">$('#element').tooltip('toggle')</pre>
793
794
795
  <h4>.tooltip('destroy')</h4>
  <p>{{_i}}Destroys an element's tooltip.{{/i}}</p>
  <pre class="prettyprint linenums">$('#element').tooltip('destroy')</pre>
796
</section>
797
798
799



800
801
802
803
804
805
<!-- Popovers
================================================== -->
<section id="popovers">
  <div class="page-header">
    <h1>{{_i}}Popovers{{/i}} <small>bootstrap-popover.js</small></h1>
  </div>
806

807
  <h2>{{_i}}Examples{{/i}}</h2>
808
  <p>{{_i}}Add small overlays of content, like those on the iPad, to any element for housing secondary information. Hover over the button to trigger the popover. <strong>Requires <a href="#tooltips">Tooltip</a> to be included.</strong>{{/i}}</p>
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849

  <h3>{{_i}}Static popover{{/i}}</h3>
  <p>{{_i}}Four options are available: top, right, bottom, and left aligned.{{/i}}</p>
  <div class="bs-docs-example bs-docs-example-popover">
    <div class="popover top">
      <div class="arrow"></div>
      <h3 class="popover-title">Popover top</h3>
      <div class="popover-content">
        <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
      </div>
    </div>

    <div class="popover right">
      <div class="arrow"></div>
      <h3 class="popover-title">Popover right</h3>
      <div class="popover-content">
        <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
      </div>
    </div>

    <div class="popover bottom">
      <div class="arrow"></div>
      <h3 class="popover-title">Popover bottom</h3>
      <div class="popover-content">
        <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
      </div>
    </div>

    <div class="popover left">
      <div class="arrow"></div>
      <h3 class="popover-title">Popover left</h3>
      <div class="popover-content">
        <p>Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.</p>
      </div>
    </div>

    <div class="clearfix"></div>
  </div>
  <p>{{_i}}No markup shown as popovers are generated from javascript and content within a <code>data</code> attribute.{{/i}}</p>

  <h3>Live demo</h3>
850
  <div class="bs-docs-example" style="padding-bottom: 24px;">
851
    <a href="#" class="btn btn-large 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>
852
  </div>
853

854
855
856
857
858

  <hr class="bs-docs-separator">


  <h2>{{_i}}Usage{{/i}}</h2>
859
860
  <p>{{_i}}Enable popovers via javascript:{{/i}}</p>
  <pre class="prettyprint linenums">$('#example').popover({{_i}}options{{/i}})</pre>
861

862
  <h3>{{_i}}Options{{/i}}</h3>
863
  <p>{{_i}}Options can be passed via data attributes or javascript. For data attributes, append the option name to <code>data-</code>, as in <code>data-animation=""</code>.{{/i}}</p>
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
  <table class="table table-bordered table-striped">
    <thead>
     <tr>
       <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>
     </tr>
    </thead>
    <tbody>
     <tr>
       <td>{{_i}}animation{{/i}}</td>
       <td>{{_i}}boolean{{/i}}</td>
       <td>true</td>
       <td>{{_i}}apply a css fade transition to the tooltip{{/i}}</td>
     </tr>
     <tr>
       <td>{{_i}}html{{/i}}</td>
       <td>{{_i}}boolean{{/i}}</td>
       <td>true</td>
       <td>{{_i}}Insert html into the popover. If false, jquery's <code>text</code> method will be used to insert content into the dom. Use text if you're worried about XSS attacks.{{/i}}</td>
     </tr>
     <tr>
       <td>{{_i}}placement{{/i}}</td>
       <td>{{_i}}string|function{{/i}}</td>
       <td>'right'</td>
       <td>{{_i}}how to position the popover{{/i}} - top | bottom | left | right</td>
     </tr>
     <tr>
       <td>{{_i}}selector{{/i}}</td>
       <td>{{_i}}string{{/i}}</td>
       <td>false</td>
       <td>{{_i}}if a selector is provided, tooltip objects will be delegated to the specified targets{{/i}}</td>
     </tr>
     <tr>
       <td>{{_i}}trigger{{/i}}</td>
       <td>{{_i}}string{{/i}}</td>
       <td>'hover'</td>
902
       <td>{{_i}}how popover is triggered{{/i}} - hover | focus | manual</td>
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
     </tr>
     <tr>
       <td>{{_i}}title{{/i}}</td>
       <td>{{_i}}string | function{{/i}}</td>
       <td>''</td>
       <td>{{_i}}default title value if `title` attribute isn't present{{/i}}</td>
     </tr>
     <tr>
       <td>{{_i}}content{{/i}}</td>
       <td>{{_i}}string | function{{/i}}</td>
       <td>''</td>
       <td>{{_i}}default content value if `data-content` attribute isn't present{{/i}}</td>
     </tr>
     <tr>
       <td>{{_i}}delay{{/i}}</td>
       <td>{{_i}}number | object{{/i}}</td>
       <td>0</td>
       <td>
        <p>{{_i}}delay showing and hiding the popover (ms) - does not apply to manual trigger type{{/i}}</p>
        <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>
       </td>
     </tr>
    </tbody>
  </table>
  <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>
932

933
  <h3>{{_i}}Markup{{/i}}</h3>
934
  <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>
935

936
937
938
939
940
941
942
943
944
945
946
947
  <h3>{{_i}}Methods{{/i}}</h3>
  <h4>$().popover({{_i}}options{{/i}})</h4>
  <p>{{_i}}Initializes popovers for an element collection.{{/i}}</p>
  <h4>.popover('show')</h4>
  <p>{{_i}}Reveals an elements popover.{{/i}}</p>
  <pre class="prettyprint linenums">$('#element').popover('show')</pre>
  <h4>.popover('hide')</h4>
  <p>{{_i}}Hides an elements popover.{{/i}}</p>
  <pre class="prettyprint linenums">$('#element').popover('hide')</pre>
  <h4>.popover('toggle')</h4>
  <p>{{_i}}Toggles an elements popover.{{/i}}</p>
  <pre class="prettyprint linenums">$('#element').popover('toggle')</pre>
Jon Stevens's avatar
Jon Stevens committed
948
  <h4>.popover('destroy')</h4>
949
950
  <p>{{_i}}Destroys an element's popover.{{/i}}</p>
  <pre class="prettyprint linenums">$('#element').popover('destroy')</pre>
951
952
953
954
955
956
957
958
959
960
961
962
963
</section>



<!-- Alert
================================================== -->
<section id="alerts">
  <div class="page-header">
    <h1>{{_i}}Alert messages{{/i}} <small>bootstrap-alert.js</small></h1>
  </div>


  <h2>{{_i}}Example alerts{{/i}}</h2>
964
  <p>{{_i}}Add dismiss functionality to all alerge messages with this plugin.{{/i}}</p>
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
  <div class="bs-docs-example">
    <div class="alert fade in">
      <button type="button" class="close" data-dismiss="alert">&times;</button>
      <strong>{{_i}}Holy guacamole!{{/i}}</strong> {{_i}}Best check yo self, you're not looking too good.{{/i}}
    </div>
  </div>{{! /example }}

  <div class="bs-docs-example">
    <div class="alert alert-block alert-error fade in">
      <button type="button" class="close" data-dismiss="alert">&times;</button>
      <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>
      <p>
        <a class="btn btn-danger" href="#">{{_i}}Take this action{{/i}}</a> <a class="btn" href="#">{{_i}}Or do this{{/i}}</a>
      </p>
    </div>
  </div>{{! /example }}

983
984
985
986
987

  <hr class="bs-docs-separator">


  <h2>{{_i}}Usage{{/i}}</h2>
988
989
  <p>{{_i}}Enable dismissal of an alert via javascript:{{/i}}</p>
  <pre class="prettyprint linenums">$(".alert").alert()</pre>
990

991
992
993
  <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>
  <pre class="prettyprint linenums">&lt;a class="close" data-dismiss="alert" href="#"&gt;&amp;times;&lt;/a&gt;</pre>
994

995
996
997
998
999
1000
  <h3>{{_i}}Methods{{/i}}</h3>
  <h4>$().alert()</h4>
  <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>
  <h4>.alert('close')</h4>
  <p>{{_i}}Closes an alert.{{/i}}</p>
  <pre class="prettyprint linenums">$(".alert").alert('close')</pre>
For faster browsing, not all history is shown. View entire blame