Magnolia 5.4 reached end of life on November 15, 2018. This branch is no longer supported, see End-of-life policy.
A field is an HTML form element that allows a user to perform a task such as enter text, upload an image or select a date. Magnolia ships with a number of fields that should fulfill most needs.
To add a field to your form, configure the class property and set its value to the field definition class name. This is the minimum configuration. All fields have common properties and field-specific properties you can also set.
The title fields in this example are all text fields:
Common field properties
The class property is set to info.magnolia.ui.form.field.definition.TextFieldDefinition. The class defines what type of field is rendered, in this case a text box. In addition to the class, all fields support common properties for defining things such as labels and descriptions. The text field also has its own properties. You can find the full field configuration in Git.
<module name>/dialogs/<dialog name>.yaml
form:
tabs:
- name: tabText
label: Text
fields:
- name: title
class: info.magnolia.ui.form.field.definition.TextFieldDefinition
label: pages.pageProperties.title.label
description: pages.pageProperties.title.description
i18n: true
required: true
type: string
| Node name | Value |
|---|---|
| info.magnolia.ui.form.field.definition.TextFieldDefinition | |
pages.pageProperties.title.description | |
| true | |
| pages.pageProperties.title.label | |
true | |
String |
You can use these properties with any field.
class | required Defines the field type such as Text or Link. The value is a fully-qualified field definition class name such as |
defaultValue | optional Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.
|
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, ge, 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
|
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 |
Applied only when creating a new item, not for already existing items.
Complex field definitions may define a different default transformer in their constructor. See Field definition classes
info.magnolia.ui.form.field.definition.TextFieldDefinitioninfo.magnolia.ui.form.field.definition.RichTextFieldDefinitioninfo.magnolia.ui.form.field.definition.DateFieldDefinitioninfo.magnolia.ui.form.field.definition.HiddenFieldDefinitioninfo.magnolia.ui.form.field.definition.LinkFieldDefinitioninfo.magnolia.ui.form.field.definition.MultiValueFieldDefinitioninfo.magnolia.ui.form.field.definition.PasswordFieldDefinitioninfo.magnolia.ui.form.field.definition.SelectFieldDefinitioninfo.magnolia.ui.form.field.definition.OptionGroupFieldDefinitioninfo.magnolia.ui.form.field.definition.TwinColSelectFieldDefinitioninfo.magnolia.ui.form.field.definition.CheckboxFieldDefinitioninfo.magnolia.ui.form.field.definition.CompositeFieldDefinitioninfo.magnolia.ui.form.field.definition.SwitchableFieldDefinitioninfo.magnolia.ui.form.field.definition.StaticFieldDefinitioninfo.magnolia.ui.form.field.definition.BasicUploadFieldDefinitioninfo.magnolia.dam.app.ui.field.definition.DamUploadFieldDefinition
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.SwitchableTransformerFor multivalue field:
info.magnolia.ui.form.field.transformer.multi.MultiValueTransformer
Other available transformer classes:
info.magnolia.ui.form.field.transformer.composite.DelegatingCompositeFieldTransformerinfo.magnolia.ui.form.field.transformer.multi.DelegatingMultiValueFieldTransformerinfo.magnolia.ui.form.field.transformer.composite.NoOpCompositeTransformerinfo.magnolia.ui.form.field.transformer.multi.MultiValueJSONTransformerinfo.magnolia.ui.form.field.transformer.multi.MultiValueChildrenNodeTransformerinfo.magnolia.ui.form.field.transformer.multi.MultiValueChildNodeTransformerinfo.magnolia.ui.form.field.transformer.multi.MultiValueSubChildrenNodeTransformer
Overview
Content Tools