{"id":19725604,"url":"https://github.com/xdev-software/vaadin-maps-leaflet-flow","last_synced_at":"2025-05-09T00:07:42.218Z","repository":{"id":37890344,"uuid":"225889496","full_name":"xdev-software/vaadin-maps-leaflet-flow","owner":"xdev-software","description":"A Vaadin Flow Java API for Leaflet Maps 🗺️ Component (https://leafletjs.com/)","archived":false,"fork":false,"pushed_at":"2025-05-05T04:15:53.000Z","size":8410,"stargazers_count":42,"open_issues_count":4,"forks_count":19,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2025-05-09T00:07:33.295Z","etag":null,"topics":["leaflet","maps","vaadin","vaadin-addon"],"latest_commit_sha":null,"homepage":"https://vaadin.com/directory/component/leafletmap-for-vaadin","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xdev-software.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"Leaflet","open_collective":"leafletjs"}},"created_at":"2019-12-04T14:44:17.000Z","updated_at":"2025-05-06T19:57:30.000Z","dependencies_parsed_at":"2023-02-19T06:16:16.033Z","dependency_job_id":"311133fd-1153-4239-9532-9f2955438728","html_url":"https://github.com/xdev-software/vaadin-maps-leaflet-flow","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-maps-leaflet-flow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-maps-leaflet-flow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-maps-leaflet-flow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xdev-software%2Fvaadin-maps-leaflet-flow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xdev-software","download_url":"https://codeload.github.com/xdev-software/vaadin-maps-leaflet-flow/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253166520,"owners_count":21864482,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["leaflet","maps","vaadin","vaadin-addon"],"created_at":"2024-11-11T23:31:27.558Z","updated_at":"2025-05-09T00:07:42.185Z","avatar_url":"https://github.com/xdev-software.png","language":"Java","funding_links":["https://github.com/sponsors/Leaflet","https://opencollective.com/leafletjs"],"categories":[],"sub_categories":[],"readme":"[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/leafletmap-for-vaadin)\n[![Latest version](https://img.shields.io/maven-central/v/software.xdev/vaadin-maps-leaflet-flow?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/vaadin-maps-leaflet-flow)\n[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-maps-leaflet-flow/check-build.yml?branch=develop)](https://github.com/xdev-software/vaadin-maps-leaflet-flow/actions/workflows/check-build.yml?query=branch%3Adevelop)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_vaadin-maps-leaflet-flow\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_vaadin-maps-leaflet-flow)\n![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)\n\n# LeafletMap for Vaadin\nA Vaadin Flow Java API for [Leaflet](https://leafletjs.com/)\n\n![demo](assets/demo.png)\n\n## Usage\n\nThis API wraps the Leaflet API in a Vaadin friendly way.\u003cbr/\u003eIt uses a similar structure (classes, methods) as the [Leaflet JavaScript API](https://leafletjs.com/reference.html).\n\nTo get started it's recommended to have a look at the [demo](./vaadin-maps-leaflet-flow-demo), notably the [minimalistic example](./vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/MinimalisticDemo.java).\n\n\u003e [!NOTE]\n\u003e **The API only supports sending instructions to the client**\u003cbr/\u003e\n\u003e Due to data integrity retrieving client-side data (that can be modified by users) is not supported.\n\u003e \n\u003e Event listeners can still be registered but this needs to be done manually. An example is available [in the demo](./vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/EventDemo.java).\n\u003e \n\u003e \u003cdetails\u003e\u003csummary\u003eThe following code snippet is a simplification of an even more \u003ca href=\"./vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/ComplexDemo.java#L251\"\u003ecomplex example\u003c/a\u003e which sends (unvalidated!) client side data back to the server (click to expand)\u003c/summary\u003e\n\u003e\n\u003e ```java\n\u003e this.map.on(\"click\", \"e =\u003e document.getElementById('\" + ID + \"').$server.mapClicked(e.latlng.lat, e.latng.lng)\");\n\u003e ...\n\u003e @ClientCallable\n\u003e public void mapClicked(double lat, double lng)\n\u003e {\n\u003e   LOG.info(\"Map clicked - lat: {}, lng: {}\", lat, lng);\n\u003e }\n\u003e ```\n\u003e \u003c/details\u003e\n\n## Installation\n[Installation guide of the latest release](https://github.com/xdev-software/vaadin-maps-leaflet-flow/releases/latest#Installation)\n\n#### Static resources\nPlease note that Leaflet uses a few default icons for various components (e.g. Markers).\u003cbr/\u003e\nThese are also shipped with the library and can be found inside [``META-INF/resources``](./vaadin-maps-leaflet-flow/src/main/resources/META-INF/resources/).\u003cbr/\u003e\nYou might have to fine tune your security configuration to allow these.\n\n#### Compatibility with Vaadin\n| Vaadin version | vaadin-maps-leaflet-flow version |\n| --- | --- |\n| Vaadin 24+ (latest) | ``3+`` |\n\n### Spring-Boot\n* You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)\n\n## Run the Demo\n* Checkout the repo\n* Run ``mvn install \u0026\u0026 mvn -f vaadin-maps-leaflet-flow-demo spring-boot:run``\n* Open http://localhost:8080\n\n\u003cdetails\u003e\n  \u003csummary\u003eShow example\u003c/summary\u003e\n  \n  ![demo](assets/demo.avif)\n\u003c/details\u003e\n\n## Support\nIf you need support as soon as possible and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).\n\n## Contributing\nSee the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.\n\n## Dependencies and Licenses\nView the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/vaadin-maps-leaflet-flow/dependencies)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdev-software%2Fvaadin-maps-leaflet-flow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxdev-software%2Fvaadin-maps-leaflet-flow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxdev-software%2Fvaadin-maps-leaflet-flow/lists"}