This documentation is still in progress. We are working hard to update all our screenshots to the new Magnolia 6 style. Please bear with us.

Page tree
Skip to end of metadata
Go to start of metadata

DEVELOPER PREVIEW

This page covers the changes in version 6.0 of the Magnolia UI project released with Magnolia 6.0.

The Magnolia UI project version 6.0 is currently available as a developer preview. The full version is still under development.

To provide backward compatibility, it contains all previously existing classes. It also delivers refactored frameworks and new functions. Please try it out and feel free to send us your feedback and suggestions based on your experience.

We are working to finalize the module as soon as possible.

Summary

Magnolia UI 6.0 comes with a completely resurfaced UI featuring the new Find Bar at its core. We have also rewritten selected parts of the UI framework, particularly the content-app framework. We generally adhere to the same concepts as before, but we have developed better implementations by using Vaadin 8.

The new implementations simplify app mechanics and configuration and use less custom Vaadin code, thus enabling cleaner and faster customization.

Magnolia UI 6.0 contains both the UI framework used in Magnolia 5.7 (referred to as Magnolia 5 UI) and the Magnolia 6 UI framework. You can use:

  • Magnolia 5 UI components as well as your custom components and modules that rely on the previous Magnolia UI. We provide backward compatibility at both runtime and compile-time levels.
  • New Magnolia 6 UI implementations.

All UI components from both implementations are rendered with the new resurfaced theme design.

Why we have changed things

The main reasons for rewriting some of the UI components include:

  • Replacing the deprecated Vaadin 7 with Vaadin 8 (classes and frameworks)
  • Developing new implementations that are more component-driven so that the components are easier to reuse
  • Decreasing the amount of custom front-end (GWT) code and instead using the new stock Vaadin
  • Simplifying app mechanics and configuration

The resulting implementations are easier to maintain for us and cleaner and faster to customize for you.

What is preserved

In Magnolia UI 6.0, the functions and frameworks known from version 5.7 and earlier remain. By preserving class names and Magnolia module names, we keep runtime backward compatibility of custom modules with custom classes extending Magnolia classes.

Class names

Class and package names of the classes existing in Magnolia 5.7 have not changed and are still available in Magnolia UI 6.0. You can use these classes or extend them in your custom code.

Magnolia module names

A Magnolia module defines dependencies to other Magnolia modules and many other tasks. A Magnolia module can be defined with one file (i.e. a module descriptor). The Magnolia module descriptors of the UI project reside in Maven modules.

In Magnolia UI 6.0, no Magnolia module has been removed. The names of the Magnolia modules are still the same.

All previously known Magnolia modules still exist with the same name and provide the same functions. However, the module descriptor files defining those Magnolia modules may have been relocated due to changes in the composition of the Maven modules.

The magnolia-ui-framework-compatibility Maven module contains the module descriptors for the ui-framework, ui-contentapp and ui-mediaeditor Magnolia modules. The magnolia-ui-framework Maven module defines the new ui-framework-core Magnolia module.

What has changed

Look and feel

The whole UI has been resurfaced to provide a modern, state-of-the-art user experience. At its core, the UI features the new Find Bar. All components of Magnolia 5 UI and Magnolia 6 UI are rendered using the new resurfaced theme design.

Magnolia 5 legacy UI

How to use the legacy Magnolia 5 UI in 6.0

If you want to access Magnolia 6.0 with the legacy 5.x look and feel, add a -m5 suffix to your instance URL after "admincentral". For example:

http://localhost:8080/magnoliaAuthor/.magnolia/admincentral-m5

This is a useful workaround if you have display issues with custom apps for example.

(warning) Note that this legacy UI mode is not fully functional and will not be supported indefinitely. Please make sure you let us know how we can improve the 6.0 UI so that we can fix any issues properly.

Maven modules

From version 5.7 and earlier, we have removed eight Maven modules. The classes of these modules are not lost. Instead, they have been relocated to the new magnolia-ui-framework-compatibility module or to the still existing magnolia-ui-framework module. New implementations have been added to the new magnolia-ui-framework-jcr module.

Removed Maven modules

  • magnolia-ui-actionbar
  • magnolia-ui-contentapp
  • magnolia-ui-dialog
  • magnolia-ui-form
  • magnolia-ui-imageprovider
  • magnolia-ui-mediaeditor
  • magnolia-ui-vaadin-integration
  • magnolia-ui-workbench

