Magnolia 6.1 reached end of life on March 31, 2021. This branch is no longer supported, see End-of-life policy.
Dialogs are used for content entry. A dialog defines the editable content properties of a template. Pages, area and component templates can all use dialogs.
create-component commands in the Magnolia CLI create basic dialog definitions automatically.
A dialog is basically an HTML form with input fields for each content property. Editors type content into the fields and the dialog saves it in the repository.
The functionality of each field in a dialog is provided by a field definition class that allows the editor to perform a task such as enter text, upload an image, select a date etc. Fields are assembled into tabs and tabs into dialogs.
All dialogs used throughout the system are configured in the same way. For example, the configuration of dialogs used in apps and components is the same.
At minimum a dialog definition must have a name and has to contain a
Here's what the configurations do:
Example: Simple dialog definition:
form: tabs: - name: tabText fields: - name: title fieldType: text label: Title actions: commit: class: info.magnolia.ui.dialog.action.SaveDialogActionDefinition label: Save cancel: class: info.magnolia.ui.dialog.action.CancelDialogActionDefinition label: Cancel
Arbitrary node name. Typically matches the template it edits. For example the component definition node and dialog definition node for a link component could both be named
Contains a form definition which defines the fields where content is entered.
optional, default is
Defines actions in the dialog. Specified actions are rendered as components via ActionDefinition.
Only the actions that are defined will be provided. If no action is specified, the dialog will have
Modality level defines how intrusive the dialog is. Valid values are
Allows you to configure secondary actions.
optional, default is
Click the expand/collapse button in the top right corner to toggle between the wide and normal (720px) modes.
A property that sets the dialog's caption.
The value is ignored if the
The value can be literal such as
Allows you to set the dialog's caption dynamically through a property holding the preferred value for the caption, for example through the
|YAML file path||JCR node path in config workspace|
Templates reference dialog definitions in their template definition. This is how the system knows which dialog to associate with the template. Page, area and component templates reference dialogs in the same way by using the
Example: A component definition that references a
dialog: my-module:components/textImage renderType: freemarker templateScript: /components/textImage.ftl title: Text & Image Component
|Text & Image Component|
Dialog definition ID in
The ID has two parts, separated by a colon:
Dialogs are most commonly used for content entry in components. This is where the bulk on content is entered. But dialogs are also useful for page and area templates. Here are a few suggestions:
<head>element, or a page excerpt for use in teaser components on other pages.
actionArea node lets you provide additional actions and specify a renderer, if required. You need a renderer when the action requires more than just a button (for instance for an upload action).
The choose dialog in the Assets app is an example. The dialog allows editors to upload assets to the DAM while working in other apps.
The configuration is in
A secondary action area in the bottom left corner of the editor. Contains the action area configuration.
Add subnodes to match the secondary actions defined in the
Secondary action name.
Define a subnode for each action which requires its own renderer.
Name of the secondary action.
A renderer class if the secondary action requires one. Must implement ActionRenderer.
Magnolia provides mechanisms to reuse dialogs or more general said to reuse configuration items. See Reusing configuration and Generic tab for a dialog.