Versions Compared

Old Version 10

changes.mady.by.user Ashraf Khamis

Saved on

compared with

New Version Current

changes.mady.by.user Ashraf Khamis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Include Page
_What is an app descriptor
_What is an app descriptor

Info

App This app descriptor is part of the Magnolia 6 UI framework. The fully qualified class name is info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor.

If you work with the Magnolia 5 UI framework, see App descriptor for Magnolia 5 UI instead.

Table of Contents

Anchor
anc-properties
anc-properties
Example app descriptor

Code Block
languageyml
icon: icon-app
class: info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
appClass: info.magnolia.ui.framework.app.BaseApp
label: Base App
subApps:

App descriptor properties

subApps

required

Node containing subapps.

appClass

required

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

Javadoc resource link
classNameinfo.magnolia.ui.api.app.App
renderTypeasynchronous
 interface.

name

optional

App name. If no value is specified, either the file name (without the suffix .yaml) or the JCR node name will be used.

class

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

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

Javadoc resource link
classNameinfo.magnolia.ui.api.app.AppDescriptor
renderTypeasynchronous
 interface. Use the fully qualified class name.

Another possible value is info.magnolia.ui.contentapp.configuration.ContentAppDescriptor.

datasource

optional

Connects the app to a data source. For this to work, you have to use the info.magnolia.ui.contentapp.configuration.ContentAppDescriptor class.

enabled

optional, default is true

Enables or disables When false, the app .

htmlCaption

optional, default is true

HTML caption displayed for the appis disabled.

icon

optional

CSS class that identifies an icon used for the app. See How to add SVG icons for apps.

label

optional

Text or message bundle key displayed on the app icon in the app launcher.

permissions

optional

Provisions the app to certain users. See App descriptor - 6 UI Permissions.

theme

optional

Name of a custom app theme.

Permissions

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.

...