Github url

awesomplete

by LeaVerou

LeaVerou /awesomplete

Ultra lightweight, usable, beautiful autocomplete with zero dependencies.

6.7K Stars 643 Forks Last release: 12 months ago (v1.1.5) MIT License 303 Commits 8 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Awesomplete

npm versionBuild StatusCode ClimateTest Coverage

https://leaverou.github.io/awesomplete/

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

Installation

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

https://cdnjs.com/libraries/awesomplete
  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>Ada</option>
    <option>Java</option>
    <option>JavaScript</option>
    <option>Brainfuck</option>
    <option>LOLCODE</option>
    <option>Node.js</option>
    <option>Ruby on Rails</option>
</datalist>

Or the following, if you don’t want to use a

<datalist></datalist>

, or if you don’t want to use IDs (since any selector will work in data-list):

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

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.

License

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

Links

The official site for the library is at https://leaverou.github.io/awesomplete/.

Documentation for the API and other topics is athttps://leaverou.github.io/awesomplete/#api.

Created by Lea Verou and other fantastic contributors.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.