search

twitter / typeahead.js

typeahead.js is a fast and fully-featured autocomplete library
http://twitter.github.io/typeahead.js/
MIT License
16.52k stars 3.21k forks source link

Documentation lacking key information #1802

Open SoftCircuits opened 2 years ago

SoftCircuits commented 2 years ago

I've spent a bit of time trying to get up to speed with this component.

It seems the documentation doesn't tell me which files I need. In my case, I want the absolute minimum to get the typeahead working. (No Bloodhound, etc.) I don't see anywhere where it tells me which files I need for that. In fact, you don't even have a file called typeahead.js, as the examples page seems to suggest I need.

Moreover, when I seemed to get it finally working, it now seems clear I need some specialized CSS for it to work. And, again, I don't see any information on this. At this point, I don't know if it was assumed I'd write my own CSS or what.

Perhaps someone could write a paragraph or two explaining which files I need to implement the examples.

john-999 commented 2 years ago

Recommended solutions (without jQuery dependencies):

  1. Tarek Raafat's "autoComplete.js" (can be used in existing forms): https://github.com/TarekRaafat/autoComplete.js

  2. "Algolia autocomplete" (but creates a form element, so not usable within existing forms, only as a standalone element): https://github.com/algolia/autocomplete