javascript.html 72.8 KB
Newer Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
      <pre class="prettyprint linenums">$('#element').popover('destroy')</pre>
    </section>



    <!-- Alert
    ================================================== -->
    <section id="alerts">
      <div class="page-header">
        <h1>Alert messages <small>bootstrap-alert.js</small></h1>
      </div>
1012
1013


1014
1015
1016
1017
1018
1019
1020
1021
      <h2>Example alerts</h2>
      <p>Add dismiss functionality to all alerge messages with this plugin.</p>
      <div class="bs-docs-example">
        <div class="alert fade in">
          <button type="button" class="close" data-dismiss="alert">&times;</button>
          <strong>Holy guacamole!</strong> Best check yo self, you're not looking too good.
        </div>
      </div>
1022

1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
      <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">Oh snap! You got an error!</h4>
          <p>Change this and that and try again. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum.</p>
          <p>
            <a class="btn btn-danger" href="#">Take this action</a> <a class="btn" href="#">Or do this</a>
          </p>
        </div>
      </div>
1033

1034

1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
      <hr class="bs-docs-separator">


      <h2>Usage</h2>
      <p>Enable dismissal of an alert via javascript:</p>
      <pre class="prettyprint linenums">$(".alert").alert()</pre>

      <h3>Markup</h3>
      <p>Just add <code>data-dismiss="alert"</code> to your close button to automatically give an alert close functionality.</p>
      <pre class="prettyprint linenums">&lt;a class="close" data-dismiss="alert" href="#"&gt;&amp;times;&lt;/a&gt;</pre>

      <h3>Methods</h3>
      <h4>$().alert()</h4>
      <p>Wraps all alerts with close functionality. To have your alerts animate out when closed, make sure they have the <code>.fade</code> and <code>.in</code> class already applied to them.</p>
      <h4>.alert('close')</h4>
      <p>Closes an alert.</p>
      <pre class="prettyprint linenums">$(".alert").alert('close')</pre>


      <h3>Events</h3>
      <p>Bootstrap's alert class exposes a few events for hooking into alert functionality.</p>
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 150px;">Event</th>
           <th>Description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
           <td>close</td>
           <td>This event fires immediately when the <code>close</code> instance method is called.</td>
         </tr>
         <tr>
           <td>closed</td>
           <td>This event is fired when the alert has been closed (will wait for css transitions to complete).</td>
         </tr>
        </tbody>
      </table>
1074
1075
<pre class="prettyprint linenums">
$('#my-alert').bind('closed', function () {
1076
  // do something…
1077
})</pre>
1078
    </section>
Jacob Thornton's avatar
Jacob Thornton committed
1079
1080
1081



1082
1083
1084
1085
1086
1087
    <!-- Buttons
    ================================================== -->
    <section id="buttons">
      <div class="page-header">
        <h1>Buttons <small>bootstrap-button.js</small></h1>
      </div>
1088

1089
1090
      <h2>Example uses</h2>
      <p>Do more with buttons. Control button states or create groups of buttons for more components like toolbars.</p>
1091

1092
1093
1094
1095
1096
1097
1098
      <h4>Stateful</h4>
      <p>Add data-loading-text="Loading..." to use a loading state on a button.</p>
      <div class="bs-docs-example" style="padding-bottom: 24px;">
        <button type="button" id="fat-btn" data-loading-text="loading..." class="btn btn-primary">
          Loading state
        </button>
      </div>
1099
<pre class="prettyprint linenums">
1100
&lt;button type="button" class="btn btn-primary" data-loading-text="Loading..."&gt;Loading state&lt;/button&gt;
1101
</pre>
1102

1103
1104
1105
1106
1107
      <h4>Single toggle</h4>
      <p>Add data-toggle="button" to activate toggling on a single button.</p>
      <div class="bs-docs-example" style="padding-bottom: 24px;">
        <button type="button" class="btn btn-primary" data-toggle="button">Single Toggle</button>
      </div>
1108
<pre class="prettyprint linenums">
1109
&lt;button type="button" class="btn" data-toggle="button"&gt;Single Toggle&lt;/button&gt;
1110
</pre>
1111

