Add a geocoder
This example adds a geocoding control to a web map, enabling users to search the map for a place.
It adds the control by loading the mapbox-gl-geocoder plugin inside a <script>
tag, then using map.addControl
to add the control with MapboxGeocoder
defined in the options. The MapboxGeocoder
object uses the Mapbox Geocoding API to enable places search.
Search for a place like Moulin Rouge to test the geocoder control.
To explore how geocoding query parameters affect places search results, use the Search playground.
<!DOCTYPE html><html><head><meta charset="utf-8"><title>Add a geocoder</title><meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no"><link href="https://api.mapbox.com/mapbox-gl-js/v2.14.1/mapbox-gl.css" rel="stylesheet"><script src="https://api.mapbox.com/mapbox-gl-js/v2.14.1/mapbox-gl.js"></script><style>body { margin: 0; padding: 0; }#map { position: absolute; top: 0; bottom: 0; width: 100%; }</style></head><body><!-- Load the `mapbox-gl-geocoder` plugin. --><script src="https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-geocoder/v5.0.0/mapbox-gl-geocoder.min.js"></script><link rel="stylesheet" href="https://api.mapbox.com/mapbox-gl-js/plugins/mapbox-gl-geocoder/v5.0.0/mapbox-gl-geocoder.css" type="text/css"> <div id="map"></div> <script> // TO MAKE THE MAP APPEAR YOU MUST // ADD YOUR ACCESS TOKEN FROM // https://account.mapbox.com mapboxgl.accessToken = 'YOUR_MAPBOX_ACCESS_TOKEN';const map = new mapboxgl.Map({container: 'map',// Choose from Mapbox's core styles, or make your own style with Mapbox Studiostyle: 'mapbox://styles/mapbox/streets-v12',center: [-79.4512, 43.6568],zoom: 13}); // Add the control to the map.map.addControl(new MapboxGeocoder({accessToken: mapboxgl.accessToken,mapboxgl: mapboxgl}));</script> </body></html>