Magnolia 6.1 reached end of life on March 31, 2021. This branch is no longer supported, see End-of-life policy.
class | required Defines the field type such as Text or Link. The value is a fully-qualified field definition class name such as Can be replaced with the |
fieldType | required Defines the field type via a field alias name such as May be used instead of the |
defaultValue | optional Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters. Applied only when creating a new item, not for already existing items. |
i18n | optional , default is 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 |
name | optional , default is the name of the field's parent node Name of the node where the value is saved. The name |
readOnly | optional , default is Makes the field uneditable. Adding this property has the same effect as creating a Static field. |
required | optional , default is Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values. |
requiredErrorMessage | optional , default is 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 |
styleName | optional Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names such as |
transformerClass | optional 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 Complex field definitions may define a different default transformer in their constructor. See Transforming field values for more. |
type | optional , most fields set a default value automatically JCR property type of the stored value such as |
i18nBasename | optional , default is the message bundle defined in the dialog definition Message bundle such as |
label | optional Field label displayed to editors. The value can be literal such as If you don't provide the property then Magnolia falls back to a generated i18n key and displays they key in the UI. If you don't want a label at all then define the property and set its value to empty space such as |
description | optional 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 |
placeholder | optional The placeholder text to be displayed in the empty field. The property replaces placeholder text field. Applicable in text and link fields. The field is optional, but you should provide a translation or a hard-coded label, otherwise the empty field will display its auto-generated 18n key instead. |