(info) We have created Maven relocations for these modules. This ensures backward compatibility for compile-time dependencies.

Added Maven modules

  • magnolia-ui-framework-jcr

     Maven dependency snippet

    <dependency>
      <groupId>info.magnolia.ui</groupId>
      <artifactId>magnolia-ui-framework-jcr</artifactId>
    </dependency>
    

  • magnolia-ui-framework-compatibility

     Maven dependency snippet

    <dependency>
      <groupId>info.magnolia.ui</groupId>
      <artifactId>magnolia-ui-framework-compatibility</artifactId>
    </dependency>
    

Features

Magnolia UI 6.0 brings, among others, the following new features:

  • Resurfaced design of the admin interface
  • Integrated Find Bar
  • Improved back-end data binding
    • dataSource replacing contentConnector for subapps
  • Forms
    • Simplified field API
    • Separation of binding and logic
    • Non-JCR-data-source friendliness
    • Custom layout support for forms

Magnolia 6 and Magnolia 5 UI frameworks

The Magnolia UI project version 6.0 contains both the UI framework used in Magnolia 5.7 (referred to as Magnolia 5 UI) and the Magnolia 6 UI framework. You can use either framework.

Magnolia 5 UI

In Magnolia 6, Magnolia 5 UI has been relocated to the magnolia-ui-framework-compatibility module. Many Magnolia apps still rely on this old framework. The fully qualified class names have not changed, which ensures runtime compatibility for older custom components based on the classes from the Magnolia 5 UI framework.

Magnolia 6 UI

In the Magnolia 6 UI framework, the core components of the UI are located in the magnolia-ui-framework module inherited from Magnolia 5.7. The new module magnolia-ui-framework-jcr is also part of Magnolia 6 UI.

The Magnolia 6 UI framework has been released as a developer preview since its API may still change. Nevertheless, feel free to try it out.

UI modules

For more information on the Magnolia 6 UI modules, refer to UI module.

Backward compatibility

The API changes are marginal. We provide backward compatibility at both runtime and compile-time levels.

Runtime compatibility

All classes from Magnolia UI 5.7 are also available in Magnolia UI 6.0. They have kept their fully qualified class names, which provides binary compatibility. Compiled custom modules (JAR files) built with Magnolia 5.7 also work in Magnolia 6.0 with the 6.0 UI.

Magnolia Maven module names are still the same. You do not have to change Magnolia module dependencies.

The binary compatibility together with the same-named Magnolia modules ensures runtime backward compatibility.

Compile-time compatibility

Module and submodule structures have been reorganized (see module changes). We have created Maven relocations for the removed modules. This ensures that you do not have to update the Maven module dependencies within the custom modules that depend on Magnolia UI modules.

How to upgrade

Make sure you upgrade your entire Magnolia bundle, not just the UI modules.

For general information on upgrading your Magnolia projects, read Upgrading to Magnolia 6.0.x.

With Maven

Make sure to set the version for the Magnolia UI project to 6.0.

In your bundle(s)

If you have a custom bundle based on a preconfigured Magnolia bundle, set the magnoliaBundleVersion property to 6.0. The Magnolia bundle will manage the UI version accordingly. For an example, see Upgrading to Magnolia 6.0.x: Updating Maven-managed webapps.

In custom modules

The composition of the submodules of the UI project has changed. Some modules have been removed, and their classes have been relocated to the magnolia-ui-framework-compatibility module. See What has changed: Maven modules.

(info) Since we have created Maven relocations for the removed modules, you do not have to change the dependencies to them within your custom modules.

However, to reflect the actual dependencies and to improve the readability of your POM files, you may want to replace the dependencies to the removed modules with the new compatibility module:

  1. Remove all dependencies to these Maven modules:
    • magnolia-ui-actionbar
    • magnolia-ui-contentapp
    • magnolia-ui-dialog
    • magnolia-ui-form
    • magnolia-ui-imageprovider
    • magnolia-ui-mediaeditor
    • magnolia-ui-vaadin-integration
    • magnolia-ui-workbench
  2. Instead, add a dependency to magnolia-ui-framework-compatibility.
    <dependency>
      <groupId>info.magnolia.ui</groupId>
      <artifactId>magnolia-ui-framework-compatibility</artifactId>
    </dependency>
    

