JarCasting
Twitter Bootstrap Ajax Typeahead Plugin
Modifications to the Bootstrap Typeahead plugin to give it ajax capabilities. See Demo
How to Use
To make a regular typeahead plugin query a server for the source, just specify an ajax member when initializing.
Feature
- A callback function is available for when an item is selected
- Ability to specify data source properties
- Ability to use a local or remote (AJAX) data source
- Most original methods are overridable so you can customize without changing the source code
Required
- Twitter Bootstrap 2.0+
- jQuery 1.8+
Installation
Download jQuery
- Download the latest release
- Clone in Windows
- Clone the repo:
git clone git://github.com/jquery/jquery.git.
Download Bootstrap
- Download the latest release.
- Clone in Windows
- Clone the repo:
git clone git://github.com/twitter/bootstrap.git. - Install with Twitter's Bower:
bower install bootstrap.
Download this plugin.
- Download the latest release
- Clone in Windows
- Clone the repo:
git clone git://github.com/biggora/bootstrap-ajax-typeahead.git - Install with Bower:
bower install bs-typeahead.
Include files in your HTML. The minimum required for this plugin are:
<script src="/path/to/jquery.js" type="text/javascript"></script>
<script src="/path/to/bootstrap-typeahead.js" type="text/javascript"></script>
Execute the plugin:
$('input.typeahead').typeahead(options);
Events
| Event | Description |
|---|---|
| grepper | Filters relevant results from the source. |
| highlighter | Highlights any matching results in the list. |
| onSelect | The callback function that is invoked when an item is chosen. {
item : {
value: "",
text: ""
}
} |
| lookup | Determines if source is remote or local and initializes the search. |
| matcher | Looks for a match between the query and a source item. |
| render | Renders the list of results. |
| select | Selects an item from the results list. |
| sorter | Sorts the results. |
Options
| Name | Type | Default | Description |
|---|---|---|---|
| ajax | object | null | The object required to use a remote datasource. See also: ajax as a string (below) |
| ajax | string | null | Optionally, a simple URL may be used instead of the AJAX object. See also: ajax as an object |
| displayField | string | 'name' | The object property to match the query against and highlight in the results. |
| item | string | '<li><a href="#"></a></li>' | The HTML rendering for a result item. |
| items | integer | 10 | The maximum number of items to show in the results. |
| menu | string | '<ul class="typeahead dropdown-menu"></ul>' | The HTML rendering for the results list. |
| scrollBar | boolean | false | Used to show scrollBar when there are too many match records and it's set to True. If this option is set to true,the items value will be 100 and the HTML render menu will be set to: '<ul class="typeahead dropdown-menu" style="max-height:220px;overflow:auto;" ></ul>' |
| alignWidth | boolean | true | The align dropdown width by input field width. |
| source | object | [] | The source to search against. |
| valueField | string | 'id' | The object property that is returned when an item is selected. |
Ajax Options
| Name | Type | Default | Description |
|---|---|---|---|
| url | string | null | |
Basic Usage
The plugin in its simplest (realistic) form.
Example 1
var typeaheadSource = ['John', 'Alex', 'Terry'];
$('input.typeahead').typeahead({
source: typeaheadSource
});
Example 2
var typeaheadSource = [{ id: 1, name: 'John'}, { id: 2, name: 'Alex'}, { id: 3, name: 'Terry'}];
$('input.typeahead').typeahead({
source: typeaheadSource
});
Example 3
var typeaheadSource = [{
id: 1, firstName: 'John'}, {
id: 2, firstName: 'Alex'}, {
id: 3, firstName: 'Terry'
}];
$('input.typeahead').typeahead({
source: typeaheadSource,
displayField: 'firstName'
});
Example 4
For a quick setup, specify a source url to pull data from:
$('input.typeahead').typeahead({
ajax: '/path/to/typeahead/source'
});
Extended Usage
$("input.typeahead").typeahead({
onSelect: function(item) {
console.log(item);
},
ajax: {
url: "/path/to/source",
timeout: 500,
displayField: "title",
triggerLength: 1,
method: "get",
loadingClass: "loading-circle",
preDispatch: function (query) {
showLoadingMask(true);
return {
search: query
}
},
preProcess: function (data) {
showLoadingMask(false);
if (data.success === false) {
// Hide the list, there was some error
return false;
}
// We good!
return data.mylist;
}
}
});
Bootstrap Integration
For simple autocomplete use cases, the typeahead component [Bootstrap][bootstrap] provides should suffice. However, if you'd prefer to take advantage of some of the advance features typeahead.js provides, here's what you'll need to do to integrate typeahead.js with Bootstrap:
- If you're customizing Bootstrap, exclude the typeahead component. If you're depending on the standard bootstrap.js, ensure bootstrap-typeahead.js is loaded after it.
- The DOM structure of the dropdown menu used by typeahead.js differs from the DOM structure of the Bootstrap dropdown menu. You'll need to load some [additional CSS][typeahead-bootstrap.css] in order to get the bootstrap-typeahead.js dropdown menu to fit the default Bootstrap theme.
Browser Support
- Chrome
- Firefox 3.5+
- Safari 4+
- Internet Explorer 7+
- Opera 11+
Recommend extensions
- Bootstrap Fancy File Plugin
- Bootstrap Select Plugin
- TrinteJS - Javascrpt MVC Framework for Node.JS
- CaminteJS - Cross-db ORM for NodeJS
- MongoDB Session Storage for ExpressJS
- Middleware exposing user-agent for NodeJS
- 2CO NodeJS adapter for 2checkout API payment gateway
Copyright and license
The MIT License (MIT)
Copyright (c) 2011-2014 Twitter, Inc
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Resources
- Visit the author website.
- Follow @biggora on Twitter for updates.
- Report issues on the github issues page.
