LeafletMap for Vaadin

A Vaadin Flow Java API for Leaflet

Usage

This API wraps the Leaflet API in a Vaadin friendly way.
It uses a similar structure (classes, methods) as the Leaflet JavaScript API.

To get started it's recommended to have a look at the demo, notably the minimalistic example.

Note

The API only supports sending instructions to the client
Due to data integrity retrieving client-side data (that can be modified by users) is not supported.

Event listeners can still be registered but this needs to be done manually. An example is available in the demo.

The following code snippet is a simplification of an even more complex example which sends (unvalidated!) client side data back to the server (click to expand)

this.map.on("click", "e => document.getElementById('" + ID + "').$server.mapClicked(e.latlng.lat, e.latng.lng)");
...
@ClientCallable
public void mapClicked(double lat, double lng)
{
  LOG.info("Map clicked - lat: {}, lng: {}", lat, lng);
}

Installation

Installation guide of the latest release

Static resources

Please note that Leaflet uses a few default icons for various components (e.g. Markers).
These are also shipped with the library and can be found inside META-INF/resources.
You might have to fine tune your security configuration to allow these.

Compatibility with Vaadin

Vaadin version	vaadin-maps-leaflet-flow version
Vaadin 24+ (latest)	3+

Spring-Boot

• You may have to include software/xdev inside vaadin.allowed-packages

Run the Demo

• Checkout the repo
• Run mvn install && mvn -f vaadin-maps-leaflet-flow-demo spring-boot:run
• Open http://localhost:8080

Show example

Support

If you need support as soon as possible and you can't wait for any pull request, feel free to use our support.

Contributing

See the contributing guide for detailed instructions on how to get started with our project.

Dependencies and Licenses

View the license of the current project or the summary including all dependencies