Did you know ... Search Documentation:
Pack logicmoo_workspace -- node_modules/typeahead.js/README.md

![build status](http://travis-ci.org/twitter/typeahead.js) ![Built with Grunt](http://gruntjs.com/)


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.

<!-- section links -->

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



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

<!-- section links -->

[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].

<!-- section links -->

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


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



For transparency and insight into our release cycle, releases will be numbered with the following format:


And constructed with the following guidelines:

  • Breaking backwards compatibility bumps the major
  • New additions without breaking backwards compatibility bumps the minor
  • Bug fixes and misc changes bump the patch For more information on semantic versioning, please visit http://semver.org/.


Tests are written using [Jasmine] and ran with [Karma]. To run the test suite with PhantomJS, run `$ npm test`.

<!-- section links -->

[Jasmine]: http://jasmine.github.io/ [Karma]: http://karma-runner.github.io/


If you plan on contributing to typeahead.js, be sure to read the [contributing guidelines]. A good starting place for new contributors are issues labeled with [entry-level]. Entry-level issues tend to require minor changes and provide developers a chance to get more familiar with typeahead.js before taking on more challenging work.

In order to build and test typeahead.js, you'll need to install its dev dependencies (`$ npm install`) and have [grunt-cli] installed (`$ npm install -g grunt-cli`). Below is an overview of the available Grunt tasks that'll be useful in development.




Copyright 2013 Twitter, Inc.

Licensed under the MIT License