Merge pull request #278 from xdev-software/develop

Release 4.0.0

Author: AB-xdev

.github/workflows/release.yml

@@ -223,9 +223,12 @@ jobs:
         git push origin
     
     - name: pull-request
-      uses: repo-sync/pull-request@v2
-      with:
-        destination_branch: "develop"
-        pr_title: "Sync back"
-        pr_body: "An automated PR to sync changes back"
-
+      env:
+        GH_TOKEN: ${{ github.token }}
+      run: |
+        gh_pr_up() { 
+          gh pr create "$@" || gh pr edit "$@" 
+        }
+        gh_pr_up -B "develop" \
+          --title "Sync back" \
+          --body "An automated PR to sync changes back"

.github/workflows/update-from-template.yml

@@ -81,12 +81,14 @@ jobs:
           echo "abort=0" >> $GITHUB_OUTPUT
           
       - name: pull-request
-        uses: repo-sync/pull-request@v2
         if: steps.main.outputs.abort == 0
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          source_branch: ${{ env.UPDATE_BRANCH }}
-          destination_branch: ${{ steps.main.outputs.current_branch }}
-          pr_title: "Update from template"
-          pr_body: "An automated PR to sync changes from the template into this repo"
-          
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh_pr_up() { 
+            gh pr create "$@" || gh pr edit "$@" 
+          }
+          gh_pr_up -B "${{ steps.main.outputs.current_branch }}" \
+            -H "${{ env.UPDATE_BRANCH }}" \
+            --title "Update from template" \
+            --body "An automated PR to sync changes from the template into this repo"

CHANGELOG.md

