Grid Exporter Add-on

This is an addon that allows to export Vaadin's grid data to some formats like Excel, Docx, PDF and CSV. It works with Apache POI 5.2.2, but it works partially (docx and pdf won't work) with older versions (for using an older versions you need to exclude the apache poi transitive dependencies from this projects and add them with the explicit version that you want to use).

Features

Can configure which columns to export
Other templates can be used besides the basic templates
Optionally can create the export buttons automatically (default)

Online demo

Online demo here

Download release

Available in Vaadin Directory

Maven install

Add the following dependencies in your pom.xml file:

<dependency>
   <groupId>org.vaadin.addons.flowingcode</groupId>
   <artifactId>grid-exporter-addon</artifactId>
   <version>X.Y.Z</version>
</dependency>

<repository>
   <id>vaadin-addons</id>
   <url>https://maven.vaadin.com/vaadin-addons</url>
</repository>

For SNAPSHOT versions see here.

Building and running demo

git clone repository
mvn clean install jetty:run

To see the demo, navigate to http://localhost:8080/

Release notes

See here

Issue tracking

The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.

Contributions

Contributions are welcome, but there are no guarantees that they are accepted as such.

As first step, please refer to our Development Conventions page to find information about Conventional Commits & Code Style requeriments.

Then, follow these steps for creating a contribution:

Fork this project.
Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
For commit message, use Conventional Commits to describe your change.
Send a pull request for the original project.
Comment on the original issue that you have implemented a fix for it.

License & Author

This add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.

Grid Exporter Addon is written by Flowing Code S.A.

Developer Guide

After creating a grid, the method createFor can be used to create the exporter that then can be configured. It is important that the grid should always be completely configured (headers, footers, etc.), before creating the exporter, because if not, it will not work properly. Another important consideration is to create the exporter before attaching the grid, creating the grid exporter after the grid is attached will raise an exception (see this issue)

GridExporter<Person> exporter = GridExporter.createFor(grid, "/custom-template.xlsx", "/custom-template.docx");
HashMap<String,String> placeholders = new HashMap<>();
placeholders.put("${date}", new SimpleDateFormat().format(Calendar.getInstance().getTime()));
exporter.setExportColumn(nameColumn, false);
exporter.setExportColumn(lastNameColumn, true);
exporter.setAdditionalPlaceHolders(placeholders);
exporter.setSheetNumber(1);
exporter.setCsvExportEnabled(false);
exporter.setNumberColumnFormat(budgetColumn, "$#,###.##", "$#,###.##");
exporter.setDateColumnFormat(dateColumn1, "dd/MM/yyyy");
exporter.setTitle("People information");
exporter.setFileName("GridExport" + new SimpleDateFormat("yyyyddMM").format(Calendar.getInstance().getTime()));

Custom templates can be added anywhere in the classpath (ie: src/main/resources)

Note when deploying with docker using Alpine images

Apply this fix as mentioned in #15 to avoid the "Cannot load from short array because "sun.awt.FontConfiguration.head" is null error.

Special configuration when using Spring

By default, Vaadin Flow only includes com/vaadin/flow/component to be always scanned for UI components and views. For this reason, the addon might need to be whitelisted in order to display correctly.

To do so, just add com.flowingcode to the vaadin.whitelisted-packages property in src/main/resources/application.properties, like:

vaadin.whitelisted-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode

More information on Spring whitelisted configuration here.

FlowingCode / GridExporterAddon

readme