🌐 Turn any <input> into an address autocomplete
samouss and raphi docs: update InstantSearch example (#593)
* docs(examples): use the built-in GeoSearch widget

* docs(examples): use configure rather than searchParameters

* docs: add Google API Key

* docs(examples): add title to marker

* docs: add Google API Key for build
Latest commit 31430d3 Sep 17, 2018
Permalink
Failed to load latest commit information.
.github Create PULL_REQUEST_TEMPLATE.md Nov 14, 2016
__mocks__ chore(stack): upgrade whole stack Mar 27, 2017
docs docs: update InstantSearch example (#593) Sep 17, 2018
scripts Chore/enforce-node-ver (#555) Aug 8, 2018
src release v1.11.0 Sep 17, 2018
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(deps): upgrade all deps (#504) Jun 4, 2018
.gitignore doc(reverse): add reverse geocoding endpoint documentation (#531) Jul 4, 2018
.nvmrc chore(deps): update node.js to v10.10.0 Sep 8, 2018
.ruby-version chore(stack): upgrade whole stack Mar 27, 2017
.travis.yml chore(deps): upgrade all deps (#504) Jun 4, 2018
CHANGELOG.md release v1.11.0 Sep 17, 2018
CONTRIBUTING.md fix(contributing): fix link Mar 31, 2017
LICENSE docs(misc): add LICENSE, fix links Apr 6, 2016
README.md release v1.11.0 Sep 17, 2018
autocompleteDataset.js chore(stack): upgrade whole stack Mar 27, 2017
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 release v1.11.0 Sep 17, 2018
renovate.json Configure Renovate (#507) Jun 11, 2018
webpack.config.babel.js chore(stack): upgrade whole stack Mar 27, 2017
webpack.config.docs.babel.js chore(stack): upgrade whole stack Mar 27, 2017
webpack.config.npm.babel.js chore(stack): upgrade whole stack Mar 27, 2017
yarn.lock chore(deps): update dependency eslint to v5.6.0 Sep 17, 2018

README.md

header

Version Build Status License Downloads jsDelivr Hits

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.

Fill the Google form to report any irrelevant results.

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/npm/places.js@1.11.0"></script>

Version is the latest version.

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.