Skip to content
This repository was archived by the owner on Feb 2, 2023. It is now read-only.

algolia/places

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e417a59 · Jul 19, 2022
Jun 9, 2020
Apr 27, 2020
Jul 19, 2022
Aug 3, 2020
Oct 9, 2020
Oct 9, 2020
Feb 5, 2019
May 11, 2020
Oct 9, 2020
Sep 30, 2019
May 1, 2021
Jul 6, 2022
Feb 17, 2020
May 26, 2020
Mar 31, 2017
Apr 27, 2020
Apr 6, 2016
Jan 14, 2019
Mar 14, 2022
Nov 25, 2019
Sep 30, 2019
Jun 15, 2016
Jul 1, 2016
Nov 25, 2019
Nov 25, 2019
May 30, 2022
Jun 11, 2018
Sep 30, 2019
Nov 25, 2019
Nov 25, 2019
May 30, 2022

Repository files navigation

header

Version Build Status License Downloads jsDelivr Hits

Deprecation of service

Places is going away on May 31st 2022. Read our blog post announcement. Places is going away on May 31st 2022. Read our blog post announcement. Places is going away on May 31st 2022. Read our blog post announcement. Places is going away on May 31st 2022. Read our blog post announcement. Places is going away on May 31st 2022. Read our blog post announcement. Places is going away on May 31st 2022. Read our blog post announcement.

Introduction

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.19.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({
    appId: "<YOUR_PLACES_APP_ID>",
    apiKey: "<YOUR_PLACES_API_KEY>",
    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({
  appId: "<YOUR_PLACES_APP_ID>",
  apiKey: "<YOUR_PLACES_API_KEY>",
  container: document.querySelector('#address-input')
});

Full documentation is available on the Algolia Places website.

Contributing

Wanna contribute? Awesome, please read the contributing guide.