UI module

Administration Bundled: Community edition

Download Multiple submodules

Edition

CE, Cloud

License

MLA, GPL

Issues

MGNLUI

Maven site

UI

Latest

6.3.1

The Magnolia UI module is responsible for the user interface of the Magnolia AdminCentral back-end. It provides various UI frameworks for other parts of Magnolia such as content apps.

Modules

Magnolia’s UI consists of the following modules. Some modules (magnolia-admincentral, magnolia-about-app, magnolia-messages-app, magnolia-security-app, and magnolia-tasks-app) are stored in different repositories and, therefore, are not listed in the detailed module list further down.

Installing

There is usually no need to install the Magnolia UI project. Every preconfigured Magnolia bundle already contains the required UI submodules. The Magnolia BOM file manages the versions for dependent UI modules.

If you have a custom webapp that is completely independent from any preconfigured Magnolia webapp, here is how you should add the UI project submodules to it:

  1. In your parent POM, import dependency management from the UI project.

    your-custom-project/pom.xml (snippet)
    <!-- ... -->
  <properties>
    <magnoliaUiVersion>{magnolia-latest-version}</magnoliaUiVersion>
    <javaVersion>{base-java-version}</javaVersion>
  </properties>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>info.magnolia.ui</groupId>
        <artifactId>magnolia-ui-project</artifactId>
        <version>${modules-version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
<!-- ... -->

  1. In the POM of your webapp, add the UI submodules you rely on. The following is a typical configuration (from magnolia-empty-webapp):

    your-custom-project/my-custom-webapp/pom.xml (snippet)
    <!-- ... -->
<dependencies>
  <dependency>
    <groupId>info.magnolia.ui</groupId>
    <artifactId>magnolia-ui-admincentral</artifactId>
  </dependency>
  <dependency>
    <groupId>info.magnolia.admincentral</groupId>
    <artifactId>magnolia-admincentral</artifactId>
  </dependency>
  <dependency>
    <groupId>info.magnolia.ui</groupId>
    <artifactId>magnolia-resurface-theme</artifactId>
  </dependency>
  <dependency>
    <groupId>info.magnolia.widgetset</groupId>
    <artifactId>magnolia-vaadin-widgetset</artifactId>
  </dependency>
  <dependency>
    <groupId>info.magnolia.security</groupId>
    <artifactId>magnolia-security-app</artifactId>
  </dependency>
  <dependency>
    <groupId>info.magnolia.task</groupId>
    <artifactId>magnolia-tasks-app</artifactId>
  </dependency>
  <dependency>
    <groupId>info.magnolia.about</groupId>
    <artifactId>magnolia-about-app</artifactId>
  </dependency>
  <dependency>
    <groupId>info.magnolia.jcrbrowser</groupId>
    <artifactId>magnolia-jcr-browser-app</artifactId>
  </dependency>
</dependencies>
<!-- ... -->

Magnolia 6.3 UI modules

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

The Magnolia module column refers to the Magnolia module that belongs to the given Maven submodule.

Maven

groupId

artifactID

Function

Magnolia module

info.magnolia.ui

magnolia-ui-project

Parent reactor

n/a

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).

ui-framework-core

info.magnolia.ui

magnolia-ui-api

This defines some core components for the UI such as:

  • info.magnolia.ui.api.action.Action,

  • info.magnolia.ui.api.app.App,

  • info.magnolia.ui.api.app.SubApp,

  • info.magnolia.ui.api.message.Message and others.

n/a

info.magnolia.ui

magnolia-ui-framework-jcr

JCR implementation of the Magnolia 6 UI framework

ui-framework-jcr

info.magnolia.ui

magnolia-resurface-theme

Magnolia 6 Vaadin theme based on Valo.

info.magnolia.ui

magnolia-ui-vaadin-common-widgets

Magnolia custom Vaadin/GWT components and extensions

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

n/a

info.magnolia.ui

magnolia-ui-mediaeditor

Magnolia 6 UI Media Editor

ui-mediaeditor

Magnolia stock apps

info.magnolia.jcrbrowser

magnolia-jcr-browser-app

JCR browser app

jcr-browser-app

info.magnolia.sample

magnolia-sample-app

Sample app

sample-app

Magnolia 5 compatibility

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).

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-vaadin-integration

  • magnolia-ui-workbench

ui-contentapp

ui-framework

info.magnolia.ui

magnolia-ui-vaadin-theme

Magnolia 5 Vaadin theme.

n/a
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules