You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

App descriptor configuration describes an app. The descriptor assigns the app a name, icon and implementation class. The name of the app content node must be unique as it is used to refer to the app across the system. This means you cannot name your own app pages since a Pages app already exists.

Here is an example descriptor for a helloworld app.

Node nameValue

modules

 

ui-helloworld-app

 

apps

 

helloworld

 

subApps

 

appClass

info.magnolia.ui.app.helloworld.HelloWorldApp

class

info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor

icon

icon-app

label

Hello World

version

 1.0.0

Properties:

subappsNode containing subapps.
appClass

required

Fully qualified name of the Java class that contains the app business logic. The class must implement the 

$webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources") App
 interface.

class

optional, default is info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor

App descriptor class that reads the configuration. The class must implement the 

$webResourceManager.requireResource("info.magnolia.sys.confluence.artifact-info-plugin:javadoc-resource-macro-resources") AppDescriptor
 interface.

enabled

optional, default is true

Enables and disables the app.

icon

optional

CSS class that identifies an icon font used on the app tile. For available names see Icons.

label

optional

Label displayed on the app icon in the app launcher.

name

required

Name of the app.

theme

optional

Name of a custom app theme.

i18nBasenameMessage bundle for localized labels.
#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))
  • No labels