Skip to content

CU-1131 update readme add related links #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 26, 2025
Merged

CU-1131 update readme add related links #97

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b4f9115
CU-1131 update readme add related links
bolollo Aug 18, 2025
0a2a6ca
CU-1131 Update sections titles
bolollo Aug 18, 2025
4a69eb8
CU-1131 Update title
bolollo Aug 18, 2025
e724b0b
CU-1131 add reverse geocoding
bolollo Aug 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,31 @@
<img src="https://img.shields.io/twitter/follow/maptiler?style=social"></img>
</p>

# MapTiler Geocoding control for MapTiler SDK, MapLibre GL JS, Leaflet and OpenLayers
# MapTiler Search and Geocoding control for MapTiler SDK, MapLibre GL JS, Leaflet and OpenLayers

## About
## What?

A _Geocoding control_ for [MapTiler SDK](https://github.com/maptiler/maptiler-sdk-js),
[MapLibre GL JS](https://github.com/maplibre/maplibre-gl-js),
[Leaflet](https://leafletjs.com) and [OpenLayers](https://openlayers.org) utilizes [MapTiler Cloud Geocoding
API](https://www.maptiler.com/cloud/geocoding/). 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 *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
* 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).

## Quick start
## Install

Install the Geocoding control unsing `npm`:

Expand All @@ -46,6 +54,8 @@ If you are using a this library in a Svelte project you can npm install with `--
npm install --save @maptiler/geocoding-control @maptiler/sdk
```

## Quick start

Use the component in your mapping application:

```js
Expand Down