UI module
Administration Bundled: Community Edition
Download | Multiple submodules |
---|---|
Edition |
CE, Cloud |
License |
|
Issues |
|
Maven site |
|
Latest |
6.2.42 |
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.
-
Admincentral: Customization support for certain functional aspects of the Find Bar.
-
Resurface theme: Magnolia 6 Vaadin theme based on Valo..
-
Vaadin widget set: Magnolia custom Vaadin/GWT components and extensions.
-
Security app: Provides access management in Magnolia.
-
Tasks app: Organises messages relating to publishing.
-
About app: Provides an overview of relevant installation information.
-
JCR browser app: Allows you to work at the repository level in any workspace.
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:
-
In your parent POM, import dependency management from the UI project.
your-custom-project/pom.xml (snippet)<!-- ... --> <properties> <magnoliaUiVersion>{magnolia-latest-version}</magnoliaUiVersion> <javaVersion>1.8</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> <!-- ... -->
-
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.2 UI modules
Here is a list of all modules in version 6.2 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
|
Function |
Magnolia module |
||
|
Parent reactor |
n/a |
||
|
The primary module/SDK for Magnolia app development
|
|
||
|
This defines some core components for the UI such as:
|
n/a |
||
|
JCR implementation of the Magnolia 6 UI framework |
|
||
|
Magnolia 6 Vaadin theme based on Valo. |
|||
|
Magnolia custom Vaadin/GWT components and extensions
|
n/a |
||
|
Magnolia 6 UI Media Editor |
|
||
Magnolia stock apps |
||||
|
JCR browser app |
|
||
|
Sample app |
|
||
Magnolia 5 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,
|
|
||
|
Magnolia 5 Vaadin theme. |
n/a |