Magnolia 5.6 reached end of life on June 25, 2020. This branch is no longer supported, see End-of-life policy.
pages since a Pages app already exists.Here is an example descriptor for a helloworld app.
appClass: info.magnolia.ui.app.helloworld.HelloWorldApp class: info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor icon: icon-app label: Hello World subApps:
| Node name | Value |
|---|---|
| info.magnolia.ui.app.helloworld.HelloWorldApp | |
| info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor | |
| icon-app | |
| Hello World | |
| 1.0.0 |
Properties:
subapps | required Node containing subapps. |
appClass | required Fully qualified name of the Java class that contains the app business logic. The class must implement the App interface. |
name | optional Name of the app. If a value is not provided, either the file name (without the suffix .yaml) or the JCR node name is used. |
class | optional, default is App descriptor class that reads the configuration. The class must implement the AppDescriptor interface. Examples:
|
enabled | optional , default is Enables and disables the app. |
icon | optional CSS class that identifies an icon font used on the app tile. For available names see Icons. |
i18nBasename | optional Message bundle for localized labels. |
label | optional Label displayed on the app icon in the app launcher. |
theme | optional Name of a custom app theme. |
The permission to use an app is granted in the permissions configuration. The subnodes are roles. This allows you to provision the app to certain users in your organization.
In this example the helloworld app is provisioned to travel-demo-editor and travel-demo-publisher roles. The role property name (editors, publishers) is arbitrary - use any name you like. The value must be a valid role name.
appClass: info.magnolia.ui.app.helloworld.HelloWorldApp
class: info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
icon: icon-app
label: Hello World
permissions:
roles:
editors: travel-demo-editor
publishers: travel-demo-publisher
| Node name | Value |
|---|---|
| |
| |
travel-demo-editor | |
travel-demo-publisher |