1112
1113
1114
1115
1116
1117
1118
1119
1120
      <h4>Checkbox</h4>
      <p>Add data-toggle="buttons-checkbox" for checkbox style toggling on btn-group.</p>
      <div class="bs-docs-example" style="padding-bottom: 24px;">
        <div class="btn-group" data-toggle="buttons-checkbox">
          <button type="button" class="btn btn-primary">Left</button>
          <button type="button" class="btn btn-primary">Middle</button>
          <button type="button" class="btn btn-primary">Right</button>
        </div>
      </div>
1121
1122
<pre class="prettyprint linenums">
&lt;div class="btn-group" data-toggle="buttons-checkbox"&gt;
1123
1124
1125
  &lt;button type="button" class="btn"&gt;Left&lt;/button&gt;
  &lt;button type="button" class="btn"&gt;Middle&lt;/button&gt;
  &lt;button type="button" class="btn"&gt;Right&lt;/button&gt;
1126
1127
&lt;/div&gt;
</pre>
1128

1129
1130
1131
1132
1133
1134
1135
1136
1137
      <h4>Radio</h4>
      <p>Add data-toggle="buttons-radio" for radio style toggling on btn-group.</p>
      <div class="bs-docs-example" style="padding-bottom: 24px;">
        <div class="btn-group" data-toggle="buttons-radio">
          <button type="button" class="btn btn-primary">Left</button>
          <button type="button" class="btn btn-primary">Middle</button>
          <button type="button" class="btn btn-primary">Right</button>
        </div>
      </div>
1138
1139
<pre class="prettyprint linenums">
&lt;div class="btn-group" data-toggle="buttons-radio"&gt;
1140
1141
1142
  &lt;button type="button" class="btn"&gt;Left&lt;/button&gt;
  &lt;button type="button" class="btn"&gt;Middle&lt;/button&gt;
  &lt;button type="button" class="btn"&gt;Right&lt;/button&gt;
1143
1144
&lt;/div&gt;
</pre>
1145

1146

1147
      <hr class="bs-docs-separator">
1148
1149


1150
1151
1152
      <h2>Usage</h2>
      <p>Enable buttons via javascript:</p>
      <pre class="prettyprint linenums">$('.nav-tabs').button()</pre>
1153

1154
1155
      <h3>Markup</h3>
      <p>Data attributes are integral to the button plugin. Check out the example code below for the various markup types.</p>
1156

1157
1158
      <h3>Options</h3>
      <p><em>None</em></p>
1159

1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
      <h3>Methods</h3>
      <h4>$().button('toggle')</h4>
      <p>Toggles push state. Gives the button the appearance that it has been activated.</p>
      <div class="alert alert-info">
        <strong>Heads up!</strong>
        You can enable auto toggling of a button by using the <code>data-toggle</code> attribute.
      </div>
      <pre class="prettyprint linenums">&lt;button type="button" class="btn" data-toggle="button" &gt;&lt;/button&gt;</pre>
      <h4>$().button('loading')</h4>
      <p>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>.
      </p>
      <pre class="prettyprint linenums">&lt;button type="button" class="btn" data-loading-text="loading stuff..." &gt;...&lt;/button&gt;</pre>
      <div class="alert alert-info">
        <strong>Heads up!</strong>
        <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>.
      </div>
      <h4>$().button('reset')</h4>
      <p>Resets button state - swaps text to original text.</p>
      <h4>$().button(string)</h4>
      <p>Resets button state - swaps text to any data defined text state.</p>
1180
<pre class="prettyprint linenums">&lt;button type="button" class="btn" data-complete-text="finished!" &gt;...&lt;/button&gt;
1181
&lt;script&gt;
Jacob Thornton's avatar
Jacob Thornton committed
1182
  $('.btn').button('complete')
1183
&lt;/script&gt;</pre>
1184
    </section>
Jacob Thornton's avatar
Jacob Thornton committed
1185
1186
1187



1188
1189
1190
1191
1192
1193
    <!-- Collapse
    ================================================== -->
    <section id="collapse">
      <div class="page-header">
        <h1>Collapse <small>bootstrap-collapse.js</small></h1>
      </div>
1194

1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
      <h3>About</h3>
      <p>Get base styles and flexible support for collapsible components like accordions and navigation.</p>
      <p class="muted"><strong>*</strong> Requires the Transitions plugin to be included.</p>

      <h2>Example accordion</h2>
      <p>Using the collapse plugin, we built a simple accordion style widget:</p>

      <div class="bs-docs-example">
        <div class="accordion" id="accordion2">
          <div class="accordion-group">
            <div class="accordion-heading">
              <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseOne">
                Collapsible Group Item #1
              </a>
            </div>
            <div id="collapseOne" class="accordion-body collapse in">
              <div class="accordion-inner">
                Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
              </div>
            </div>
