Merge branch 'develop' into update-from-template-merged

Author: xdev-gh-bot

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -15,9 +15,9 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/template-placeholder/releases/latest)"
+        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/vaadin-chartjs-wrapper/releases/latest)"
           required: true
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-chartjs-wrapper/issues) or [closed](https://github.com/xdev-software/vaadin-chartjs-wrapper/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -13,7 +13,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-chartjs-wrapper/issues) or [closed](https://github.com/xdev-software/vaadin-chartjs-wrapper/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -12,7 +12,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-chartjs-wrapper/issues) or [closed](https://github.com/xdev-software/vaadin-chartjs-wrapper/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
           required: true

.run/Run Demo.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run Demo" type="Application" factoryName="Application">
     <option name="MAIN_CLASS_NAME" value="software.xdev.vaadin.Application" />
-    <module name="template-placeholder-demo" />
+    <module name="vaadin-chartjs-wrapper-demo" />
     <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
     <extension name="coverage">
       <pattern>

CHANGELOG.md

@@ -0,0 +1,5 @@
+# 1.0.0
+_Initial stable release_
+
+# 0.x
+_Initial preview release for evaluation_

CONTRIBUTING.md

@@ -47,10 +47,10 @@ Bigger changes may require a complete restart.
   * [Vaadin automatically reloads the UI on each restart](https://vaadin.com/docs/latest/configuration/live-reload/spring-boot).<br/>
   You can control this behavior with the ``vaadin.devmode.liveReload.enabled`` property (default: ``true``).
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/release.yml?branch=master)](https://github.com/xdev-software/template-placeholder/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-chartjs-wrapper/release.yml?branch=master)](https://github.com/xdev-software/vaadin-chartjs-wrapper/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/template-placeholder/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/vaadin-chartjs-wrapper/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes

README.md

@@ -1,23 +1,108 @@
-[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/template-placeholder)
-[![Latest version](https://img.shields.io/maven-central/v/software.xdev/template-placeholder?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/template-placeholder)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/check-build.yml?branch=develop)](https://github.com/xdev-software/template-placeholder/actions/workflows/check-build.yml?query=branch%3Adevelop)
+[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/chartjs-wrapper-for-vaadin)
+[![Latest version](https://img.shields.io/maven-central/v/software.xdev/vaadin-chartjs-wrapper?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/vaadin-chartjs-wrapper)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-chartjs-wrapper/check-build.yml?branch=develop)](https://github.com/xdev-software/vaadin-chartjs-wrapper/actions/workflows/check-build.yml?query=branch%3Adevelop)
 ![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)
 
-# template-placeholder
-A Vaadin Template Repo
+# <img src="https://www.chartjs.org/media/logo.svg" height="38" /> Chart.js Wrapper for Vaadin
+
+A [Chart.js](https://www.chartjs.org/) 4+ Wrapper for Vaadin
 
 ![demo](assets/demo.png)
 
+## Usage
+
+For more and detailed usage examples please have a look at [the demo](./vaadin-chartjs-wrapper-demo/src/main/java/software/xdev/vaadin/chartjs/demo/).
+
+### Minimal
+
+```java
+// Assumes that this code is in some kind of Vaadin component or view
+ChartContainer chart = new ChartContainer();
+this.add(chart);
+
+chart.showChart(
+  "{\"data\":{\"labels\":[\"A\",\"B\"],\"datasets\":[{\"data\":[1,2],\"label\":\"X\"}]},\"type\":\"bar\"}");
+
+// Or utilizing chartjs-java-model
+chart.showChart(new BarChart(new BarData()
+  .addLabels("A", "B")
+  .addDataset(new BarDataset()
+    .setLabel("X")
+    .addData(1)
+    .addData(2)))
+  .toJson());
+```
+
+### Recommended
+
+1. Use a Java model of Java model of Chart.js's configuration, like [XDEV's chartjs-java-model](https://github.com/xdev-software/chartjs-java-model).<br/>
+Otherwise you have to write the JSON yourself.
+2. Optionally derive classes for your charts (from e.g. ``ChartContainer``) that also handle the data-to-JSON conversion logic.<br/>
+Therefore you can encapsulate the components properly, for example like this: ``FetchFromBackendService.class → Model for chart → ChartContainer.class → Build JSON and show chart``
+
+<details><summary>Here is a example how the code could look (click to expand)</summary>
+
+1. Define a custom chart or use the ``showChart``-method directly.<br/>Example:
+    ```java
+    public class ExampleChartContainer extends ChartContainer
+    {
+      public void show(Data data)
+      {
+        BarData data = ...; // Build the bar chart data from the handed over data
+        this.showChart(new BarChart(data)
+          .setOptions(new BarOptions()
+            .setResponsive(true)
+            .setMaintainAspectRatio(false)
+            .setPlugins(new Plugins()
+              .setTitle(new Title()
+                .setText("Age")
+                .setDisplay(true))))
+          .toJson());
+      }
+    }
+    ```
+2. Add the chart to your view/component:
+    ```java
+    public class ExampleView extends VerticalLayout
+    {
+      private final ExampleChartContainer chart = new ExampleChartContainer();
+      
+      public ExampleView()
+      {
+        this.add(this.chart);
+        // ...
+      }
+      
+      private void loadDataAndShowChart()
+      {
+        this.chart.showLoading();
+        
+        UI ui = UI.getCurrent();
+        CompletableFuture.runAsync(() -> {
+          try {
+            var data = ...; // Load some data from the backend
+            // You may also convert the data here and call showChart
+            ui.access(() -> this.chart.show(data));
+          } catch (Exception ex) {
+            // Display the error message when loading fails
+            ui.access(() -> this.chart.showFailed(ex.getMessage()));
+          }
+        });
+      }	
+    }
+    ```
+
+</details>
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/template-placeholder/releases/latest#Installation)
+[Installation guide for the latest release](https://github.com/xdev-software/vaadin-chartjs-wrapper/releases/latest#Installation)
 
 ### Spring-Boot
 * You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)
 
 ## Run the Demo
 * Checkout the repo
-* Run ``mvn install && mvn -f template-placeholder-demo spring-boot:run``
+* Run ``mvn install && mvn -f vaadin-chartjs-wrapper-demo spring-boot:run``
 * Open http://localhost:8080
 
 <details>
@@ -33,4 +118,6 @@ If you need support as soon as possible and you can't wait for any pull request,
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
-View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/template-placeholder/dependencies)
+View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/vaadin-chartjs-wrapper/dependencies)
+
+<sub>Disclaimer: This is not an official Chart.js product and not associated</sub>

SECURITY.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/template-placeholder/security/advisories/new).
+Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/vaadin-chartjs-wrapper/security/advisories/new).