Skip to content

furkot/geoplete

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

96 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NPM version Build Status Dependency Status

geoplete

Autocompletion for places and addresses. Checkout the demo. Uses awesomplete for UI, and furkot-geocode as a geocoder backend.

Install

$ npm install --save geoplete

Usage

import geoplete from 'geoplete';

const input = document.querySelection('.input-field');

geoplete(input, {         // input element to which geoplete attaches
  type: 'address',        // 'address' or 'place'
  minChars: 4,            // min number of characters before we query for matches
  lang: 'en',             // language - if not specified document.lang is used
  bounds: [[W,S],[E,N]],  // location hint - array of 2 [longitude, latitude] points
  item: function () {},   // generate list item (see [awesomplete][awesomplete-extend])
  geocoder: {
                          // see [furkot-geocode] for details
  }
});

When one of the values is selected input will event. The detail field of the event contain place information:

  • place - place name (may be absent if address doesn't correspond to a named place)
  • type - place type
  • address - formated address
  • house - building number
  • street - street name
  • community - neighborhood or village
  • town - town or city
  • county - administrative area more general than town
  • province - state or province (usually abbreviated)
  • country - country (short form but not abbreviated)

License

ISC © Damian Krzeminski

About

Autocompletion for places and addresses.

Resources

Stars

Watchers

Forks

Packages

No packages published