1215
          </div>
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
          <div class="accordion-group">
            <div class="accordion-heading">
              <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseTwo">
                Collapsible Group Item #2
              </a>
            </div>
            <div id="collapseTwo" class="accordion-body collapse">
              <div class="accordion-inner">
                Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
              </div>
            </div>
1227
          </div>
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
          <div class="accordion-group">
            <div class="accordion-heading">
              <a class="accordion-toggle" data-toggle="collapse" data-parent="#accordion2" href="#collapseThree">
                Collapsible Group Item #3
              </a>
            </div>
            <div id="collapseThree" class="accordion-body collapse">
              <div class="accordion-inner">
                Anim pariatur cliche reprehenderit, enim eiusmod high life accusamus terry richardson ad squid. 3 wolf moon officia aute, non cupidatat skateboard dolor brunch. Food truck quinoa nesciunt laborum eiusmod. Brunch 3 wolf moon tempor, sunt aliqua put a bird on it squid single-origin coffee nulla assumenda shoreditch et. Nihil anim keffiyeh helvetica, craft beer labore wes anderson cred nesciunt sapiente ea proident. Ad vegan excepteur butcher vice lomo. Leggings occaecat craft beer farm-to-table, raw denim aesthetic synth nesciunt you probably haven't heard of them accusamus labore sustainable VHS.
              </div>
            </div>
1239
1240
1241
          </div>
        </div>
      </div>
1242
<pre class="prettyprint linenums">
1243
&lt;button type="button" class="btn btn-danger" data-toggle="collapse" data-target="#demo"&gt;
1244
1245
1246
1247
1248
  simple collapsible
&lt;/button&gt;

&lt;div id="demo" class="collapse in"&gt;&lt;/div&gt;
</pre>
1249

1250

1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
      <hr class="bs-docs-separator">


      <h2>Usage</h2>

      <h3>Via data attributes</h3>
      <p>Just add <code>data-toggle="collapse"</code> and a <code>data-target</code> to element to automatically assign control of a collapsible element. The <code>data-target</code> attribute accepts a css selector to apply the collapse to. Be sure to add the class <code>collapse</code> to the collapsible element. If you'd like it to default open, add the additional class <code>in</code>.</p>
      <p>To add accordion-like group management to a collapsible control, add the data attribute <code>data-parent="#selector"</code>. Refer to the demo to see this in action.</p>

      <h3>Via javascript</h3>
      <p>Enable manually with:</p>
      <pre class="prettyprint linenums">$(".collapse").collapse()</pre>

      <h3>Options</h3>
      <p>Options can be passed via data attributes or javascript. For data attributes, append the option name to <code>data-</code>, as in <code>data-parent=""</code>.</p>
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 100px;">Name</th>
           <th style="width: 50px;">type</th>
           <th style="width: 50px;">default</th>
           <th>description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
           <td>parent</td>
           <td>selector</td>
           <td>false</td>
           <td>If selector then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (similar to traditional accordion behavior)</td>
         </tr>
         <tr>
           <td>toggle</td>
           <td>boolean</td>
           <td>true</td>
           <td>Toggles the collapsible element on invocation</td>
         </tr>
        </tbody>
      </table>


      <h3>Methods</h3>
      <h4>.collapse(options)</h4>
      <p>Activates your content as a collapsible element. Accepts an optional options <code>object</code>.
1295
1296
<pre class="prettyprint linenums">
$('#myCollapsible').collapse({
Jacob Thornton's avatar
Jacob Thornton committed
1297
  toggle: false
1298
})</pre>
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
      <h4>.collapse('toggle')</h4>
      <p>Toggles a collapsible element to shown or hidden.</p>
      <h4>.collapse('show')</h4>
      <p>Shows a collapsible element.</p>
      <h4>.collapse('hide')</h4>
      <p>Hides a collapsible element.</p>

      <h3>Events</h3>
      <p>Bootstrap's collapse class exposes a few events for hooking into collapse functionality.</p>
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 150px;">Event</th>
           <th>Description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
           <td>show</td>
           <td>This event fires immediately when the <code>show</code> instance method is called.</td>
         </tr>
         <tr>
           <td>shown</td>
           <td>This event is fired when a collapse element has been made visible to the user (will wait for css transitions to complete).</td>
         </tr>
         <tr>
           <td>hide</td>
           <td>
            This event is fired immediately when the <code>hide</code> method has been called.
           </td>
         </tr>
         <tr>
           <td>hidden</td>
           <td>This event is fired when a collapse element has been hidden from the user (will wait for css transitions to complete).</td>
         </tr>
        </tbody>
      </table>
