Prefer using the Autocomplete widget from InstantSearch instead of the standalone Autocomplete library.
It integrates more closely with your search experience.
For more information,
see the API reference for InstantSearch.js or
React InstantSearch.
What Autocomplete provides
Autocomplete is a JavaScript library that lets you quickly build autocomplete experiences. All you need to get started is:- A container to inject the experience into
- Data to fill the autocomplete with
container
and getSources.
Once you do, Autocomplete creates the input and handles user interactions.
The library creates an input and provides the interactivity and accessibility attributes,
but you’re in full control of the DOM elements to output.
You aren’t limited to suggested search terms.
You can display links to individual results
or even display “actions” that a user can take from within an autocomplete.
For example, you could let your users turn dark mode on,
directly from an autocomplete, if they begin to type “dark mode”.
You can also display different data types, such as suggested search terms, product results, and actions, in different ways.
The format of each data type and layout is customizable.
What Autocomplete doesn’t provide
Unlike InstantSearch, Autocomplete doesn’t provide a library of ready-made UI widgets. You control how the autocomplete interface is rendered, while the library handles its core behavior and accessibility. You’re also in charge of providing the collection of items to display. You can easily plug Algolia results usinggetAlgoliaResults
if you want, but you’re free to use Autocomplete with any data sources you want.
To learn more, see Getting started for a basic example in action.