You can use these properties with any field.



Defines the field type such as Text or Link. The value is a fully-qualified field definition class name such as info.magnolia.ui.form.field.definition.TextFieldDefinition.



Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.


optional, default is false

Enables i18n authoring support which allows editors to write foreign-language or regionally targeted content. A two-letter language identifier (en, ge, fr etc.) is displayed on controls where i18n is set to true.


optional, default is the name of the field's parent node

Name of the node where the value is saved. The name jcrName is reserved. Use alphanumeric characters.


optional, default is false

Makes the field uneditable. Adding this property has the same effect as creating a Static field.


optional, default is false

Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values.


optional, default is "This field is required"

Error message displayed when required is true and the user saves an empty field. The value can be literal or retrieved from the  message bundle  with a  key  such as  validation.message.required.



Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names such as checkbox disabled. The style name will be rendered as an HTML class name, which can be used in a CSS definition. The class name is added to the field by calling the Vaadin method addStyleName.



Property transformer classes define how field values are stored in the repository. Each field has a default transformer class. You don't need to define a class unless you want to override the default. The value is a fully-qualified class name such as info.magnolia.ui.form.field.transformer.composite.CompositeTransformer.

(warning) Complex field definitions may define a different default transformer in their constructor.

Transforming field values documentation


optional, most fields set a default value automatically

JCR property type of the stored value such as String, Boolean, Date or any other supported and defined data type. 


optional, default is the message bundle defined in the dialog definition

Message bundle such as com.example.messages for localized field labels. You can set this property in the parent dialog, form or tab definition. Child fields will inherit the bundle.

(info) Starting with Magnolia 5.1, the i18nBasename, label and description properties are optional in fields. The new i18n API finds your message bundle automatically and loads the relevant UI text.



Field label displayed to editors. The value can be literal such as Product name or retrieved from the message bundle with a key such as products.product.label. Use alphanumeric characters in literal values.



Help text displayed when the user clicks the help icon. The value can be literal or retrieved from the message bundle with a key such as products.product.description. Use alphanumeric characters in literal values. Not applicable to the Static field.

Field definition classes

  • info.magnolia.ui.form.field.definition.TextFieldDefinition
  • info.magnolia.ui.form.field.definition.RichTextFieldDefinition
  • info.magnolia.ui.form.field.definition.DateFieldDefinition
  • info.magnolia.ui.form.field.definition.HiddenFieldDefinition
  • info.magnolia.ui.form.field.definition.LinkFieldDefinition
  • info.magnolia.ui.form.field.definition.MultiValueFieldDefinition
  • info.magnolia.ui.form.field.definition.PasswordFieldDefinition
  • info.magnolia.ui.form.field.definition.SelectFieldDefinition
  • info.magnolia.ui.form.field.definition.OptionGroupFieldDefinition
  • info.magnolia.ui.form.field.definition.TwinColSelectFieldDefinition
  • info.magnolia.ui.form.field.definition.CheckBoxFieldDefinition
  • info.magnolia.ui.form.field.definition.CompositeFieldDefinition
  • info.magnolia.ui.form.field.definition.SwitchableFieldDefinition
  • info.magnolia.ui.form.field.definition.StaticFieldDefinition
  • info.magnolia.ui.form.field.definition.BasicUploadFieldDefinition

Transformer classes

Default transformer classes:
  • For simple fields such as Text and Date: info.magnolia.ui.form.field.transformer.basic.BasicTransformer
  • For composite fields: info.magnolia.ui.form.field.transformer.composite.CompositeTransformer
  • For switchable fields: info.magnolia.ui.form.field.transformer.composite.SwitchableTransformer

  • For multivalue field: info.magnolia.ui.form.field.transformer.multi.MultiValueTransformer 

Other available transformer classes:

  • info.magnolia.ui.form.field.transformer.composite.DelegatingCompositeFieldTransformer(warning) Magnolia 5.2.5+
  • info.magnolia.ui.form.field.transformer.multi.DelegatingMultiValueFieldTransformer(warning) Magnolia 5.2.5+
  • info.magnolia.ui.form.field.transformer.composite.NoOpCompositeTransformer
  • info.magnolia.ui.form.field.transformer.multi.MultiValueJSONTransformer
  • info.magnolia.ui.form.field.transformer.multi.MultiValueChildrenNodeTransformer
  • info.magnolia.ui.form.field.transformer.multi.MultiValueChildNodeTransformer
  • info.magnolia.ui.form.field.transformer.multi.MultiValueSubChildrenNodeTransformer

#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))