1336
<pre class="prettyprint linenums">
1337
$('#myCollapsible').on('hidden', function () {
1338
  // do something…
1339
})</pre>
1340
    </section>
Jacob Thornton's avatar
Jacob Thornton committed
1341
1342
1343



1344
1345
1346
1347
1348
1349
     <!-- Carousel
    ================================================== -->
    <section id="carousel">
      <div class="page-header">
        <h1>Carousel <small>bootstrap-carousel.js</small></h1>
      </div>
1350

1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
      <h2>Example carousel</h2>
      <p>The slideshow below shows a generic plugin and component for cycling through elements like a carousel.</p>
      <div class="bs-docs-example">
        <div id="myCarousel" class="carousel slide">
          <div class="carousel-inner">
            <div class="item active">
              <img src="assets/img/bootstrap-mdo-sfmoma-01.jpg" alt="">
              <div class="carousel-caption">
                <h4>First Thumbnail label</h4>
                <p>Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p>
              </div>
            </div>
            <div class="item">
              <img src="assets/img/bootstrap-mdo-sfmoma-02.jpg" alt="">
              <div class="carousel-caption">
                <h4>Second Thumbnail label</h4>
                <p>Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p>
              </div>
            </div>
            <div class="item">
              <img src="assets/img/bootstrap-mdo-sfmoma-03.jpg" alt="">
              <div class="carousel-caption">
                <h4>Third Thumbnail label</h4>
                <p>Cras justo odio, dapibus ac facilisis in, egestas eget quam. Donec id elit non mi porta gravida at eget metus. Nullam id dolor id nibh ultricies vehicula ut id elit.</p>
              </div>
            </div>
1377
          </div>
1378
1379
          <a class="left carousel-control" href="#myCarousel" data-slide="prev">&lsaquo;</a>
          <a class="right carousel-control" href="#myCarousel" data-slide="next">&rsaquo;</a>
1380
1381
        </div>
      </div>
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
<pre class="prettyprint linenums">
&lt;div id="myCarousel" class="carousel slide"&gt;
  &lt;!-- Carousel items --&gt;
  &lt;div class="carousel-inner"&gt;
    &lt;div class="active item"&gt;&lt;/div&gt;
    &lt;div class="item"&gt;&lt;/div&gt;
    &lt;div class="item"&gt;&lt;/div&gt;
  &lt;/div&gt;
  &lt;!-- Carousel nav --&gt;
  &lt;a class="carousel-control left" href="#myCarousel" data-slide="prev"&gt;&amp;lsaquo;&lt;/a&gt;
  &lt;a class="carousel-control right" href="#myCarousel" data-slide="next"&gt;&amp;rsaquo;&lt;/a&gt;
&lt;/div&gt;
</pre>
1395

1396
1397
1398
1399
      <div class="alert alert-warning">
        <strong>Heads up!</strong>
        When implementing this carousel, remove the images we have provided and replace them with your own.
      </div>
1400
1401


1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
      <hr class="bs-docs-separator">


      <h2>Usage</h2>

      <h3>Via data attributes</h3>
      <p>...</p>

      <h3>Via javascript</h3>
      <p>Call carousel manually with:</p>
      <pre class="prettyprint linenums">$('.carousel').carousel()</pre>

      <h3>Options</h3>
      <p>Options can be passed via data attributes or javascript. For data attributes, append the option name to <code>data-</code>, as in <code>data-interval=""</code>.</p>
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 100px;">Name</th>
           <th style="width: 50px;">type</th>
           <th style="width: 50px;">default</th>
           <th>description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
           <td>interval</td>
           <td>number</td>
           <td>5000</td>
           <td>The amount of time to delay between automatically cycling an item. If false, carousel will not automatically cycle.</td>
         </tr>
         <tr>
           <td>pause</td>
           <td>string</td>
           <td>"hover"</td>
           <td>Pauses the cycling of the carousel on mouseenter and resumes the cycling of the carousel on mouseleave.</td>
         </tr>
        </tbody>
      </table>

      <h3>Methods</h3>
      <h4>.carousel(options)</h4>
      <p>Initializes the carousel with an optional options <code>object</code> and starts cycling through items.</p>
