Skip to content
Branch: gh-pages
Go to file

Latest commit

Robbertdk authored and LeaVerou committed 2bdab45 Sep 24, 2019
In commit da06e45 the functionality to select the first item on tab is added, but this can't be found in the documentation. This change adds that documentation.


Failed to load latest commit information.
Latest commit message
Commit time


npm version Build Status Code Climate Test Coverage

Awesomplete is an ultra lightweight, customizable, simple autocomplete widget with zero dependencies, built with modern standards for modern browsers.


There are a few ways to obtain the needed files. Here are 2 of them:

  1. CDN server
  1. Another way to get up and running is by using yarn or npm:
yarn add awesomplete
npm install awesomplete --save

More information about the npm package can be found here.

Basic Usage

Before you try anything, you need to include awesomplete.css and awesomplete.js in your page, via the usual tags:

<link rel="stylesheet" href="awesomplete.css" />
<script src="awesomplete.js" async></script>

Then you can add an Awesomplete widget by adding the following input tag:

<input class="awesomplete"
       data-list="Ada, Java, JavaScript, Brainfuck, LOLCODE, Node.js, Ruby on Rails" />

Add class="awesomplete" for it to be automatically processed (you can still specify many options via HTML attributes) Otherwise you can instantiate with a few lines of JS code, which allow for more customization.

There are many ways to link an input to a list of suggestions. The simple example above could have also been made with the following markup, which provides a nice native fallback in case the script doesn’t load:

<input class="awesomplete" list="mylist" />
<datalist id="mylist">
	<option>Ruby on Rails</option>

Or the following, if you don’t want to use a <datalist>, or if you don’t want to use IDs (since any selector will work in data-list):

<input class="awesomplete" data-list="#mylist" />
<ul id="mylist">
	<li>Ruby on Rails</li>

There are multiple customizations and properties able to be instantiated within the JS. Libraries and definitions of the properties are available in the Links below.


Awesomplete is released under the MIT License. See LICENSE file for details.


The official site for the library is at

Documentation for the API and other topics is at

Created by Lea Verou and other fantastic contributors.

You can’t perform that action at this time.