https://github.com/maptiler/maptiler-geocoding-control
The Javascript & TypeScript Map Control component for MapTiler Geocoding service! Easy to be integrated into any JavaScript mapping application.
https://github.com/maptiler/maptiler-geocoding-control
esm geocoding geocoding-api javascript leaflet leaflet-plugin leaflet-plugins leafletjs maplibre maplibre-gl-js maplibre-plugins maptiler maptiler-sdk-plugin openlayers openlayers-plugins react reactjs svelte umd
Last synced: 14 days ago
JSON representation
The Javascript & TypeScript Map Control component for MapTiler Geocoding service! Easy to be integrated into any JavaScript mapping application.
- Host: GitHub
- URL: https://github.com/maptiler/maptiler-geocoding-control
- Owner: maptiler
- License: bsd-3-clause
- Created: 2022-09-30T13:33:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-13T18:11:58.000Z (about 1 year ago)
- Last Synced: 2025-03-29T15:10:17.293Z (about 1 year ago)
- Topics: esm, geocoding, geocoding-api, javascript, leaflet, leaflet-plugin, leaflet-plugins, leafletjs, maplibre, maplibre-gl-js, maplibre-plugins, maptiler, maptiler-sdk-plugin, openlayers, openlayers-plugins, react, reactjs, svelte, umd
- Language: TypeScript
- Homepage: https://maptiler.com/cloud/geocoding
- Size: 1.09 MB
- Stars: 44
- Watchers: 10
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-maplibre - maptiler-geocoding-control - Adds a geocoding control for searching for places using MapTiler API. [docs](https://docs.maptiler.com/sdk-js/modules/geocoding/) (Geocoding & Search Plugins / JavaScript)
README
The Javascript & TypeScript Map Control component for MapTiler Geocoding service! Easy to be integrated into any JavaScript mapping application.
# MapTiler Search and Geocoding control for MapTiler SDK, MapLibre GL JS, Leaflet and OpenLayers
## What?
The _MapTiler Geocoding control_ implements a powerful search box in your maps or online forms, enabling your application users to find any place on Earth down to individual addresses. Use the search box control with [MapTiler SDK JS](https://docs.maptiler.com/sdk-js/) (or other map libraries like [Leaflet](https://docs.maptiler.com/leaflet/), [MapLibre GL JS](https://github.com/maplibre/maplibre-gl-js), [OpenLayers](https://docs.maptiler.com/openlayers/)).
## Why?
The _Geocoding control_ uses the [MapTiler Geocoding API](https://www.maptiler.com/cloud/geocoding/). You can use the API directly from your web or backend applications or use the [API Client JS](https://docs.maptiler.com/client-js/) library.
With this control, users of
mapping application can:
- Find any place on Earth (States, Cities, Streets, Addresses, POIs, ...) down
to the address level
- Find and identify objects or place names using a coordinate pair or a single mouse click (reverse geocoding)
- Restrict the search area to a specific country, bounding box, or proximity
- Highlight searched results on the map (marker or full geometry)
- Autocomplete words while typing
- and much more. Check out the [Geocoding Control API reference](https://docs.maptiler.com/sdk-js/modules/geocoding/api/api-reference/#options) to see all the options.
The component can be used as an ES module or UMD module with or without bundler.
Geocoding control is also provided as [React component](https://docs.maptiler.com/sdk-js/modules/geocoding/api/usage/react/) and [Svelte component](https://docs.maptiler.com/sdk-js/modules/geocoding/api/usage/svelte/) and [other libraries](#installation-and-more-usage-examples).
## Install
Install the Geocoding control unsing `npm`:
**⚠️ Warning! ⚠️**
The current version of Geocoding Control is only compatible with Svelte v4, this will potentially cause peer dependency issues when installing with certain versions of npm in Svelte projects (eg if you're using Svelte v5), or if you intend to import the Svelte component directly.
If you are using a this library in a Svelte project you can npm install with `--force` or `--legacy-peer-deps` and use only the **pre-compiled `GeoLocatControl` vanilla module**, not the Svelte component.
```shell
npm install --save @maptiler/geocoding-control @maptiler/sdk
```
## Quick start
Use the component in your mapping application:
```js
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](https://docs.maptiler.com/cloud/api/authentication-key/) in the [MapTiler Cloud](https://cloud.maptiler.com).
## Installation and more usage examples
- [With MapTiler SDK](https://docs.maptiler.com/sdk-js/modules/geocoding/api/usage/sdk-js/)
- [With MapLibre GL](https://docs.maptiler.com/sdk-js/modules/geocoding/api/usage/maplibre-gl-js/)
- [With Leaflet](https://docs.maptiler.com/sdk-js/modules/geocoding/api/usage/leaflet/)
- [With OpenLayers](https://docs.maptiler.com/sdk-js/modules/geocoding/api/usage/openlayers/)
- [As a React component](https://docs.maptiler.com/sdk-js/modules/geocoding/api/usage/react/)
- [As Svelte component](https://docs.maptiler.com/sdk-js/modules/geocoding/api/usage/svelte/)
- [As vanilla JavaScript module](https://docs.maptiler.com/sdk-js/modules/geocoding/api/usage/vanilla-js/)
## API Documentation
In addition to the details and examples provided in this `README.md` and our documentation, check out
- [The complete Geocoding service API documentation](https://docs.maptiler.com/cloud/api/geocoding/)
- [The complete Geocoding control reference](https://docs.maptiler.com/sdk-js/modules/geocoding/api/api-reference/)
- [UMD global variables](https://docs.maptiler.com/sdk-js/modules/geocoding/#umd-global-variables)
## Development
### Building
```bash
npm install && npm run build
```
You will find compilation result in the `dist` directory.
### Running in dev mode
```bash
npm install && VITE_API_KEY=YOUR_MAPTILER_API_KEY_HERE npm run dev
```
### POI icons and bundlers
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 built 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.
