Getting Started

This page is an overview of the Autocomplete documentation and related resources.

Autocomplete is a JavaScript library for building autocomplete search experiences.

Features

  • Displays suggestions as you type
  • Provides autocompletion
  • Supports custom templates for UI flexibility
  • Works well with RTL languages
  • Triggers custom hooks to plug your logic
  • Plugs easily to Algolia's realtime search engine

Installation

Autocomplete is available on the npm registry.

yarn add @francoischalifour/autocomplete-core@alpha
# or
npm install @francoischalifour/autocomplete-core@alpha

If you do not wish to use a package manager, you can use standalone endpoints:

<!-- jsDelivr -->
<script src="https://cdn.jsdelivr.net/npm/@francoischalifour/autocomplete-core@alpha"></script>
<!-- unpkg -->
<script src="https://unpkg.com/@francoischalifour/autocomplete-core@alpha"></script>