1444
<pre class="prettyprint linenums">
Mark Otto's avatar
Mark Otto committed
1445
$('.carousel').carousel({
Jacob Thornton's avatar
Jacob Thornton committed
1446
  interval: 2000
1447
1448
})
</pre>
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
      <h4>.carousel('cycle')</h4>
      <p>Cycles through the carousel items from left to right.</p>
      <h4>.carousel('pause')</h4>
      <p>Stops the carousel from cycling through items.</p>
      <h4>.carousel(number)</h4>
      <p>Cycles the carousel to a particular frame (0 based, similar to an array).</p>
      <h4>.carousel('prev')</h4>
      <p>Cycles to the previous item.</p>
      <h4>.carousel('next')</h4>
      <p>Cycles to the next item.</p>

      <h3>Events</h3>
      <p>Bootstrap's carousel class exposes two events for hooking into carousel functionality.</p>
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 150px;">Event</th>
           <th>Description</th>
         </tr>
        </thead>
        <tbody>
         <tr>
           <td>slide</td>
           <td>This event fires immediately when the <code>slide</code> instance method is invoked.</td>
         </tr>
         <tr>
           <td>slid</td>
           <td>This event is fired when the carousel has completed its slide transition.</td>
         </tr>
        </tbody>
      </table>
    </section>



    <!-- Typeahead
    ================================================== -->
    <section id="typeahead">
      <div class="page-header">
        <h1>Typeahead <small>bootstrap-typeahead.js</small></h1>
      </div>
1490
1491


1492
1493
1494
1495
1496
      <h2>Example</h2>
      <p>A basic, easily extended plugin for quickly creating elegant typeaheads with any form text input.</p>
      <div class="bs-docs-example" style="background-color: #f5f5f5;">
        <input type="text" class="span3" style="margin: 0 auto;" data-provide="typeahead" data-items="4" data-source='["Alabama","Alaska","Arizona","Arkansas","California","Colorado","Connecticut","Delaware","Florida","Georgia","Hawaii","Idaho","Illinois","Indiana","Iowa","Kansas","Kentucky","Louisiana","Maine","Maryland","Massachusetts","Michigan","Minnesota","Mississippi","Missouri","Montana","Nebraska","Nevada","New Hampshire","New Jersey","New Mexico","New York","North Dakota","North Carolina","Ohio","Oklahoma","Oregon","Pennsylvania","Rhode Island","South Carolina","South Dakota","Tennessee","Texas","Utah","Vermont","Virginia","Washington","West Virginia","Wisconsin","Wyoming"]'>
      </div>
1497
1498
1499
<pre class="prettyprint linenums">
&lt;input type="text" data-provide="typeahead"&gt;
</pre>
1500

1501

1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
      <hr class="bs-docs-separator">


      <h2>Usage</h2>

      <h3>Via data attributes</h3>
      <p>Add data attributes to register an element with typeahead functionality as shown in the example above.</p>

      <h3>Via javascript</h3>
      <p>Call the typeahead manually with:</p>
      <pre class="prettyprint linenums">$('.typeahead').typeahead()</pre>

      <h3>Options</h3>
      <p>Options can be passed via data attributes or javascript. For data attributes, append the option name to <code>data-</code>, as in <code>data-source=""</code>.</p>
      <table class="table table-bordered table-striped">
        <thead>
         <tr>
           <th style="width: 100px;">Name</th>
           <th style="width: 50px;">type</th>
           <th style="width: 100px;">default</th>
           <th>description</th>
         </tr>
        </thead>
        <tbody>
          <tr>
           <td>source</td>
           <td>array, function</td>
           <td>[ ]</td>
           <td>The data source to query against. May be an array of strings or a function. The function is passed two arguments, the <code>query</code> value in the input field and the <code>process</code> callback. The function may be used synchronously by returning the data source directly or asynchronously via the <code>process</code> callback's single argument.</td>
         </tr>
         <tr>
           <td>items</td>
           <td>number</td>
           <td>8</td>
           <td>The max number of items to display in the dropdown.</td>
         </tr>
         <tr>
           <td>matcher</td>
           <td>function</td>
           <td>case insensitive</td>
           <td>The method used to determine if a query matches an item. Accepts a single argument, the <code>item</code> against which to test the query. Access the current query with <code>this.query</code>. Return a boolean <code>true</code> if query is a match.</td>
         </tr>
         <tr>
           <td>sorter</td>
           <td>function</td>
           <td>exact match,<br> case sensitive,<br> case insensitive</td>
           <td>Method used to sort autocomplete results. Accepts a single argument <code>items</code> and has the scope of the typeahead instance. Reference the current query with <code>this.query</code>.</td>
         </tr>
         <tr>
           <td>highlighter</td>
           <td>function</td>
           <td>highlights all default matches</td>
           <td>Method used to highlight autocomplete results. Accepts a single argument <code>item</code> and has the scope of the typeahead instance. Should return html.</td>
         </tr>
        </tbody>
      </table>

      <h3>Methods</h3>
      <h4>.typeahead(options)</h4>
      <p>Initializes an input with a typeahead.</p>
    </section>



    <!-- Affix
    ================================================== -->
    <section id="affix">
      <div class="page-header">
        <h1>
          Affix
          <small>Make an element stick in place</small>
        </h1>
      </div>
