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).
- Can configure which columns to export
- Other templates can be used besides the basic templates
- Optionally can create the export buttons automatically (default)
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.
- git clone repository
- mvn clean install jetty:run
To see the demo, navigate to http://localhost:8080/
See here
The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.
Contributions are welcome. There are two primary ways you can contribute: by reporting issues or by submitting code changes through pull requests. To ensure a smooth and effective process for everyone, please follow the guidelines below for the type of contribution you are making.
Creating an issue is a highly valuable contribution. If you've found a bug or have an idea for a new feature, this is the place to start.
- Before creating an issue, please check the existing issues to see if your topic is already being discussed.
- If not, create a new issue, choosing the right option: "Bug Report" or "Feature Request". Try to keep the scope minimal but as detailed as possible.
A Note on Bug Reports
Please complete all the requested fields to the best of your ability. Each piece of information, like the environment versions and a clear description, helps us understand the context of the issue.
While all details are important, the minimal, reproducible example is the most critical part of your report. It's essential because it removes ambiguity and allows our team to observe the problem firsthand, exactly as you are experiencing it.
As a first step, please refer to our Development Conventions page to find information about Conventional Commits & Code Style requirements.
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.
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.
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)
Apply this fix as mentioned in #15 to avoid the "Cannot load from short array because "sun.awt.FontConfiguration.head" is null error.
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.