Auto CompleteAPI/ExamplesGithub

Displays suggested words and quickly complete the word.


Browser Support

Chrome Chrome IE Internet Explorer Edge Edge Safari Safari Firefox Firefox
Yes 8+ Yes Yes Yes

Features

  • Displays suggested words using Ajax with the server API.
  • Makes autocomplation enable or disable.
  • Moves the list of suggested words using the keyboard.
  • Supports templates.

Examples

More examples can be found on the left sidebar of each example page, and have fun with it.


Install

TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the package manager.

Via Package Manager

TOAST UI products are registered in two package managers, npm and bower. You can conveniently install it using the commands provided by each package manager. When using npm, be sure to use it in the environment Node.js is installed.

npm
$ npm install --save tui-auto-complete # Latest version
$ npm install --save tui-auto-complete@<version> # Specific version
bower
$ bower install tui-auto-complete # Latest version
$ bower install tui-auto-complete#<tag> # Specific version

Via Contents Delivery Network (CDN)

TOAST UI products are available over the CDN powered by TOAST Cloud.

You can use the CDN as below.

<script src="https://uicdn.toast.com/tui-auto-complete/latest/tui-auto-complete.js"></script>

If you want to use a specific version, use the tag name instead of latest in the url's path.

The CDN directory has the following structure.

tui-auto-complete/
├─ latest/
│  ├─ tui-auto-complete.js
│  └─ tui-auto-complete.min.js
├─ v2.1.0/
│  ├─ ...

Download Source Files


Usage

HTML

Add the container element to create the component as an option. See here for information about the added element.

JavaScript

This component can be used by creating an instance with the constructor function. To get the constructor function, you should import the module using one of the following ways depending on your environment.

Using namespace in browser environment
var AutoComplete = tui.AutoComplete;
Using module format in node environment
var AutoComplete = require('tui-auto-complete'); /* CommonJS */
import {AutoComplete} from 'tui-auto-complete'; /* ES6 */

You can create an instance with options and call various APIs after creating an instance.

var instance = new AutoComplete({ ... });


instance.getValue();

For more information about the API, please see here.


Documents

You can also see the older versions of API page on the releases page.


Contributing


License

This software is licensed under the MIT © NHN.