awesomplete

http://leaverou.github.io/awesomplete/

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
awesomplete
1.1.54 years ago8 years agoMinified + gzip package size for awesomplete in KB

Readme

Awesomplete
npm version Build Status Code Climate Test 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
```sh https://cdnjs.com/libraries/awesomplete ```
  1. Another way to get up and running is by using yarn or npm:
```sh yarn add awesomplete ``` ```sh 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: ```html ``` Then you can add an Awesomplete widget by adding the following input tag: ```html 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: ```html
<option>Ada</option>
<option>Java</option>
<option>JavaScript</option>
<option>Brainfuck</option>
<option>LOLCODE</option>
<option>Node.js</option>
<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): ```html
    <li>Ada</li>
    <li>Java</li>
    <li>JavaScript</li>
    <li>Brainfuck</li>
    <li>LOLCODE</li>
    <li>Node.js</li>
    <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.

License

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

Links

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.