github vaadin/platform 15.0.0
Vaadin 15.0.0

latest releases: 24.4.0.beta1, 24.4.0.alpha25, 23.3.34...
4 years ago

Vaadin 15.0.0

Vaadin consists of a set of web components, a Java web framework, configurable themes, tools and a set of app starters.

Visit vaadin.com to get started.

New and Noteworthy

Here are the highlighted new and improved features in Vaadin 15. To see the full list of bug fixes and improvements, check Included Projects and Change Log.

Vaadin for TypeScript

In Vaadin 15 we introduce Vaadin for TypeScript as an alternative to Java;
When creating applications with Vaadin, developers can choose to write client-side code in TypeScript so that they can stay close to the target platform (the browser), it is easy to use any of the native Web platform features directly (including Service Workers and offline support), and the code is automatically type-checked. Vaadin 15 also provides a type-safe and secure way to access data from backend. See quick start guide from vaadin.com
Note: Using endpoints requires Spring Boot.

Client-side Router

Vaadin 15 includes Vaadin Router, the client-side router for Web Components.Vaadin Router is in use by default for all apps. See more from vaadin.com.

Faster and more reliable frontend dependency management by using pnpm

Faster and more reliable builds when updating the platform version. Biggest effect is when there are frontend dependency changes and when multiple projects/modules are updated. Vaadin 15 has npm in use by default and pnpm can be taken into use optionally. See instructions from vaadin.com.

Support

Vaadin 15 is supported for one month after Vaadin 16 has been released. The latest LTS (long term support) version is Vaadin 14. More details of our release model are available on our roadmap page.

Vaadin also provides commercial support and warranty.

Included Projects and Change Log

Vaadin includes the following projects. Release notes with detailed change logs for each project are linked below.

Java Web Framework

Projects marked as (Pro) are available for users with Pro or Prime subscriptions. Everything else is free and open source.

Components

Themes

  • Vaadin Lumo theme (v1.5.0)
  • Vaadin Material theme (v1.2.3).

Router

Tools

Getting Started with Vaadin

App starters

The best way to get started with Vaadin is to go to https://vaadin.com/start and pick an app template for the technology stack you’re interested in.

Manually changing Vaadin version for Java projects

Add the following contents to your project pom.xml.

<dependencyManagement>
    ...
    <dependency>
        <groupId>com.vaadin</groupId>
        <artifactId>vaadin-bom</artifactId>
        <version>15.0.0</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>
    ...
</dependencyManagement>

Read more about upgrading to Vaadin 15 from vaadin.com.

Note: Vaadin 15 is compatible with Spring 5.2.0 or newer, and Spring Boot 2.2.0 or newer. See more info from vaadin.com.

Supported Technologies

Operating Systems

Development is supported with the following operating systems:

  • Windows
  • Linux
  • macOS

Desktop Browsers

  • Evergreen versions of the following browsers on :
    • Chrome on these operating systems:
      • Windows 7, Windows 8.1, Windows 10 or later
      • macOS 10.9 (OS X Mavericks) or later
      • 64-bit Ubuntu 14.04+, Debian 8+, openSUSE 13.3+, or Fedora Linux 24+
    • Firefox on these operating systems
      • Windows 7, Windows 8.1, Windows 10 or later
      • macOS 10.9 (OS X Mavericks) or later
      • Any Linux with the following packages:
        • GTK+ 3.4 or higher
        • GLib 2.22 or higher
        • Pango 1.14 or higher
        • X.Org 1.0 or higher (1.7 or higher is recommended)
        • libstdc++ 4.6.1 or higher
      • Latest Firefox ESR is supported (starting from Firefox ESR 68)
    • Safari on macOS 10.15 or later (starting from Safari 13, available also for macOS 10.14.5 and 10.13.6)
    • Edge on Windows 10 or later. Note: Vaadin 15 supports only Edge Chromium and does not provide support for EdgeHTML.

Mobile Browsers

The following built-in browsers in the following mobile operating systems:

  • Safari starting from iOS 13
  • Google Chrome evergreen on Android (requiring Android 4.4 or newer)

Development environments

Any IDE or editor that works with the language of your choice should work well. Our teams often use Eclipse, IntelliJ and Visual Studio Code among others (including Emacs and Vim).

Vaadin Designer supports the following IDEs:

  • Eclipse Java EE versions: Photon, 2018 and 2019.
  • JetBrains IntelliJ IDEA 2017, 2018 and 2019. Community or Ultimate edition.

Java

Vaadin supports version 8 and 11 of any JDK or JREs. More about Java support in FAQ.

Application Servers

Vaadin Flow requires Java Servlet API 3.1 (JSR-340) or newer. It is tested on:

  • Apache Tomcat 8.0.x, 8.5, 9
  • Apache TomEE 7.0.4->
  • Oracle WebLogic Server 12.2.1
  • IBM WebSphere Application Server 8.5 Liberty Profile and 9
  • RedHat JBoss EAP 7
  • WildFly 14, 15, 16
  • Jetty 9.4
  • Payara Server
  • Payara Micro