@@ -1,3 +1,23 @@
+## 4.0.0
+⚠️<i>This release contains breaking changes</i>
+
+* The complete API got reworked and now has the [same structure as Leaflet](https://leafletjs.com/reference.html).
+* Added lots of new Leaflet APIs - currently around 90% of the Leaflet API are implemented. These include the most useful bits:
+  * GeoLocation
+  * A lot of new methods for Map
+  * Tooltips & Popups
+  * Image, Video and SVG-Overlays
+  * Rectangles
+  * Controls for Scale, Layers, ...
+  * and much more
+* Abstracted the elements similar to how this is done inside Leaflet itself so that they can easily be extended
+* The API only supports sending instructions to the client. Retrieving client side data is not supported as data integrity can't be guaranteed (client-side data can be modified by users).
+  * Event listeners can still be registered but this needs to be done manually. A example is available in the demo.
+* All Leaflet elements are now tracked on the client and on the server and can therefore be modified/reused (using ``LComponentManagementRegistry``).
+  * Before it was only possible to create an element and then send it to the client
+  * However keep in mind when creating a lot of elements that you may have to free up memory on the client (manually)
+* Integrated default Leaflet resources
+
 ## 3.0.2
 * Added support for Polyline #266 (thanks to @blitzdose)
 
@@ -7,6 +27,8 @@
   * Updated leaflet to [``1.9.4``](https://github.com/Leaflet/Leaflet/blob/b6b56f6e707142c177fad2f67827a5007e56736a/CHANGELOG.md#194-2023-05-18) #247
 
 ## 3.0.0
+⚠️<i>This release contains breaking changes</i>
+
 * Adds support for Vaadin 24+, drops support for Vaadin 23<br/>
   <i>If you are still using Vaadin 23, use the ``2.x`` versions.</i>
   * Requires Java 17+
@@ -29,6 +51,8 @@
   * Vaadin 23.2
 
 ## 2.0.0
+⚠️<i>This release contains breaking changes</i>
+
 * Update to Vaadin 23
   * Removed deprecated polymer-connector - replaced by ``executeJs``
 * Fixed a problem where the map was not rendered/aligned correctly

README.md

@@ -5,7 +5,10 @@
 ![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)
 
 # vaadin-maps-leaflet-flow
-Vaadin Flow Java API for [Leaflet Maps](https://leafletjs.com/) Component
+Vaadin Flow Java API for [Leaflet](https://leafletjs.com/)
+
+This API wraps the Leaflet API in a Vaadin friendly way.
+To get started it's recommended to have a look at the demo (notably at the [minimalistic example](./vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/MinimalisticDemo.java))
 
 ![demo](assets/demo.png)
 
@@ -31,7 +34,7 @@ Vaadin Flow Java API for [Leaflet Maps](https://leafletjs.com/) Component
 <details>
   <summary>Show example</summary>
 
-  ![demo](assets/demo.gif)
+  ![demo](assets/demo.avif)
 </details>
 
 ## Support

assets/demo.avif

@@ -6,7 +6,7 @@
 
 	<groupId>com.xdev-software</groupId>
 	<artifactId>vaadin-maps-leaflet-flow-root</artifactId>
-	<version>3.0.3-SNAPSHOT</version>
+	<version>4.0.0-SNAPSHOT</version>
 	<packaging>pom</packaging>
 
 	<organization>

assets/demo.gif

@@ -6,7 +6,7 @@
 
 	<groupId>com.xdev-software</groupId>
 	<artifactId>vaadin-maps-leaflet-flow-demo</artifactId>
-	<version>3.0.3-SNAPSHOT</version>
+	<version>4.0.0-SNAPSHOT</version>
 	<packaging>jar</packaging>
 
 	<inceptionYear>2019</inceptionYear>
@@ -26,9 +26,9 @@
 		<mainClass>software.xdev.vaadin.Application</mainClass>
 
 		<!-- Dependency-Versions -->
-		<vaadin.version>24.1.8</vaadin.version>
+		<vaadin.version>24.1.11</vaadin.version>
 
-		<org.springframework.boot.version>3.1.3</org.springframework.boot.version>
+		<org.springframework.boot.version>3.1.4</org.springframework.boot.version>
 	</properties>
 
 	<dependencyManagement>

assets/demo.png

@@ -0,0 +1,74 @@
+package software.xdev.vaadin.maps.leaflet.flow;
+
+import java.util.List;
+
+import com.vaadin.flow.component.AttachEvent;
+import com.vaadin.flow.component.Composite;
+import com.vaadin.flow.component.grid.Grid;
+import com.vaadin.flow.component.grid.GridVariant;
+import com.vaadin.flow.component.html.Anchor;
+import com.vaadin.flow.component.html.Span;
+import com.vaadin.flow.component.orderedlayout.VerticalLayout;
+import com.vaadin.flow.data.renderer.ComponentRenderer;
+import com.vaadin.flow.router.PageTitle;
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.maps.leaflet.flow.demo.ComplexDemo;
+import software.xdev.vaadin.maps.leaflet.flow.demo.FreeingUpResourceBenchmarkDemo;
+import software.xdev.vaadin.maps.leaflet.flow.demo.MinimalisticDemo;
+
+
+@PageTitle("Leaflet + Vaadin demos")
+@Route("")
+public class DemoView extends Composite<VerticalLayout>
+{
+	private final Grid<Example> grExamples = new Grid<>();
+	
+	public DemoView()
+	{
+		this.grExamples
+			.addColumn(new ComponentRenderer<>(example -> {
+				final Anchor anchor = new Anchor(example.route(), example.name());
+				
+				final Span spDesc = new Span(example.desc());
+				spDesc.getStyle().set("font-size", "90%");
+				
+				final VerticalLayout vl = new VerticalLayout(anchor, spDesc);
+				vl.setSpacing(false);
+				return vl;
+			}))
+			.setHeader("Available demos");
+		
+		this.grExamples.setSizeFull();
+		this.grExamples.addThemeVariants(GridVariant.LUMO_COMPACT, GridVariant.LUMO_NO_BORDER);
+		
+		this.getContent().add(this.grExamples);
+		this.getContent().setHeightFull();
+	}
+	
+	@Override
+	protected void onAttach(final AttachEvent attachEvent)
+	{
+		this.grExamples.setItems(List.of(
+			new Example(
+				MinimalisticDemo.NAV,
+				"Minimalistic",
+				"Showcasing the simplest form of using the API"
+			),
+			new Example(
+				ComplexDemo.NAV,
+				"Complex",
+				"A complex example with various leaflet components and methods"
+			),
+			new Example(
+				FreeingUpResourceBenchmarkDemo.NAV,
+				"Freeing up resources Benchmark",
+				"Benchmark for showcasing how resources a freed up when handling huge amounts of components"
+			)
+		));
+	}
+	
+	record Example(String route, String name, String desc)
+	{
+	}
+}