Custom fields - 5 UI
This custom field definition has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework.
For the updated implementation, see Custom fields for Magnolia 6 UI instead.
Create your own fields when the default fields do not meet your requirements. Magnolia fields are implemented as Vaadin components. Start by looking through the Vaadin sampler. When you find a matching field, implement it as a simple Vaadin Field in Magnolia. If you need a more complex field that is a composition of more than one simple field, look at the composite field or implement a Vaadin CustomField.
personaSwitcher is an example of a custom field. Editors can quickly
switch between personas while
previewing the page.
Each field needs the following classes:
A definition class defines the field. It typically reads properties from the field definition. The definition class must implement the FieldDefinition interface.
A factory class creates and initializes Vaadin fields based on the field definition.
creates a text field. It contains logic to react to the definition
properties. If the
rows property equals 1 the factory creates a
single-line input element. If
rows is more than 1 the factory creates
a multiline text area. Factory classes extend
which can handle all
A field class is only needed if you cannot find a single Vaadin field that meets your requirements. Simple fields such as Text do not have a field class - the factory class simply creates the matching Vaadin field directly. However, more complex fields need a field class.
For example, Link is a compound of a text box and a button. Vaadin doesn’t provide this combination out of the box, so we need a LinkField class that extends Vaadin CustomField. The custom field class provides a layout with a text field on the left and a button on the right. It also registers a preview component that displays a thumbnail of the link target if defined.
The link field is an example that provides all three classes:
Any module can register a new field in the
fieldTypes node. Register
your field in your own module.
If you add the field to the UI Framework module it becomes globally available. Here is an example how the UI Framework module registers the text field.
You can configure field types in a YAML definition file inside a light module folder.
definitionClass: info.magnolia.ui.form.field.definition.TextFieldDefinition factoryClass: info.magnolia.ui.form.field.factory.TextFieldFactory
Once the field is registered, add it to a dialog or form by referencing
the field definition class in the
class property or by referencing the
field alias name in the
fieldType property. See
definition for more.
If you create a complex field and need to store values in the repository in a specific way, see Transforming field values.