Supported Node.js and npm versions

Node.js version 10.x for the npm mode.

Breaking changes

Breaking Changes in Flow 3.0.0:

  • The list of supported browsers is updated to match the next LTS target (IE11, Safari 12 and older, Edge 18 and older are no longer supported)
  • The APIs deprecated in Flow 2.x are removed
    • Property synchronization methods in Element are replaced with similar API in DomListenerRegistration: getSynchronizedPropertyEvents, getSynchronizedProperties, removeSynchronizedPropertyEvent, removeSynchronizedProperty, addSynchronizedPropertyEvent, addSynchronizedProperty, synchronizeProperty.
    • JavaScript execution APIs executeJavaScript and callFunction in Element and Page are replaced with similarly named methods that give access to the return value executeJs and callJsFunction:
    • Miscellaneous Element methods: Element(String, boolean), addEventListener(String, DomEventListener, String...)
    • Device and platform detection methods WebBrowser#isIOS(), WebBrowser#isIPad(), BrowserDetails#isSafariOrIOS(), BrowserDetails#isIOS(), BrowserDetails#isIPad() are replaced with method in ExtendedClientDetails: isIPad(), isIOS()
    • Methods JsModule#loadMode() and Page#addJsModule(String, LoadMode) for setting the load mode of JsModule are removed since it does not function with JavaScript modules.
    • The construction methods BeforeEvent(NavigationEvent, Class<?>) and BeforeEvent(Router, NavigationTrigger, Location, Class<?>, UI) in BeforeEvent are replaced with BeforeEvent(NavigationEvent, Class, List) and BeforeEvent(Router, NavigationTrigger, Location, Class, UI, List)
    • Methods getUrl(), getUrlBase() and getRoutes() in Router are replaced with methods getUrl(), getUrlBase() and getAvailableRoutes() in RouterConfiguration. The resolve() method in Router is replaced with the resolve() method in RouteUtil. The getRoutesByParent() method in Router is removed and has no replacement.
    • ServletHelper is replaced with HandlerHelper
    • ExecutionCanceler is replaced with PendingJavaScriptResult
    • The getBodyAttributes method in AbstractTheme, Lumo and Material is replaced with getHtmlAttributes
    • The removeDataGenerator method in HasDataGenerators and CompositeDataGenerator is removed in favor of using the registration returned from addDataGenerator(DataGenerator)
    • The methods preventsDefault and stopsPropagation in ShortcutRegistration are replaced with isBrowserDefaultAllowed and isEventPropagationAllowed
    • The safeEscapeForHtml method in VaadinServlet is removed in favor of using org.jsoup.nodes.Entities#escape(String)
    • The static method getInstance in ApplicationRouteRegistry is removed in favor of the instance method.
    • The protected instance method getApplicationUrl from VaadinServlet is removed

Bower support dropped

Bower (compatibility mode) support has been dropped from Vaadin 15. Bower (compatibility mode) and WebJars are still fully supported in Vaadin 14 (LTS).

Known Issues and Limitations

Flow

  • The Template-in-Template feature has some limitations
  • Links matching the context do not result in browser page load by default, instead they are handled with application routing. To opt-out, set the router-ignore attribute on the anchor element. This opt-out is needed for cases when native browser navigation is necessary, e. g., when using Anchor to link a StreamResource download.

Known limitations in 3.0.0 (to be fixed in 3.0.x)

  • When using the Vaadin Multiplatform Runtime navigation from Vaadin 15 to Vaadin 7/8 views is broken
  • The BeforeEnter.rerouteTo() Java API cannot re-route to TypeScript views
  • The pnpm mode works only when the usage statistics collection is enabled
  • Links to StreamResources require an extra router-ignore attribute to work

Vaadin Gradle Plugin

  • Vaadin Gradle Plugin does not currently work with Vaadin 15.

OSGi support

OSGi does not work in V15.

Migrating from Vaadin 8

See the migration guide

Migrating from Vaadin 10-14

See the migration guide

Reporting Issues

We would appreciate it if you try to find the most relevant repository to report the issue in. If it is not obvious which project to add issues to, you are always welcome to report any issue at https://github.com/vaadin/platform/issues.

A few rules of thumb will help you and us in finding the correct repository for the issue:

  1. If you encounter an issue when using the HTML/JS API of a component or the component renders incorrectly, the problem is likely in the web component. The web component repositories are named like https://github.com/vaadin/vaadin-button
  2. If you encounter an issue when using the Java API of a component, the problem is likely in the Flow integration of the web component. The Flow component integration repositories are named like https://github.com/vaadin/vaadin-button-flow
  3. If you encounter an issue with Flow which does not seem to be related to a specific component, the problem is likely in Flow itself. The Flow repository is https://github.com/vaadin/flow
  4. If you encounter an issue with Designer, the repository is https://github.com/vaadin/designer
  5. If you encounter an issue with TestBench, the repository is https://github.com/vaadin/testbench

Don't miss a new platform release

NewReleases is sending notifications on new releases.