Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

properties

required

A list of editor property definition items (typically, a list of fields).

name

required

The name of the editor property definition item. Use alphanumeric characters without spaces.

class

required (unless $type is used)

The type of the editor property definition item. The value must be a fully qualified class name and a subtype of info.magnolia.ui.field.EditorPropertyDefinition. See Form definition - 6 UI for possible values.

If the definition class is annotated with info.magnolia.ui.field.FieldType, you can use the $type property instead.

$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.

Code Block
languagejava
titleExample class annotation
collapsetrue
@FieldType("textField")
public class TextFieldDefinition extends ConfiguredFieldDefinition<String> {
...
}

To use the $type property in YAML, see Form definition - 6 UI. Refer also to Form definition - 6 UI.

description

optional

Help text displayed when the user clicks the help icon. The value can be literal or a key of a message bundle. Not applicable to a static 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.

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 spacesSee Field definition for more information.

layout

optional, default is info.magnolia.ui.framework.layout.PlainFormLayoutDefinition

The value must be a fully qualified class name and a subtype of info.magnolia.ui.framework.layout.LayoutDefinition.

See Form definition - 6 UI for more information.

...