Field converters

To provide a smooth transition from Magnolia 5 to Magnolia 6 UI, a number of field converters have been introduced since Magnolia 6.2. These converters allow you to use a Magnolia 5 UI dialog definition in a Magnolia 6 UI app.

Example definition

To open a Magnolia 5 UI dialog definition in an app migrated to Magnolia 6 UI, use the info.magnolia.ui.dialog.action.CompatibilityOpenDialogActionDefinition class in your action definition.

myConvertedDialog:
  class: info.magnolia.ui.dialog.action.CompatibilityOpenDialogActionDefinition
  dialogId: contacts:renameContact
  icon: icon-edit

Conversion is done automatically for every action using info.magnolia.ui.dialog.actions.OpenDialogActionDefinition when the magnolia-ui-framework-compatibility module is included in your webapp.

Supported fields

Magnolia 5 UI definition Magnolia 6 UI equivalent

info.magnolia.ui.form.field.definition.BasicUploadFieldDefinition

info.magnolia.ui.field.UploadFieldDefinition

info.magnolia.ui.form.field.definition.CheckboxFieldDefinition

info.magnolia.ui.field.CheckBoxFieldDefinition

info.magnolia.ui.form.field.definition.CodeFieldDefinition

info.magnolia.ui.field.CodeFieldDefinition

info.magnolia.ui.form.field.definition.CompositeFieldDefinition

info.magnolia.ui.field.CompositeFieldDefinition

info.magnolia.ui.form.field.definition.DateFieldDefinition

info.magnolia.ui.field.DateFieldDefinition

info.magnolia.ui.form.field.definition.HiddenFieldDefinition

info.magnolia.ui.field.HiddenFieldDefinition

info.magnolia.ui.form.field.definition.LinkFieldDefinition

info.magnolia.ui.field.LinkFieldDefinition

info.magnolia.ui.form.field.definition.MultiValueFieldDefinition

info.magnolia.ui.field.MultiFieldDefinition

info.magnolia.ui.form.field.definition.OptionGroupFieldDefinition

info.magnolia.ui.field.CheckBoxGroupFieldDefinition

info.magnolia.ui.field.RadioButtonGroupFieldDefinition

info.magnolia.ui.form.field.definition.RichTextFieldDefinition

info.magnolia.ui.field.RichTextFieldDefinition

info.magnolia.ui.form.field.definition.SelectFieldDefinition

info.magnolia.ui.field.ComboBoxFieldDefinition

info.magnolia.ui.form.field.definition.StaticFieldDefinition

info.magnolia.ui.field.StaticFieldViewDefinition

info.magnolia.ui.form.field.definition.SwitchableFieldDefinition

info.magnolia.ui.field.ConfiguredSwitchableFieldDefinition

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

info.magnolia.ui.field.TextFieldDefinition

info.magnolia.ui.form.field.definition.TwinColSelectFieldDefinition

info.magnolia.ui.field.TwinColSelectFieldDefinition

Known limitations

A field converter falls back to an empty field for any Magnolia 5 UI definition that is not supported.

Field definitions

The following Magnolia 5 UI definitions cannot be converted:

  • info.magnolia.ui.form.field.definition.PasswordFieldDefinition

  • Those brought in by modules other than magnolia-ui-framework-compatibility (for example, info.magnolia.dam.app.ui.field.definition.DamUploadFieldDefinition)

In addition, custom fields cannot be converted as they must be configured using Magnolia 6 UI.

Link fields can only be converted without the capability to preview content.

Validator definitions

Only info.magnolia.ui.form.validator.definition.EmailValidatorDefinition and info.magnolia.ui.form.validator.definition.RegexpValidatorDefinition in Magnolia 5 UI can be converted.

Custom validators cannot be converted as they must be configured using Magnolia 6 UI.

Vaadin converters

Only Vaadin 7 converter classes with corresponding classes in Vaadin 8 can be converted.

Feedback