Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: DOCU-2700

...

clearboth
alignright
classmenu

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

...

When creating a form for a dialog's tab, you usually want it to contain some fields. The fields are the core building blocks of the form's functionality for user tasks such as entering a text and sending it to a server after the user hits the form's submit button.

Fields are defined using a field definition, which must contain – at minimum – a property telling Magnolia what type of field it should render in the dialog.

...

For legibility, ease of development, and to make field names easier to remember, field type definition has changed in the with Magnolia 5.7 branch:we've introduced the fieldType property.

  • For the fieldType property you You no longer need to specify the field type using a fully qualified class name. Just provide the field's name as the value of the new fieldType property.the fieldType property.
    (warning) If your project uses the class property in too many places, you can still continue using classThe feature is backwards compatible.
  • We have streamlined the definition names by making them shorter. The 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. shows which fields are affected.


Applied to the above example the configuration can now be as simple as this:

...

To verify that you use correct short field names, look in the   Definitions app :

TODO

Relevance for custom fields extending or decorating Magnolia fields

Please note that the new short field naming affects:

  • The origin of the definition. The fields defined previously as JCR nodes under /modules/<module-name>/fieldTypes folders are now defined from YAML files.
    See the following example showing the definition of damUploadField in Magnolia 5.6.6 and the corresponding damUpload definition in Magnolia 5.7:
    Image Added
    Image Added

  • The file names. If a field was previously defined in a YAML file, the file's name has changed to the new short name. See for example the definition of the Expanding text field:

    /content-editor/fieldTypes/expandingTextField.yaml (in Magnolia 5.6.6)
    /content-editor/fieldTypes/expandingText.yaml (in Magnolia 5.7)

Warning

If you have custom fields which reuse an existing Magnolia configuration via YAML includeYAML inheritJCR extends or by decoration, your custom definition may be broken now if you reference a field which has changed its name.

Short field names

Include Page
_field names shortening
_field names shortening