🌐 Turn any <input> into an address autocomplete
JavaScript Shell CSS
Permalink
Failed to load latest commit information.
__mocks__ test(mock): fix mocks based on new jest and algoliasearch Oct 6, 2016
docs update iso on docs Oct 21, 2016
scripts test(mock): fix mocks based on new jest and algoliasearch Oct 6, 2016
src docs(widget.js): fix jsdoc typos Oct 20, 2016
test feat(icons): new icons (busStop, trainStation, airport, townhall) (#284) Jul 17, 2016
.babelrc feat(npm): provide a nice and clean npm build (#237) Jun 20, 2016
.eslintignore chore(CI): let travis do the bundle install Mar 29, 2016
.eslintrc.js chore(lint): upgrade to new eslint + jasmine rules Jul 19, 2016
.gitignore test(lib): full unit test suite (#269) Jul 1, 2016
.travis.yml chore(greenkeeper): allow greenkeeper in travis Jul 12, 2016
CHANGELOG.md release v1.4.6 Oct 6, 2016
CONTRIBUTING.md test(node): test on node v6 Jul 4, 2016
LICENSE docs(misc): add LICENSE, fix links Apr 6, 2016
README.md docs(README): add header image Jul 1, 2016
autocompleteDataset.js chore(lint): use new eslint-config-algolia Jul 12, 2016
demo.gif docs(README): demo.gif update Jun 15, 2016
header.png docs(README): add header image Jul 1, 2016
index.js chore(lint): use new eslint-config-algolia Jul 12, 2016
instantsearchWidget.js chore(lint): use new eslint-config-algolia Jul 12, 2016
package.json chore(package): update autocomplete.js to version 0.22.0 Oct 25, 2016
webpack.config.babel.js chore(webpack): re-add css loader Jun 20, 2016
webpack.config.docs.babel.js docs(/documentation): reorganize JS, partials, navigation Apr 1, 2016
webpack.config.npm.babel.js feat(npm): provide a nice and clean npm build (#237) Jun 20, 2016

README.md

header

Version Build Status License Downloads

Algolia Places provides a fast, distributed and easy way to use an address search autocomplete JavaScript library on your website.

See the website for more information.

Read the blog post introducing Algolia Places.

Demo

Watch more examples on the website.

demo

Getting started

To use Algolia Places, all you need is an <input> and some JavaScript code that will load and use the places.js library.

CDN <script>

Our JavaScript library is available on the jsDelivr CDN and also on cdnjs.

<script src="https://cdn.jsdelivr.net/places.js/1/places.min.js"></script>

Here's a small example using it:

<input type="search" id="address-input" placeholder="Where are we going?" />

<script>
  var placesAutocomplete = places({
    container: document.querySelector('#address-input')
  });
</script>

Using npm

Algolia Places is also available on npm.

Install the module:

npm install places.js --save

Put an <input> in your html page:

<input type="search" id="address-input" placeholder="Where are we going?" />

Initialize the places.js library:

var places = require('places.js');
var placesAutocomplete = places({
  container: document.querySelector('#address-input')
});

Full documentation is available on the Algolia Places website.

Contributing

Wanna contribute? Awesome, please read the contributing guide.