Docs

Reference Guide

Build web applications in Java, with React views where you need them.

This guide documents the framework that you use to build the user interface of a Vaadin application. It describes each feature in full: its API, its configuration options, and how it behaves. For step-by-step instructions on common tasks, see Building Apps instead.

A Vaadin application builds its user interface from views of two kinds:

  • Flow views are written in Java, from UI components, and run on the server. Flow is the part of Vaadin that runs them, and most of this guide documents it.

  • React views are written in React and TypeScript, and run in the browser. They call Java code on the server through browser-callable services. See React Views.

Both kinds of views can be in the same application. To learn how each kind works, start with How Vaadin Works.

How Vaadin Works
How Flow views and React views run, and how they communicate with the server.
UI State
Using signals in Flow to manage UI state reactively in Vaadin applications.
Routing & Navigation
Explains routing, how URLs are mapped to views, and navigating applications.
Forms & Data Binding
Learn how to bind data to forms and selection components in Vaadin Flow.
Browser APIs
Server-side Java APIs for accessing browser and web-platform features.
Localization
Translate strings, switch languages, and localize numbers and dates.
Security
Reference for the security features of Vaadin Flow.
Testing
Vaadin provides browserless testing and end-to-end testing approaches for your applications.
React Views
Client-side views written in React and TypeScript, next to Flow views.
Integrations
List of various Java application technologies that may be integrated with Vaadin.
Configuration
Instructions on how to configure your application and development environment.
Deploying to Production
How to compile and package an application to deploy to a production server.
AI Integration
Vaadin provides UI interfaces and an AI orchestrator for building AI-powered UIs with Vaadin, handling streaming, history, attachments, and tool calling.
Component Internals
Technical reference for Vaadin's component architecture and client-server communication model. Covers properties, events, RPC, the Element API, and other low-level mechanisms used when building custom components.
Advanced Topics
A collection of miscellaneous important topics and features that you may need in Vaadin applications.
API Reference
Links to Application Programming Interface documentation.

Updated –