Mapbox GL Geocoder

A geocoder control for mapbox-gl-js using the Mapbox Geocoding API.

Usage

https://www.mapbox.com/mapbox-gl-js/example/mapbox-gl-geocoder/

If you are supporting older browsers, you will need a Promise polyfill. es6-promise is a good one, if you're uncertain.

Usage with a module bundler

This module exports a single class called MapboxGeocoder as its default export, so in browserify or webpack, you can require it like:

var MapboxGeocoder = require('@mapbox/mapbox-gl-geocoder');

Using without a Map

It is possible to use the plugin without it being placed as a control on a mapbox-gl map. Keep in mind that the Mapbox Terms of Service require that POI search results be shown on a Mapbox map. If you don't need POIs, you can exclude them from your search results with the options.types parameter when constructing a new Geocoder.

Deeper dive

API Documentation

See API.md for complete reference.

Examples

• Add a geocoder to Mapbox GL JS
• Place the geocoder input outside the map
• Limit geocoder results to a named region
• Supplement geocoding search results from another data source
• Accept coordinates as input to a geocoder

Contributing

See CONTRIBUTING.md.