content | ||
dist | ||
scripts | ||
spec | ||
src | ||
.gitignore | ||
demo.htm | ||
license.txt | ||
readme.md |
#Ajax AutoComplete for jQuery
Ajax Autocomplete for jQuery allows you to easily create autocomplete/autosuggest boxes for text input fields.
##Usage
Html:
<input type="text" name="country" id="autocomplete"/>
Ajax lookup:
$('#autocomplete').autocomplete({
serviceUrl: '/autocomplete/countries',
onSelect: function (suggestion) {
status.html('You selected: ' + suggestion);
}
});
Local lookup (no ajax):
$('#autocomplete').autocomplete({
lookup: countries,
onSelect: function (suggestion) {
status.html('You selected: ' + suggestion);
}
});
##Response Format
Response from the server must be JSON formatted following JavaScript object:
{
query: "Unit",
suggestions: [
{ value: "United Arab Emirates", data: "AE" },
{ value: "United Kingdom", data: "UK" },
{ value: "United States", data: "US" }
]
}
Data can be any value or object. Data object is passed to formatResults function and onSelect callback. Alternatively, if there is no data you can supply just a string array for suggestions:
{
query: "Unit",
suggestions: ["United Arab Emirates", "United Kingdom", "United States"]
}
Important: query value must match original value in the input field, otherwise suggestions will not be displayed.
##License
Ajax Autocomplete for jQuery is freely distributable under the terms of an MIT-style license.
Copyright notice and permission notice shall be included in all copies or substantial portions of the Software.
##Authors
Tomas Kirda / @tkirda