Skip to content

t0ri/autocomplete

Repository files navigation

Travis (.com) Coveralls github GitHub last commit

@t0ri/autocomplete hero img

Autocompletion Library

This autocompletion library is loosely-coupled from the DOM and other dependencies, making it a lightweight lightning-fast solution to autocomplete. It can be used in Node or in the browser.

View NPM Package here.

View demo here.

Features

  • utilizes an internal trie to process data
  • options to ignoreCasing and return only a certain amount of strings
  • loosely coupled for functionality server-side and in the browser

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Browser Installation

Install the library into your project.

npm install @t0ri/autocomplete --save

Import the library content into a JS file using ES6 import syntax at the top of your file.

import Autocomplete from './node_modules/@t0ri/autocomplete/esm/autocomplete.js'

To Do

  • autocomplete() stops traversal once length of returned array hits this.autocompleteCount
  • preserve casing for return when this.ignoreCasing is true (rewrite method non-destructively)
  • expand documentation

About

Loosely coupled autocompletion library for the browser and Node.

Resources

Stars

Watchers

Forks

Releases

No releases published