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.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 18 Next »

This page describes two ways in which you may define the type of a field in a form.

When creating a dialog, you usually want it to contain fields that build its core functionality for user tasks such entering a text into a field and sending it to the server upon hitting the SUBMIT button. Any field like that must be defined in a dialog definition through a  field definition  which must contain – at minimum – a property telling Magnolia what type of field it should render in the dialog.

Using the class property

Until the release of Magnolia 5.7, the only way to specify the type of a field was to state its fully qualified class name. For example, to create a simple text field named title in a dialog's tab called tabText you had to include the following code in the configuration of the dialog:

form:
  tabs:
    - name: tabText
      fields:
        - name: title
          class: info.magnolia.ui.form.field.definition.TextFieldDefinition

Using the fieldType property and with short field names

For legibility, ease of development, and to make field names easier to remember, Magnolia 5.7 changed this in two ways:

  • You no longer need to specify the field type using the fully qualified class name. You need to set just the field name proper via the fieldType property.
  • In selected modules (see the Short field names list below on this page), the field name does not even require the -Field or -FieldDefiniton suffix. 

For the example with the text field this means that the configuration can look like as this:

form:
  tabs:
    - name: tabText
      fields:
        - name: title
          fieldType: text


TODO

Short field names

Old nameNew nameSince
UI module

basicTextCodeField

(warning) Removed, previously deprecated.

code5.7
basicUploadFieldbasicUpload5.7
checkBoxFieldcheckbox5.7
compositeFieldcomposite5.7
dateFielddate5.7
hiddenFieldhidden5.7
linkFieldlink5.7
linkFieldSelectlinkFieldSelection5.7
multiFieldmultiValue5.7
nodeTypeFieldnodeTypeSelect5.7
optionsFieldoptionGroup5.7
passwordFieldpassword5.7
selectFieldselect5.7
staticFieldstatic5.7
switchableFieldswitchable5.7
textArearichText5.7
textFieldtext5.7
twinColSelectFieldtwinColSelect5.7
workbenchFieldworkbench5.7
DAM module
damUploadFielddamUpload5.7
damWorkbenchFielddamWorkbench5.7
Content tags module
tagFieldtag5.7
taggingAwareDependenciesFieldtaggingAwareDependencies5.7
Content dependencies module
referenceFielddependencies5.7
Content editor module
articleBlockPickerblockPicker5.7
collapsibleCompositeFieldcollapsibleComposite5.7
expandingLinkFieldexpandingLink5.7
expandingTextFieldexpandingText5.7
peekFieldpeek5.7
placeholderTextplaceholderText5.7
refreshableTextFieldrefreshableText5.7

  • No labels