Vaadin Flow component that automatically generates a fully functional form from a Java POJO definition, using reflection and Bean Validation (JSR-380) annotations. All customization is programmatic through a fluent Java API — the POJO stays clean.
- Automatic field discovery from POJO properties (getter/setter conventions)
- Type-to-component mapping with sensible Vaadin defaults, overridable globally, per form, or per property
- Automatic data binding and Bean Validation (
@NotNull,@Size,@Email,@Min,@Max, ...) - Fluent per-field API: labels, placeholders, helper texts, validators, converters, custom components
- Field states: visible, read-only, or hidden
- Configurable save/cancel button bar with support for extra buttons
- Responsive multi-column layout with per-field column spanning
Add the following dependencies in your pom.xml file:
<dependency>
<groupId>com.flowingcode.vaadin.addons</groupId>
<artifactId>easy-form-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, 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 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.
Easy Form Add-on is written by Flowing Code S.A.
// Minimal usage — three lines to a working form
EasyForm<Person> form = new EasyForm<>(Person.class);
form.setSaveAction(person -> personService.save(person));
add(form);Customization is done through a fluent API:
EasyForm<Person> form = new EasyForm<>(Person.class);
// Field order (unlisted fields follow, in declaration order)
form.setFieldOrder("firstName", "lastName", "email", "birthDate");
// Field selection (everything not listed is excluded from the layout and the binding)
form.setVisibleFields("firstName", "lastName", "email", "birthDate");
// Or per field
form.configureField("internalCode").excluded();
// Field-level customization (configureField returns the wrapper, field the component)
form.configureField("email").withLabel("Email Address").asRequired("Email is required");
form.configureField("notes").withComponent(new TextArea()).withColSpan(2);
// Events — enable a save button only while the form is valid and dirty
form.addStatusChangeListener(event ->
form.getSaveButton().setEnabled(!event.hasValidationErrors() && event.getBinder().hasChanges()));
// Layout
form.setResponsiveSteps(new ResponsiveStep("0", 1), new ResponsiveStep("600px", 2));
// Button bar
form.setSaveAction(person -> personService.save(person));
form.setCancelAction(() -> navigateBack());
// Pre-populate for editing
form.setBean(existingPerson);By default, Vaadin Flow only includes com/vaadin/flow/component to be always scanned for UI components and views. For this reason, the add-on 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.