Skip to content

toyhunter/react-autosuggest

Repository files navigation

React Autosugest

Installation

npm install react-autosuggest --save

Usage

var Autosuggest = require('react-autosuggest');

var suburbs = ['Cheltenham', 'Mill Park', 'Mordialloc', 'Nunawading'];

function getSuburbs(input, callback) {
  var regex = new RegExp('^' + input, 'i');

  setTimeout(function() {
    callback(null, suburbs.filter(function(suburb) {
      return regex.test(suburb);
    }));
  }, 300);
}
<Autosuggest suggestions={getSuburbs} />

Options

initialValue (optional)

Specifies the initial value of the input field. Defaults to ''. For example:

<Autosuggest initialValue={'Mordialloc'} suggestions={getSuburbs} />
suggestions

Function to get the suggestions.

function(input, callback) {
  ...
}
  • input - The value of the input field

  • callback - Should be called once the suggestions are in hand, or error occurs.

    • Success example: callback(null, ['Mentone', 'Mentone East'])
    • Error example - callback(new Error("Couldn't get locations"))

Development

npm start

Now, open http://localhost:3000/examples/dist/index.html

License

MIT

About

WAI-ARIA compliant React autosuggest component

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.3%
  • Other 0.7%