Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
HTML Wrap
clearboth
width244px
alignright
classmenu

Related topics:

Excerpt

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.

...

Localtab Group
Localtab
activetrue
titleYAML file
Code Block
languagejsyaml
title<module name>/dialogs/<dialog name>.yaml
form:
  tabs:
    - name: tabText
      label: Text
      fields:
        - name: title
          class: info.magnolia.ui.form.field.definition.TextFieldDefinition
          label: Title
actions:
  commit:
    class: info.magnolia.ui.admincentral.dialog.action.SaveDialogActionDefinition
    label: Save
  cancel:
    class: info.magnolia.ui.admincentral.dialog.action.CancelDialogActionDefinition
    label: Cancel
Localtab
titleJCR node
Advanced Tables - Table Plus
heading0
multiplefalse
enableHeadingAttributesfalse
enableSortingfalse
classm5-configuration-tree
enableHighlightingfalse
  
Node nameValue

Mgnl f
modules

 

Mgnl f
<module name>

 

Mgnl f
dialogs


Mgnl n
<dialog name>

 

Mgnl n
form

 

Mgnl n
tabs

 

Mgnl n
tabText

 

Mgnl n
fields

 

Mgnl n
title

 


Mgnl p
class

info.magnolia.ui.form.field.definition.TextFieldDefinition

Mgnl p
label

Title

Mgnl p
label

Text

Mgnl n
actions


Mgnl n
commit

 

Mgnl p
class

info.magnolia.ui.admincentral.dialog.action.SaveDialogActionDefinition

Mgnl p
label

save

Mgnl n
cancel

 

Mgnl p
class

info.magnolia.ui.admincentral.dialog.action.CancelDialogActionDefinition

Mgnl p
label

close

...

<dialog-name>

required

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 link . This is not required and one dialog can be used for more than one template.

form

required

Contains a form definition which defines the fields where content is entered.

actions

required

Contains  action definitions  which define how the data is submitted. The actions are rendered to users as buttons. Typically you need at least save and cancel actions.

modalityLevel

optional

Modality level defines how intrusive the dialog is. Valid values are strong (default), light and non-modal .

actionArea

optional

Allows you to configure secondary actions.

wide

optional , default is false

true opens the dialog in wide mode using all available horizontal space.

Click the expand/collapse button in the top right corner to toggle between the wide and normal (720px) modes.

...

dialogLabelItemProperty

optional

((warning) Magnolia 5.6.7+) Sets the dialog's caption via a property holding the preferred value, for example via the jcrName property.

Location of dialog definitions

...


YAML file pathJCR node path in config workspace
Dialog definition$magnolia.resources.dir/<module-name>/dialogs/modules/<module-name>/dialogs

...

Localtab Group
Localtab
activetrue
titleYAML file
Code Block
languagejs
title<module name>/templates/components/textImage.yaml
dialog: my-module:components/textImage
renderType: freemarker
templateScript: /components/textImage.ftl
title: Text &amp; Image Component
Localtab
titleJCR node
Advanced Tables - Table Plus
heading0
multiplefalse
enableHeadingAttributesfalse
enableSortingfalse
classm5-configuration-tree
enableHighlightingfalse
Node nameValue

Mgnl f
my-module

 


Mgnl f
templates

 

Mgnl f
components

 

Mgnl n
textImage

 

Mgnl p
dialog

my-module:components/textImage

Mgnl p
renderType

freemarker

Mgnl p
templateScript

/components/textImage.ftl

Mgnl p
title

Text & Image Component

...

Advanced Tables - Table Plus
heading0
multiplefalse
enableHeadingAttributesfalse
enableSortingfalse
classm5-configuration-tree
enableHighlightingfalse
  
Node name 

Mgnl n
chooseDialog

 

Mgnl n
actions

 


Mgnl n
commit

 


Mgnl n
cancel

 

Mgnl n
upload

 

Mgnl n
uploadAndEdit

 


Mgnl n
actionArea


Mgnl n
secondaryActions

 

Mgnl n
upload

 

Mgnl n
uploadAndEdit

 

Mgnl n
actionRenderers

 

Mgnl n
upload

 

Mgnl p
rendererClass

info.magnolia.dam.app.assets.field.UploadAssetActionRenderer

Mgnl n
uploadAndEdit


Mgnl p
rendererClass

info.magnolia.dam.app.assets.field.UploadAndEditActionRenderer

...

Magnolia provides mechanisms to reuse dialogs or more general said to reuse configuration items. See Reusing configuration and Generic tab for a dialog. 


optional

Sets the dialog's caption via a property holding the preferred value, for example via the jcrName property.