twitter /typeahead.js

typeahead.js is a fast and fully-featured autocomplete library

★ 16,410⑂ 3,089👁 532⑃ 476● 1,332▤ 0
JavaScriptMITCreated 2013-02-19twitter.github.io/typeahead.js/
+0
日增长
16,410
stars
3,089
forks
532
watchers
476
prs
1,332
issues
0
releases

README

[typeahead.js][gh-page]
=======================

Inspired by [twitter.com]'s autocomplete search functionality, typeahead.js is 
a flexible JavaScript library that provides a strong foundation for building 
robust typeaheads.

The typeahead.js library consists of 2 components: the suggestion engine, 
[Bloodhound], and the UI view, [Typeahead]. 
The suggestion engine is responsible for computing suggestions for a given 
query. The UI view is responsible for rendering suggestions and handling DOM 
interactions. Both components can be used separately, but when used together, 
they can provide a rich typeahead experience.



[gh-page]: http://twitter.github.io/typeahead.js/
[twitter.com]: https://twitter.com
[Bloodhound]: https://github.com/twitter/typeahead.js/blob/master/doc/bloodhound.md
[Typeahead]: https://github.com/twitter/typeahead.js/blob/master/doc/jquery_typeahead.md

Getting Started
---------------

How you acquire typeahead.js is up to you.

Preferred method:
 Install with [Bower]: $ bower install typeahead.js

Other methods:
 [Download zipball of latest release][zipball].
 Download the latest dist files individually:
   [bloodhound.js] (standalone suggestion engine)
   [typeahead.jquery.js] (standalone UI view)
   [typeahead.bundle.js] (bloodhound.js + typeahead.jquery.js)
   [typeahead.bundle.min.js]

Note: both bloodhound.js and typeahead.jquery.js have a dependency on 
[jQuery] 1.9+.



[Bower]: http://bower.io/
[zipball]: http://twitter.github.com/typeahead.js/releases/latest/typeahead.js.zip
[bloodhound.js]: http://twitter.github.com/typeahead.js/releases/latest/bloodhound.js
[typeahead.jquery.js]: http://twitter.github.com/typeahead.js/releases/latest/typeahead.jquery.js
[typeahead.bundle.js]: http://twitter.github.com/typeahead.js/releases/latest/typeahead.bundle.js
[typeahead.bundle.min.js]: http://twitter.github.com/typeahead.js/releases/latest/typeahead.bundle.min.js
[jQuery]: http://jquery.com/

Documentation 
-------------

 [Typeahead Docs]
 [Bloodhound Docs]

[Typeahead Docs]: https://github.com/twitter/typeahead.js/blob/master/doc/jquery_typeahead.md
[Bloodhound Docs]: https://github.com/twitter/typeahead.js/blob/master/doc/bloodhound.md

Examples
--------

For some working examples of typeahead.js, visit the [examples page].



[examples page]: http://twitter.github.io/typeahead.js/examples

Browser Support
---------------

 Chrome
 Firefox 3.5+
 Safari 4+
 Internet Explorer 8+
 Opera 11+

NOTE: typeahead.js is not tested on mobile browsers.

Customer Support
----------------

For general questions about typeahead.js, tweet at [@typeahead].

For technical questions, you should post a question on [Stack Overflow] and tag 
it with [typeahead.js][so tag].



[Stack Overflow]: http://stackoverflow.com/
[@typeahead]: https://twitter.com/typeahead
[so tag]: http://stackoverflow.com/questions/tagged/typeahead.js

Issues
------

Discovered a bug? Please create an issue here on GitHub!

https://github.com/twitter/typeahead.js/iss

Top issues

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON