You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+18-8Lines changed: 18 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,21 +18,29 @@
18
18
19
19
# MapTiler Geocoding control for MapTiler SDK, MapLibre GL JS, Leaflet and OpenLayers
20
20
21
+
## What ?
22
+
23
+
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/)).
24
+
21
25
## About
22
26
23
-
A _Geocoding control_ for [MapTiler SDK](https://github.com/maptiler/maptiler-sdk-js),
[Leaflet](https://leafletjs.com) and [OpenLayers](https://openlayers.org) utilizes [MapTiler Cloud Geocoding
26
-
API](https://www.maptiler.com/cloud/geocoding/). With this control, users of
27
-
mapping application can find any place on Earth (States, Cities, Streets, Addresses, POIs, ...) down
28
-
to the address level, restrict the search area to a specific country, highlight
29
-
searched results on the map, autocomplete words while typing, and much more.
27
+
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.
28
+
29
+
With this control, users of
30
+
mapping application can:
31
+
32
+
* Find any place on Earth (States, Cities, Streets, Addresses, POIs, ...) down
33
+
to the address level
34
+
* Restrict the search area to a specific country, bounding box, or proximity
35
+
* Highlight searched results on the map (marker or full geometry)
36
+
* Autocomplete words while typing
37
+
* 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.
30
38
31
39
The component can be used as an ES module or UMD module with or without bundler.
32
40
33
41
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).
34
42
35
-
## Quick start
43
+
## Install
36
44
37
45
Install the Geocoding control unsing `npm`:
38
46
@@ -46,6 +54,8 @@ If you are using a this library in a Svelte project you can npm install with `--
0 commit comments