Page History

HTML Wrap

clear	both
width	244px
align	right
class	menu

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.

...

A dialog definition contains a form and actions .

Here's what the configurations do:

...

Localtab Group

Localtab

active	true
title	YAML file

Code Block

language	jsyaml
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

title	JCR node

Advanced Tables - Table Plus

heading	0
multiple	false
enableHeadingAttributes	false
enableSorting	false
class	m5-configuration-tree
enableHighlighting	false

Node name

Value

Mgnl f

modules

Mgnl f

Mgnl f

dialogs

Mgnl n

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

( 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 path	JCR node path in config workspace
Dialog definition	`$magnolia.resources.dir/<module-name>/dialogs`	`/modules/<module-name>/dialogs`

...

Localtab Group

Localtab

active	true
title	YAML file

Code Block

language	js
title	<module name>/templates/components/textImage.yaml

dialog: my-module:components/textImage
renderType: freemarker
templateScript: /components/textImage.ftl
title: Text &amp; Image Component

Localtab

title	JCR node

Advanced Tables - Table Plus

heading	0
multiple	false
enableHeadingAttributes	false
enableSorting	false
class	m5-configuration-tree
enableHighlighting	false

Node name

Value

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

...

The configuration is in /modules/dam-app/apps/assets/chooseDialog :

Advanced Tables - Table Plus

heading	0
multiple	false
enableHeadingAttributes	false
enableSorting	false
class	m5-configuration-tree
enableHighlighting	false

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

actionArea

optional

A secondary action area in the bottom left corner of the editor. Contains the action area configuration.

secondaryActions

required

Add subnodes to match the secondary actions defined in the actions node. The order of the subnodes defines the sequence in which they are rendered. Actions configured under secondaryActions are rendered on the left and other actions are on the right side.

<actionName>

required

Secondary action name.

actionRenderers

optional

Define a subnode for each action which requires its own renderer.

<actionName>

required

Name of the secondary action.

rendererClass

required

A renderer class if the secondary action requires one. Must implement

Javadoc

className0	info.magnolia.ui.dialog.actionarea.renderer.ActionRenderer
renderType	asynchronous

.

Reusing configuration

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.

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Location of dialog definitions

Reusing configuration