import TypeAhead from ('dictionary-typeahead');

// Set up a dictionary of keywords
const dictionary = [
  "Super cool",
  "Super",
  "Typeahead",
  "Type Ahead",
  "Auto Complete is cool"
];

// Ask for suggestions
const suggestions = TypeAhead.suggest(dictionary, input.value, caretPos);

###ES5

// import the module
var TypeAhead = require('dictionary-typeahead').default;

// Set up a dictionary of keywords
var dictionary = [
  "Super cool",
  "Super",
  "Typeahead",
  "Type Ahead",
  "Auto Complete is cool"
];

// Ask for suggestions
var suggestions = TypeAhead.suggest(dictionary, input.value, caretPos);

##API

|API|description|result| |---|---|---|---|---| |TypeAhead.suggest(dictionary, text, caretPosition) | Given a dictionary of keywords, the user input text, and the user's caret position, find the set of matching suggestions | returns an array of suggestions e.g. ["Super", "Super cool!"] | |TypeAhead.complete(suggestion, text, caretPosition) | Given the the selected suggestion, the input text, and the user's caret position, complete the user's input with the selected suggestion | returns an object containing the text and the suggested 'replace until' position {"text": "This is Super Cool", "pos": 18} |

##Examples The example code can be found in the examples folder.

###Run It! From the project root

npm install http-server -g
http-server
Open browser to http://localhost:8080
navigate to examples/example-1.html
Type "hello this is sup" and watch the suggestions appear.
Click on a suggestion

###Build It! npm run compile-examples

###View It! It's super easy to use

###index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Example 1</title>
</head>
<body>
<input id="textInput" type="text" />
<div id="results" />
<script src="./example-1-webready.js" type="text/javascript"></script>
</body>
</html>

###example-1-webready.js See the examples folder in this project

// Setup TypeAhead
var TypeAhead = require('../dist').default;

// Set up dictionary of keywords for type ahead
var dictionary = [
  "Super cool",
  "Super",
  "Typeahead",
  "Type Ahead",
  "Auto Complete is cool"
];

// Configure on suggestion click handler
window.suggestionClick = function(suggestion) {
  var input = document.getElementById('textInput');
  var caretPos = input.selectionStart;
  input.value = TypeAhead.complete(suggestion, input.value, caretPos).text;
}

// Configure keyup listenener
document.getElementById('textInput').addEventListener("keyup", function(e) {
  var input = document.getElementById("textInput");
  var caretPos = input.selectionStart;
  var matches = TypeAhead.suggest(dictionary, input.value, caretPos);
  var html = matches.map(function(m) {
    return '<div onclick="suggestionClick(\'' + m + '\');">' + m + '</div>';
  }).join('');
  document.getElementById("results").innerHTML = html;
});

##License MIT

Keywords

FAQs

What is dictionary-typeahead?

Is dictionary-typeahead popular?

Is dictionary-typeahead well maintained?

Package last updated on 18 Sep 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

dictionary-typeahead

Keywords

Related posts

Weekly Downloads Now Available in npm Package Search Results

Tech's $90B Ghost Engineer Problem: Stanford Study Finds 9.5% of Engineers Do Almost Nothing