Awesome Open Source
Awesome Open Source
Autocomplete

Autocomplete

A JavaScript library that lets you quickly build autocomplete experiences

Version MIT License

🚧 Autocomplete v1 is in an alpha phase and early feedback is welcome.

If you're looking for Autocomplete v0, which has been the production-ready version for the last years, head over to the master branch.

All you need to get started is:

  • A container to inject the experience into
  • Data to fill the autocomplete with
  • Any Virtual DOM solution (JavaScript, Preact, React, Vue, etc.)

The data that populates the autocomplete results are called sources. You can use whatever you want in your sources: a static set of searches terms, search results from an external source like an Algolia index, recent searches, and more.

By configuring just those two required parameters (container and getSources) you can have an interactive autocomplete experience. The library creates an input and provides the interactivity and accessibility attributes, but you're in full control of the DOM elements to output.

Screenshot

DocumentationAPIPlayground

Installation

The recommended way to get started is with the autocomplete-js package. It includes everything you need to render a JavaScript autocomplete experience.

Otherwise, you can install the autocomplete-core package if you want to build a renderer from scratch.

All Autocomplete packages are available on the npm registry.

yarn add @algolia/[email protected]
# or
npm install @algolia/[email protected]

If you don't use a package manager, you can use the HTML script element:

<script src="https://cdn.jsdelivr.net/npm/@algolia/[email protected]"></script>
<script>
  const { autocomplete } = window['@algolia/autocomplete-js'];
</script>

Usage

To get started, you need a container for your autocomplete to go in. If you don't have one already, you can insert one into your markup:

<div id="autocomplete"></div>

Then, insert your autocomplete into it by calling the autocomplete function and providing the container. It can be a CSS selector or an Element.

Make sure to provide a container (e.g., a div), not an input. Autocomplete generates a fully accessible search box for you.

import { autocomplete } from '@algolia/autocomplete-js';

autocomplete({
  container: '#autocomplete',
  // ...
});

Continue reading our Getting Started guide.

Documentation

The documentation offers a few ways to learn about the Autocomplete library:

  • Read the Core Concepts to learn more about underlying principles, like Sources and State.
  • Follow the Guides to understand how to build common UX patterns.
  • Refer to API reference for a comprehensive list of parameters and options.
  • Try out the Playground where you can fork a basic implementation and play around.

You can find more on the documentation.

Support

Packages

Package Description Documentation
autocomplete-core Core primitives to build an Autocomplete experience Documentation
autocomplete-js JavaScript package for Autocomplete Documentation
autocomplete-plugin-recent-searches A plugin to add recent searches to Algolia Autocomplete Documentation
autocomplete-plugin-query-suggestions A plugin to add query suggestions to Algolia Autocomplete Documentation
autocomplete-plugin-algolia-insights A plugin to add Algolia Insights to Algolia Autocomplete Documentation
autocomplete-preset-algolia Presets to use Algolia features with Autocomplete Documentation
autocomplete-theme-classic Classic theme for Autocomplete Documentation

Showcase

See the awesome experiences people built with Autocomplete:

DocSearch Algolia Documentation

Sandboxes

Check out sandboxes using Autocomplete:

E-commerce React renderer
E-commerce React renderer
Recent Searches Query Suggestions Algolia Index Algolia Insights Preact Algolia Index React

You can find more sandboxes on CodeSandbox.

License

MIT


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
typescript (10,847
search (382
autocomplete (177
alfred (124
modal (120
query (96
dropdown (92
select (92
algolia (60
accessible (25
typeahead (24

Find Open Source By Browsing 7,000 Topics Across 59 Categories