Skip to content
A simple geocoder form to locate places. Easily extended to multiple data providers.
JavaScript CSS HTML Shell
Branch: master
Clone or download
ENT8R and perliedman Add an aria-label to the geocoder control button (#263)
* Add an aria-label to the geocoder control button

- More information can be found at https://www.w3.org/TR/wai-aria/#aria-label where the purpose of the "aria-label" attribute is described
- If there is no label of an interactive UI element, screen readers might have difficulties to extract the purpose of the element.
- The aria-label attribute helps screen readers by offering a label describing the purpose of the UI element and what happens when clicking on it

* Add an option to change the text of the accessibility icon label
Latest commit 02abfad Oct 21, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo-rollup
demo-webpack demos: use HTTPS for osm.org Aug 13, 2019
demo demos: use HTTPS for osm.org Aug 13, 2019
images layout css simplified, previous had problems on Samsung tab default b… Jun 25, 2015
scripts scripts/publish: fail on error Jun 8, 2019
spec Add open-location-code.spec.js Jun 4, 2019
src Add an aria-label to the geocoder control button (#263) Oct 21, 2019
.editorconfig Use ESLint, Prettier for code linting+formatting (#188) Jan 9, 2018
.eslintignore Update .gitignore and .eslintignore Jun 8, 2019
.eslintrc.yaml Use ESLint, Prettier for code linting+formatting (#188) Jan 9, 2018
.gitignore Update .gitignore and .eslintignore Jun 8, 2019
.prettierrc.yaml Use ESLint, Prettier for code linting+formatting (#188) Jan 9, 2018
.travis.yml Run prettier also on json and yaml files May 12, 2019
Control.Geocoder.css Use ESLint, Prettier for code linting+formatting (#188) Jan 9, 2018
LICENSE Added LICENSE according to sa3m/leaflet-control-bing-geocoder#6 Sep 30, 2013
README.md
bower.json Add support for Plus codes Jun 4, 2019
package-lock.json 1.10.0 Oct 8, 2019
package.json 1.10.0 Oct 8, 2019
rollup.config.js Build uglified Control.Geocoder.min.js as well Sep 1, 2018

README.md

A few words on diversity in tech

I need to take some of your time. I can't believe we let shit like the Kathy Sierra incident or what happened to Brianna Wu happen over and over again. I can't believe we, the open source community, let sexist, misogynous shit happen over and over again.

I strongly believe that it is my — and your — duty to make the open source community, as well as the tech community at large, a community where everyone feel welcome and is accepted. At the very minimum, that means making sure the community and its forums both are safe, and are perceived as safe. It means being friendly and inclusive, even when you disagree with people. It means not shrugging off discussions about sexism and inclusiveness with handwaving about censorship and free speech. For a more elaborate document on what that means, the NPM Code of Conduct is a good start, Geek Feminism's resources for allies contains much more.

While I can't force anyone to do anything, if you happen to disagree with this, I ask of you not to use any of the open source I have published. Nor am I interested in contributions from people who can't accept or act respectfully towards other humans regardless of gender identity, sexual orientation, disability, ethnicity, religion, age, physical appearance, body size, race, or similar personal characteristics. If you think feminism, anti-racism or the LGBT movement is somehow wrong, disturbing or irrelevant, I ask you to go elsewhere to find software.

Leaflet Control Geocoder NPM version Leaflet 1.0.0 compatible!

A simple geocoder for Leaflet that by default uses OSM/Nominatim.

The plugin supports many different data providers:

The plugin can easily be extended to support other providers. Current extensions:

Demos

Usage

Download latest release, or obtain the latest release via unpkg.com:

<link rel="stylesheet" href="https://unpkg.com/leaflet-control-geocoder/dist/Control.Geocoder.css" />
<script src="https://unpkg.com/leaflet-control-geocoder/dist/Control.Geocoder.js"></script>

Add the control to a map instance:

var map = L.map('map').setView([0, 0], 2);
L.tileLayer('https://{s}.tile.osm.org/{z}/{x}/{y}.png', {
  attribution: '&copy; <a href="https://osm.org/copyright">OpenStreetMap</a> contributors'
}).addTo(map);
L.Control.geocoder().addTo(map);

Customizing

By default, when a geocoding result is found, the control will center the map on it and place a marker at its location. This can be customized by listening to the control's markgeocode event. To remove the control's default handler for marking a result, set the option defaultMarkGeocode to false.

For example:

var geocoder = L.Control.geocoder({
  defaultMarkGeocode: false
})
  .on('markgeocode', function(e) {
    var bbox = e.geocode.bbox;
    var poly = L.polygon([
      bbox.getSouthEast(),
      bbox.getNorthEast(),
      bbox.getNorthWest(),
      bbox.getSouthWest()
    ]).addTo(map);
    map.fitBounds(poly.getBounds());
  })
  .addTo(map);

This will add a polygon representing the result's boundingbox when a result is selected.

API

L.Control.Geocoder

This is the geocoder control. It works like any other Leaflet control, and is added to the map.

Constructor

This plugin supports the standard JavaScript constructor (to be invoked using new) as well as the class factory methods known from Leaflet:

new L.Control.Geocoder(options);
// or
L.Control.geocoder(options);

Options

Option Type Default Description
collapsed Boolean true Collapse control unless hovered/clicked
expand String "touch" How to expand a collapsed control: touch or click or hover
position String "topright" Control position
placeholder String "Search..." Placeholder text for text input
errorMessage String "Nothing found." Message when no result found / geocoding error occurs
iconLabel String "Initiate a new search" Accessibility label for the search icon used by screen readers
geocoder IGeocoder new L.Control.Geocoder.Nominatim() Object to perform the actual geocoding queries
showUniqueResult Boolean true Immediately show the unique result without prompting for alternatives
showResultIcons Boolean false Show icons for geocoding results (if available); supported by Nominatim
suggestMinLength Number 3 Minimum number characters before suggest functionality is used (if available from geocoder)
suggestTimeout Number 250 Number of milliseconds after typing stopped before suggest functionality is used (if available from geocoder)
queryMinLength Number 1 Minimum number of characters in search text before performing a query

Methods

Method Returns Description
markGeocode(<GeocodingResult> result) this Marks a geocoding result on the map

L.Control.Geocoder.Nominatim

Uses Nominatim to respond to geocoding queries. This is the default geocoding service used by the control, unless otherwise specified in the options. Implements IGeocoder.

Unless using your own Nominatim installation, please refer to the Nominatim usage policy.

Constructor

new L.Control.Geocoder.Nominatim(options);
// or
L.Control.Geocoder.nominatim(options);

Options

Option Type Default Description
serviceUrl String "https://nominatim.openstreetmap.org/" URL of the service
geocodingQueryParams Object {} Additional URL parameters (strings) that will be added to geocoding requests; can be used to restrict results to a specific country for example, by providing the countrycodes parameter to Nominatim
reverseQueryParams Object {} Additional URL parameters (strings) that will be added to reverse geocoding requests
htmlTemplate function special A function that takes an GeocodingResult as argument and returns an HTML formatted string that represents the result. Default function breaks up address in parts from most to least specific, in attempt to increase readability compared to Nominatim's naming

L.Control.Geocoder.Bing

Uses Bing Locations API to respond to geocoding queries. Implements IGeocoder.

Note that you need an API key to use this service.

Constructor

new L.Control.Geocoder.Bing(<String>key);
// or
L.Control.Geocoder.bing(<String>key);

L.Control.Geocoder.OpenCage

Uses OpenCage Data API to respond to geocoding queries. Implements IGeocoder.

Note that you need an API key to use this service.

Constructor

new L.Control.Geocoder.OpenCage(<String>key);
// or
L.Control.Geocoder.opencage(<String>key);

L.Control.Geocoder.LatLng

Parses basic latitude/longitude strings such as '50.06773 14.37742', 'N50.06773 W14.37742', 'S 50° 04.064 E 014° 22.645', or 'S 50° 4′ 03.828″, W 14° 22′ 38.712″'.

Constructor

new L.Control.Geocoder.LatLng(options);
// or
L.Control.Geocoder.latLng(options);

Options

Option Type Default Description
next IGeocoder The next geocoder to use for non-supported queries.
sizeInMeters Number 10000 The size in meters used for passing to LatLng.toBounds.

IGeocoder

An interface implemented to respond to geocoding queries.

Methods

Method Returns Description
geocode(<String> query, callback, context) GeocodingResult[] Performs a geocoding query and returns the results to the callback in the provided context
suggest(<String> query, callback, context) GeocodingResult[] Performs a geocoding query suggestion (this happens while typing) and returns the results to the callback in the provided context
reverse(<L.LatLng> location, <Number> scale, callback, context) GeocodingResult[] Performs a reverse geocoding query and returns the results to the callback in the provided context

GeocodingResult

An object that represents a result from a geocoding query.

Properties

Property Type Description
name String Name of found location
bbox L.LatLngBounds The bounds of the location
center L.LatLng The center coordinate of the location
icon String URL for icon representing result; optional
html String (optional) HTML formatted representation of the name
You can’t perform that action at this time.