Manually

If you choose to do this manually, make sure you upgrade the entire bundle and not just the UI modules. Please follow the instructions on Upgrading to Magnolia 6.0.x: Updating manually.

Status

  • A few of our apps make use of the improved implementations:
    • Messages app
    • Tasks
  • Most of the other apps still rely on the old implementations. We will adapt them soon.

Complete list of submodules

Here is a list of all modules in version 6.0 of the Magnolia UI project. The list includes both the Maven modules and the Magnolia modules. 

Maven

groupId

artifactID

FunctionMagnolia module name(s)1

info.magnolia.ui

magnolia-ui-project

Parent reactor

info.magnolia.ui

magnolia-ui-framework

The primary module/SDK for Magnolia app development

This provides (among others) the content app framework, IoC support for UI components and scopes, Vaadin 8 data-binding facilities and UI view/state management.

It also offers convenience builders for selected Magnolia UI components (for example, alerts and dialogs).

(info) With Magnolia 6.0, Vaadin 8 integration and data binding are provided as a developer preview.

ui-framework-core

info.magnolia.ui

magnolia-ui-api

This defines some core components for the UI such as Action, App, SubApp, Message and others.

info.magnolia.ui

magnolia-ui-framework-jcr

JCR implementation of the Magnolia 6 UI framework (developer preview)ui-framework-jcr

info.magnolia.admincentral

magnolia-admincentral

Magnolia 6 AdminCentral, an OS-like web application running Magnolia apps. This is where authors enter, preview, and publish content and where administrators configure Magnolia.

(warning) This module is considered a private API and may evolve rapidly without any guarantee of backward/binary compatibility. Developers are encouraged to use what the UI framework offers instead.

admincentral

info.magnolia.ui

magnolia-resurface-theme

Magnolia 6 Vaadin theme based on Valo

info.magnolia.ui

magnolia-ui-vaadin-common-widgets

Magnolia's custom Vaadin/GWT components and extensions

This module contains mainly former Magnolia 5 widget implementations. For Magnolia 6, most of the components have been re-implemented with plain Vaadin. Consequently, this module may be split and partially deprecated in any future version.

Magnolia stock apps

info.magnolia.about

magnolia-about-app

About Magnolia app

about-app

info.magnolia.jcrbrowser

magnolia-jcr-browser-app

JCR browser app

jcr-browser-app

info.magnolia.messages

magnolia-messages-app

Messages appmessages-app

info.magnolia.sample

magnolia-sample-app

Sample appsample-app

info.magnolia.security

magnolia-security-app

Security appsecurity-app

info.magnolia.task

magnolia-tasks-app

Task management apptasks-app
Magnolia 5 compatibility

info.magnolia.ui

magnolia-ui-admincentral

Magnolia 5 AdminCentral

Accessible via /.magnolia/admincentral-m5 for compatibility and migration purposes

(info) As of Magnolia 6.0, this module still provides (among others) the app launcher configuration, login form and user preferences dialog. These may be replaced or relocated to the new magnolia-admincentral module in any future version.

ui-admincentral

info.magnolia.ui

magnolia-ui-framework-compatibility

This module brings support for running Magnolia 5 content apps in Magnolia 6.

In particular, it contains former Magnolia 5 content-app components such as the workbench, forms and dialogs or image provider. It also provides JCR implementations of the deprecated Vaadin 7 Data API (for example, JcrNodeAdapter and HierarchicalJcrContainer).

(info) The following Magnolia 5 Maven modules have been relocated to this module:

  • magnolia-ui-actionbar
  • magnolia-ui-contentapp
  • magnolia-ui-dialog
  • magnolia-ui-form
  • magnolia-ui-imageprovider
  • magnolia-ui-mediaeditor
  • magnolia-ui-vaadin-integration
  • magnolia-ui-workbench

The Media Editor may be re-instated as part of the ui-framework in any future version.

ui-contentapp

ui-framework

ui-mediaeditor


info.magnolia.ui

magnolia-ui-vaadin-theme

Magnolia 5 Vaadin theme

1) Magnolia modules that belong to the given Maven submodule

  • No labels