Page tree
Skip to end of metadata
Go to start of metadata

A field is an HTML form element that allows you to perform a task such as enter text, upload an image or select a date.

This field definition is part of the Magnolia 6 UI framework. The fully qualified class name is info.magnolia.ui.field.FieldDefinition.

If you work with the Magnolia 5 UI framework, see Field definition for Magnolia 5 UI instead.

Example definition

To add a field to your form, you need to define a field. Field definition must contain a class or $type property, which tells Magnolia what type of field to render. Set the property value to a fully qualified class name (for class) or field alias (for $type). Depending on the field type, a number of common simple field properties or complex field properties are supported.

firstName:
  label: First name
  $type: textField
  required: true
lastName:
  label: Last name
  $type: textField
  required: true
email:
  label: Email
  $type: textField
  required: true
  validators:
    email:
      $type: emailValidator

Common simple field properties

You can use the following properties with any simple field (all except composite, multi and switchable fields).

name

required

Name of the field definition item. Derived from the configured node name. Use alphanumeric characters without spaces.

class

required (unless $type is used)

Type of the field definition item. The value must be a fully qualified class name and a subtype of info.magnolia.ui.field.FieldDefinition. See Field types for possible values.

$type

You can use this as a shortcut for class if the definition class is annotated with info.magnolia.ui.field.FieldType. The proper value is defined by the annotation.

Example class annotation
@FieldType("textField")
public class TextFieldDefinition extends ConfiguredFieldDefinition<String> {
...
}

See Field types for possible values.

type

requireddefault is java.lang.String

Model type of the field. Use the fully qualified class name. See PropertyType for possible values.

A default type is typically hard-coded in each definition class. You only need to add this property if you want to override the default implementation (for example, with java.lang.Long).

converterClass

optional

Converts values between presentation (UI) and model (stored data). The property must extend com.vaadin.data.Converter.

conversionErrorMessage

optional, default is translated conversion.message.error key

Message shown when there is an error in the conversion process. The value can be literal or a key of a message bundle. Use alphanumeric characters in literal values.

defaultValue

optional

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

(info) Applied only when creating a new item, not for already existing items.

description

optional

Help text displayed when the user clicks the help icon. The value can be literal or a key of a message bundle.

factoryClass

optional

Defines the factory class that initializes and builds the Vaadin form field. The default factory class depends on the particular field.

The value must be a fully qualified class name and a subtype of info.magnolia.ui.field.FieldFactory.

fieldBinderClass

optional

Defines the binder class that applies configuration parameters from the field.

i18n

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, de, fr, etc.) is displayed on controls where i18n is set to true.

label

optional

Field label displayed to editors. The value can be literal or a key of a message bundle.

If you do not provide the property, Magnolia will fall back to a generated i18n key.

If you do not want a label at all, define the property and set its value to a blank space such as label: " " in YAML.

readOnly

optional, default is false

Makes the field uneditable.

required

optional, default is false (not relevant for checkbox field)

Makes the field required. An asterisk is displayed next to the field label.

requiredErrorMessage

optional, default is translated validation.message.required key

Error message shown when required is set to true and the user saves an empty field. The value can be literal or a key of a message bundle. Use alphanumeric characters in literal values.

styleName

optional

Additional style information for an editor property definition item applied to the element when the form is rendered.

The value can be a CSS class or a list of CSS classes separated by white spaces.

validators 

optional

List of field validator definition items. The value must be a subtype of info.magnolia.ui.field.FieldValidatorDefinition.

See Field validators for more information.

Common complex field properties

You can use the following properties with any complex field (composite, multi and switchable fields).

name

required

Name of the field definition item. Derived from the configured node name. Use alphanumeric characters without spaces.

class

required (unless $type is used)

Type of the field definition item. The value must be a fully qualified class name and a subtype of info.magnolia.ui.field.FieldDefinition. See Field types for possible values.

$type

You can use this as a shortcut for class if the definition class is annotated with info.magnolia.ui.field.FieldType. The proper value is defined by the annotation.

Example class annotation
@FieldType("textField")
public class TextFieldDefinition extends ConfiguredFieldDefinition<String> {
...
}

See Field types for possible values.

itemProvider

required, default is

  • JcrPropertyProvider for JcrMultiValueFieldDefinition
  • JcrChildNodeProviderDefinition for JcrMultiFieldDefinition

Node with a $type property that specifies the type of data binding for the subnodes in complex fields.

See Item providers for more information.

description

optional

Help text displayed when the user clicks the help icon. The value can be literal or a key of a message bundle.

i18n

optionaldefault is false

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

label

optional

Field label displayed to editors. The value can be literal or a key of a message bundle.

If you do not provide the property, Magnolia will fall back to a generated i18n key.

If you do not want a label at all, define the property and set its value to a blank space such as label: " " in YAML.

styleName

optional

Additional style information for an editor property definition item applied to the element when the form is rendered.

The value can be a CSS class or a list of CSS classes separated by white spaces.

Field types

$typeclass
checkBoxFieldinfo.magnolia.ui.field.CheckBoxFieldDefinition
checkBoxGroupFieldinfo.magnolia.ui.field.CheckBoxGroupFieldDefinition
codeFieldinfo.magnolia.ui.field.CodeFieldDefinition

comboBoxField

jsonComboBoxField

info.magnolia.ui.field.ComboBoxFieldDefinition

info.magnolia.rest.ui.field.comboboxfield.JsonComboBoxFieldDefinition

compositeField

jsonCompositeField

info.magnolia.ui.field.CompositeFieldDefinition

info.magnolia.rest.ui.field.JsonCompositeFieldDefinition

dateFieldinfo.magnolia.ui.field.DateFieldDefinition
hiddenFieldinfo.magnolia.ui.field.HiddenFieldDefinition

linkField

damLinkField

pageLinkField

jsonLinkField

info.magnolia.ui.field.LinkFieldDefinition

info.magnolia.dam.app.field.DamLinkFieldDefinition

info.magnolia.pages.app.field.PageLinkFieldDefinition

info.magnolia.rest.ui.field.linkfield.JsonLinkFieldDefinition

listSelectFieldinfo.magnolia.ui.field.ListSelectFieldDefinition

multiField

jcrMultiValueField

jcrMultiField

jsonMultiField

info.magnolia.ui.field.MultiFieldDefinition

info.magnolia.ui.field.JcrMultiValueFieldDefinition

info.magnolia.ui.field.JcrMultiFieldDefinition

info.magnolia.rest.ui.field.JsonMultiFieldDefinition

passwordFieldinfo.magnolia.ui.field.PasswordFieldDefinition
radioButtonGroupFieldinfo.magnolia.ui.field.RadioButtonGroupFieldDefinition
richTextFieldinfo.magnolia.ui.field.RichTextFieldDefinition
sliderFieldinfo.magnolia.ui.field.SliderFieldDefinition
staticFieldinfo.magnolia.ui.field.StaticFieldViewDefinition
switchableFieldinfo.magnolia.ui.field.SwitchableFieldDefinition
textFieldinfo.magnolia.ui.field.TextFieldDefinition
tokenFieldinfo.magnolia.ui.field.TokenFieldDefinition
twinColSelectFieldinfo.magnolia.ui.field.TwinColSelectFieldDefinition

Your Magnolia installation may contain more fields depending on the installed modules.

  • No labels