The 5.7 branch of Magnolia reached End-of-Life on December 31, 2023, as specified in our End-of-life policy. This means the 5.7 branch is no longer maintained or supported. Please upgrade to the latest Magnolia release. By upgrading, you will get the latest release of Magnolia featuring significant improvements to the author and developer experience. For a successful upgrade, please consult our Magnolia 6.2 documentation. If you need help, please contact info@magnolia-cms.com.

The Sample app is a learning example for developers. It is not a tool for editors but rather a showcase for common app functionality at development level. It shows you how to expose actions to the user as user interface elements (buttons) and how to trigger actions. As a developer you should examine the Sample app source code and read the comments in the code.

Configuration

The Sample app is installed by the sample-app module. The Dev app group that this app belongs to is only available to the superuser role. This is configured in the app launcher layout. The app is configured at Configuration > /modules/samples-app/apps/sample.

Node name

Value

 
sample-app

 

 
apps

 

 
sample

 

 
subapps

 

 
main

 

 
class

info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor

 
subAppClass

 info.magnolia.sample.app.main.SampleMainSubApp

 
editor

 

 
class

 info.magnolia.ui.api.app.registry.ConfiguredSubAppDescriptor

 
subAppClass

 info.magnolia.sample.app.editor.SampleEditorSubApp

 
appClass

 info.magnolia.ui.framework.app.BaseApp

 
name

 sample