The Javascript & TypeScript Map Control component for MapTiler Geocoding service! Easy to be integrated into any JavaScript mapping application.
A Geocoding control for MapTiler SDK, MapLibre GL JS and Leaflet utilizes MapTiler Cloud Geocoding API. With this control, users of mapping application can find any place on Earth (States, Cities, Streets, Addresses, POIs, ...) down to the address level, restrict the search area to a specific country, highlight searched results on the map, autocomplete words while typing, and much more.
The component can be used as an ES module or UMD module with or without bundler.
Geocoding control is also provided as React component and Svelte component and other libraries.
Install the Geocoding control unsing npm
:
npm install --save @maptiler/geocoding-control @maptiler/sdk
Use the component in your mapping application:
import * as maptilersdk from "@maptiler/sdk";
import { GeocodingControl } from "@maptiler/geocoding-control/maptilersdk";
import "@maptiler/sdk/dist/maptiler-sdk.css";
import "@maptiler/geocoding-control/style.css";
maptilersdk.config.apiKey = "YOUR_MAPTILER_API_KEY_HERE";
const map = new maptilersdk.Map({
container: "map", // id of HTML container element
});
const gc = new GeocodingControl();
map.addControl(gc);
NOTE: Get your personal MapTiler API key in the MapTiler Cloud.
- With MapTiler SDK
- With MapLibre GL
- With Leaflet
- With OpenLayers
- As a React component
- As Svelte component
- As vanilla JavaScript module
In addition to the details and examples provided in this README.md
and our documentation, check out
- The complete Geocoding service API documentation
- The complete Geocoding control reference
- UMD global variables
npm install && npm run build
You will find compilation result in the dist
directory.
npm install && VITE_API_KEY=YOUR_MAPTILER_API_KEY_HERE npm run dev
POI icons are served from CDN per default. If there is an requirement to serve them from a different location and the control is used in the application which is build with Web Application bundler (like Webpack or Vite) then it is necessary to do some extra configuration. Icons are bundled in the library and you can find them in node_modules/@maptiler/geocoding-control/icons
. Configure your bundler and/or provide iconsBaseUrl
option for the icons to be properly resolved. You can also copy icons from that directory to your public
directory.