Vaadin Cheat Sheet
|
This section documents the current Vaadin release line — Vaadin 24 LTS / 25.x, Java 17+, Spring Boot 3 / Jakarta EE 10 — as published at the official Vaadin documentation, which is the reference these pages are written and verified against. No specific patch version is pinned. Flow (server-side Java) is the authoring style used throughout, with Hilla / React shown where it differs; Vaadin 7 and the pre-Flow architecture appear only as migration contrast. This content was generated with the assistance of AI and should be verified against the official documentation before being relied on in production, since Vaadin ships major releases roughly twice a year and its ecosystem iterates. This section’s bibliography lists the reference material consulted while preparing these pages. |
A single-page, colour-coded summary of the Vaadin essentials — creating a project and the minimal @Route
view, the layouts, the input fields and the HasValue contract, Binder with converters and validators, the
Grid and its in-memory versus lazy data sources, routing and the navigation lifecycle, the overlay
components, server push with @Push and UI.access(…), the Element API, Lumo theming, the Spring bean
scopes, the security annotations, a Hilla endpoint one-liner, the production build, and a short Vaadin 7 to
Flow migration map — handy for quick memorization or as a printable desk reference.
For the full explanation, every option, and additional examples, see the dedicated pages:
Fundamentals — Getting Started, Architecture, Components Overview, and Layouts.
Input, forms and data — Input Components, Data Binding, The Grid Component, and Forms, CRUD and Master-Detail.
Navigation and interaction — Routing and Navigation, Interaction and Overlays, and Server Push.
Client side and extensibility — The Element API and Web Components, Building Custom Components, and Hilla and React Views.
Styling and design — Theming and Styling and Responsive Design and PWA.
Integration and backend — Spring Boot Integration, Jakarta EE and CDI, Data Persistence, and REST and Services.
Security — Security.
Quality and delivery — Testing, Production and Deployment, and Configuration and Dev Tools.
Advanced — Advanced Topics.
UI component libraries — UI Component Libraries.
The official Vaadin documentation and Quick Start cover the same ground in full, the API / Javadoc has every class, and the Vaadin Cookbook is the fastest way to find a worked snippet.