1575

1576
1577
1578
      <h2>...</h2>
      <p>...</p>
      <div class="bs-docs-example">
1579

1580
      </div>
1581
1582
1583
<pre class="prettyprint linenums">
...
</pre>
1584
    </section>
1585

1586
1587
1588


  </div>
1589
</div>
1590

Mark Otto's avatar
Mark Otto committed
1591
1592
    </div>

1593

Mark Otto's avatar
Mark Otto committed
1594
1595
1596
1597
1598

   <!-- Footer
    ================================================== -->
    <footer class="footer">
      <div class="container">
Mark Otto's avatar
Mark Otto committed
1599
        <p class="pull-right"><a href="#">Back to top</a></p>
Mark Otto's avatar
Mark Otto committed
1600
1601
1602
        <p>Designed and built with all the love in the world <a href="http://twitter.com/twitter" target="_blank">@twitter</a> by <a href="http://twitter.com/mdo" target="_blank">@mdo</a> and <a href="http://twitter.com/fat" target="_blank">@fat</a>.</p>
        <p>Code licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0" target="_blank">Apache License v2.0</a>. Documentation licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p>
        <p>Icons from <a href="http://glyphicons.com">Glyphicons Free</a>, licensed under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p>
1603
1604
1605
1606
1607
        <ul class="footer-links">
          <li><a href="http://blog.getbootstrap.com">Read the blog</a></li>
          <li><a href="https://github.com/twitter/bootstrap/issues?state=open">Submit issues</a></li>
          <li><a href="https://github.com/twitter/bootstrap/wiki">Roadmap and changelog</a></li>
        </ul>
Mark Otto's avatar
Mark Otto committed
1608
1609
      </div>
    </footer>
1610
1611


1612
1613
1614

    <!-- Le javascript
    ================================================== -->
1615
    <!-- Placed at the end of the document so the pages load faster -->
1616
    <script type="text/javascript" src="http://platform.twitter.com/widgets.js"></script>
Jacob Thornton's avatar
Jacob Thornton committed
1617
    <script src="assets/js/jquery.js"></script>
1618
    <script src="assets/js/google-code-prettify/prettify.js"></script>
Jacob Thornton's avatar
Jacob Thornton committed
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
    <script src="assets/js/bootstrap-transition.js"></script>
    <script src="assets/js/bootstrap-alert.js"></script>
    <script src="assets/js/bootstrap-modal.js"></script>
    <script src="assets/js/bootstrap-dropdown.js"></script>
    <script src="assets/js/bootstrap-scrollspy.js"></script>
    <script src="assets/js/bootstrap-tab.js"></script>
    <script src="assets/js/bootstrap-tooltip.js"></script>
    <script src="assets/js/bootstrap-popover.js"></script>
    <script src="assets/js/bootstrap-button.js"></script>
    <script src="assets/js/bootstrap-collapse.js"></script>
    <script src="assets/js/bootstrap-carousel.js"></script>
    <script src="assets/js/bootstrap-typeahead.js"></script>
1631
    <script src="assets/js/application.js"></script>
1632
1633


Jacob Thornton's avatar
Jacob Thornton committed
1634
  </body>
Mark Otto's avatar
Mark Otto committed
1635
</html>
For faster browsing, not all history is shown. View entire blame