Subapp descriptor - 5 UI
Deprecated
|
This subapp descriptor has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework. For the updated implementation, see Subapp descriptor for Magnolia 6 UI instead. |
A subapp descriptor describes a subapp. A subapp is typically rendered as a tab inside an app. The descriptor defines the classes that read the configuration and implement the subapp.
Subapp descriptor
Here is an example of a main subapp inside a helloworld app.
ui-helloworld-app/apps/helloworld.yaml
appClass: info.magnolia.ui.app.helloworld.HelloWorldApp
class: info.magnolia.ui.api.app.registry.ConfiguredAppDescriptor
icon: icon-app
label: Hello World
subApps:
main:
subAppClass: info.magnolia.ui.app.helloworld.main.HelloWorldMainSubApp
class: info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor
label: Hello!| Property | Description | ||
|---|---|---|---|
|
required Subapp node name. This is the internal ID of the subapp. Used to reference the subapp for example in URL fragments. |
||
|
required, default is
Subapp descriptor class that reads the configuration. The class must
implement the |
||
|
required Subapp business logic class. The class must implement the
|
||
|
optional, default is Whether the subapp can be closed. When set to |
||
|
optional CSS class that identifies an icon font used on the app tab. For available names see Icons. |
||
|
optional Text or message bundle key. Displayed in the subapp tab.
|
Browser subapp
Browser subapp is a specialization of the basic subapp, provided by the content app framework. The browser subapp allows you to view and organize content items in tree, list and thumbnail views. The browser subapp descriptor is similar to the basic subapp descriptor, but the classes are different.
subApps:
browser:
subAppClass: info.magnolia.ui.contentapp.browser.BrowserSubApp
class: info.magnolia.ui.contentapp.browser.BrowserSubAppDescriptorDetail subapp descriptor
Detail subapp is also part of the content app framework. It creates and edits the content items listed in the browser subapp.
subApps:
detail:
subAppClass: info.magnolia.ui.contentapp.detail.DetailSubApp
class: info.magnolia.ui.contentapp.detail.DetailSubAppDescriptor