The Leaflet instance for marker creation
Your personal access token, create your own on the Jawg Lab. This is filled automatically when you get the library with our CDN.
Option to show administrative area when available.
Set of options when you are looking for places in a particular region.
Add a clear cross in the right side of the input.
The custom <div> that will contain the input and geocoding results when Places JS is used as Leaflet Control.
By default this is generated by Jawg Places JS.
With some frameworks/UI libs such as React, you can't use the ref here.
Set the number of milliseconds to wait before a search validation.
If you press Enter the search will be immediately validated.
This option work only when searchOnTyping=true.
Default value is 350.
Sort results in part by their proximity to the given coordinate. Coordinates can be static or dynamic with the function.
The <input> to transform into a geocoding search bar.
This can be either a id (e.g #my-input), class selector (e.g .my-input) or the HTMLElement.
With some frameworks/UI libs such as React, you can't use the ref here.
Class to add to the input when it's generated by the library.
Return results in a specific language using BCP47 standard (e.g 'en', 'fr', 'de', ...). By default, we use HTTP Header set by the browser and English when not present. Language can be static or dynamic with the function.
Filter the kind of place you want to find. Layers can be static or dynamic with the function.
Option to configure result markers on the map.
Set the minimum number of characters to trigger a geocoding request.
If you press Enter the search will be validated even if the length is not reached.
This option work only when searchOnTyping=true.
Default value is 0.
Set a custom message when no results are found. This can be disabled.
Placeholder text to add when the input in generated by the library.
Position of the input on the map.
The custom <div> that will contain the geocoding results.
By default the container is created by Jawg Places JS.
With some frameworks/UI libs such as React, you can't use the ref here.
Option to activate reverse geocoding withing the input.
You can paste coordinates in the form {lat}/{lon} in the input.
The separation can be either / (slash), , (comma) or (space).
Set this to true to activate search on typing, this will also use autocomplete search.
Default value is false, you will need to press Enter to validate your search.
Show icon at the left each results.
Set the default number of results. Default value is 10.
Filter the originating source of the data. Sources can be static or dynamic with the function.
Option to configure transition on result selection.
Callback triggered when the input is empty.
Callback triggered when the user click on a result.
selected by the user
Callback triggered when the result list is closed/cleared.
Callback triggered when Jawg Places API returns an error.
Callback triggered when Jawg Places API returns without error.
list of features returned by Jawg Places API
Generated using TypeDoc
Options for JawgPlaces.Leaflet