Page History

...

Vaadin 8 and your custom modules

If you are upgrading from a pre-5.6 Magnolia version branch to the 5.6 branch, please follow the steps below to make sure that your custom modules are compatible with the UI in this the 5.6 branch. The first Magnolia release in this branch uses Vaadin 8.1.5 (see Vaadin 8.1.5 release notes and API docs).

1. Check whether and which of your modules contain Vaadin implementations.
2. If they do, get :
   1. Obtain the https://github.com/vaadin/framework8-migration-tool .
   2. Install it locally and run like a Java jar afterwards.
   3. The script automatically changes the imports of the affected classes and thus – in the majority of cases – will make your module(s) compatible with Vaadin 8.
3. As stated on https://vaadin.com/docs/framework/migration/migrating-to-vaadin8.html, some dependencies have need to be added in order to use the compatible classes from Vaadin 7 (such as TextField ).)
   

   Change the vaadin-server dependency from from

   Mgnl mini code snippet
   Style boxed
   <dependency> <groupId>com.vaadin</groupId> <artifactId>vaadin-server</artifactId> <version>7.7.6</version> </dependency>

   to 

   Mgnl mini code snippet
   Style boxed
   <dependency> <groupId>com.vaadin</groupId> <artifactId>vaadin-compatibility-server</artifactId> <version>8.0.0</version> </dependency>

   The full list of compatibility packages available for Framework 8:

   • vaadin-compatibility-server
   • vaadin-compatibility-client
   • vaadin-compatibility-client-compiled
   • vaadin-compatibility-shared
   • vaadin-compatibility-themes

   To be able to use the new Vaadin 8 features, add also the following dependency:

   Mgnl mini code snippet
   Style boxed
   <dependency> <groupId>com.vaadin</groupId> <artifactId>vaadin-server</artifactId> <version>8.0.0</version> </dependency>

   
   

...

Normally, you won't need to do this since you have a Magnolia running for you. However, in case you are demoing your module as a custom Vaadin application, then you have to include Vaadin7WidgetSet :

• Either annotate the UI class as such with @Widgetset("com.vaadin.v7.Vaadin7WidgetSet") ,

...

• Or do it in your GW[i]T configuration file by adding <inherits name="com.vaadin.v7.Vaadin7WidgetSet" /> .

MagnoliaProWidgetSet vs MagnoliaWidgetSet

If you had Enterprise Edition Pro 5.4.x or previous and are installing Enterprise Edition Pro 5.6.x, you must have to replace the widgetset widget set in the magnolia.properties file due to component personalization bringing in new features to the page editor. Either replace or add (depending on the update path):

...