Magnolia 5.6 reached end of life on June 25, 2020. This branch is no longer supported, see End-of-life policy.
The form definition defines the tabs and fields in a dialog.
Simple form definition with two tabs and Title ( plain text ), Text ( rich text ) and a link field to link to an asset from dam.
form:
tabs:
- name: tabText
label: Text
fields:
- name: title
class: info.magnolia.ui.form.field.definition.TextFieldDefinition
label: Title
- name: textEditor
class: info.magnolia.ui.form.field.definition.RichTextFieldDefinition
label: Text editor
- name: tabImage
label: Image
fields:
- name: image
class: info.magnolia.ui.form.field.definition.LinkFieldDefinition
targetWorkspace: dam
appName: assets
identifierToPathConverter:
class: info.magnolia.dam.app.assets.field.translator.AssetCompositeIdKeyTranslator
contentPreviewDefinition:
contentPreviewClass: info.magnolia.dam.app.ui.field.DamFilePreviewComponent
| Node name | Value |
|---|---|
| info.magnolia.ui.form.field.definition.TextFieldDefinition | |
| Title | |
| info.magnolia.ui.form.field.definition.RichTextFieldDefinition | |
| Text editor | |
| Text | |
| info.magnolia.ui.form.field.definition.LinkFieldDefinition | |
| dam | |
| assets | |
| info.magnolia.dam.app.assets.field.translator.AssetCompositeIdKeyTranslator | |
| info.magnolia.dam.app.ui.field.DamFilePreviewComponent | |
| Image |
Nodes and properties:
<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 |
| required Contains the form definition which defines the tabs and fields where content is entered. |
| required Contains the tabs within the form. Every dialog needs at least one tab. |
| required The name of the tab. Arbitrary node name. Use a name that describes the content of the tab like |
| required Contains the fields within the tab. See Field definition for more. |
| required Arbitrary field name. Use a name that describes the field like |
| required Field definition class. See Available field definition classes and List of fields for more. |
| optional See Common field properties for a list of optional properties that can be used with all fields. required Each field definition class supports its own properties. See List of fields for properties and example configurations of each field. |
| optional The tab label. Displays in the tab. |
info.magnolia.ui.form.field.definition.TextFieldDefinitioninfo.magnolia.ui.form.field.definition.RichTextFieldDefinitioninfo.magnolia.ui.form.field.definition.DateFieldDefinitioninfo.magnolia.ui.form.field.definition.HiddenFieldDefinitioninfo.magnolia.ui.form.field.definition.LinkFieldDefinitioninfo.magnolia.ui.form.field.definition.CodeFieldDefinitioninfo.magnolia.ui.form.field.definition.MultiValueFieldDefinitioninfo.magnolia.ui.form.field.definition.PasswordFieldDefinitioninfo.magnolia.ui.form.field.definition.SelectFieldDefinitioninfo.magnolia.ui.form.field.definition.OptionGroupFieldDefinitioninfo.magnolia.ui.form.field.definition.TwinColSelectFieldDefinitioninfo.magnolia.ui.form.field.definition.CheckboxFieldDefinitioninfo.magnolia.ui.form.field.definition.CompositeFieldDefinitioninfo.magnolia.ui.form.field.definition.SwitchableFieldDefinitioninfo.magnolia.ui.form.field.definition.StaticFieldDefinitioninfo.magnolia.ui.form.field.definition.BasicUploadFieldDefinitioninfo.magnolia.dam.app.ui.field.definition.DamUploadFieldDefinitioninfo.magnolia.editor.app.field.CollapsibleCompositeFieldDefinitioninfo.magnolia.editor.app.field.ExpandingTextFieldDefinition