Upload field

This upload field definition has been deprecated since Magnolia 6.2.4. Do not use it to upload assets directly to an app workspace. Instead, store your assets in the DAM workspace and link to them using a link field. UploadFieldDefinition can still be used to configure a DAM upload field.

info.magnolia.ui.field.UploadFieldDefinition renders a field for uploading a file to a Magnolia JCR workspace. The file is stored in the current node of the form, which can be a content app item, a page or a component.

Use info.magnolia.ui.field.factory.UploadFieldFactory for any custom implementation of the field. If no factory class is configured, the default field will be rendered.

Example definition

upload:
  $type: uploadField
  label: Upload
  allowedMimeTypePattern: text/xml

You can preview this example using the field-examples-module. See Field examples module for more information.

Field properties

Common upload field properties

Property Description

allowedMimeTypePattern

optional, default is all types

Comma-separated list of allowed MIME types. Examples include image/*, application/pdf, audio/* and video/*. For a full list, see IANA Media Types.

You can also specify file extensions for each MIME type in the list. This is needed in particular for the application/x-yaml MIME type. In this case, you must also add the file extension: application/x-yaml,.yaml. You don’t need to add extensions for other MIME types.
When allowedMimeTypePattern is defined, a validation message can be configured using the typeAbortMessage property (see Generic i18n keys).

maxUploadSize

optional, default is 2^63 (9.2 EB)

Maximum file size in bytes.

When maxUploadSize is defined, a validation message must be configured using the sizeAbortMessage property (see Generic i18n keys). The sizeAbortMessage property applies to dragging and dropping an item directly into the upload field.


You can also use the sizeInterruption property to customize the default file limitation message, as shown in the example below. The message is always shown for both the upload button and when you drag and drop directly into the upload area.

photo:
  $type: compositeField
  layout:
    class: info.magnolia.ui.framework.layout.SingleFieldLayoutProducer$Definition
  itemProvider:
    $type: jcrChildNodeProvider
  properties:
    image:
      class: info.magnolia.dam.app.field.DamUploadFieldDefinition
      allowedMimeTypePattern: image/*
      maxUploadSize: 10
      sizeInterruption: "A file size limitation"
      sizeAbortMessage: "Your file is too large"

Common simple field properties

Property Description

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

optional

Property type of the field.

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.

In text fields, make sure that type has a value matching the type of data you entered (for example, java.lang.Long for long values) and that converterClass is set accordingly.

A scenario where you might require users to enter a particular numerical type is, for example, sorting the delivery REST JSON on your frontend.

Long example definition
text:
  $type: textField
  type: java.lang.Long
  converterClass: com.vaadin.data.converter.StringToLongConverter
Double example definition
text:
  $type: textField
  type: java.lang.Double
  converterClass: com.vaadin.data.converter.StringToDoubleConverter

You can’t configure this property through YAML but it can be used in your Java code.

converterClass

optional

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

  • info.magnolia.ui.editor.converter.JcrNodeToIdentifierConverter

  • info.magnolia.ui.editor.converter.JcrNodeToPathConverter

  • info.magnolia.ui.editor.converter.JcrNodeToWorkspaceAndIdConverter

  • info.magnolia.ui.editor.converter.JcrPathToIdentifierConverter

com.vaadin.data.converter.StringToBigDecimalConverter and com.vaadin.data.converter.StringToDoubleConverter always round the presentation value by default. For non-rounding converters, use the following classes instead:

  • info.magnolia.ui.field.converter.NonRoundingStringToBigDecimalConverter

  • info.magnolia.ui.field.converter.NonRoundingStringToDoubleConverter

You can’t configure this property through YAML but it can be used in your Java code.

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.

defaultValue

optional

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

This is only applied only when creating a new item, not for existing items.

For defaultValue to work, the populate property in info.magnolia.ui.dialog.actions.OpenDialogActionDefinition must be set to false.

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.

You can’t configure this property through YAML but it can be used in your Java code.

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.

For more details, see i18n in New UI Forms and Vaadin forms.

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 to have any label, set the property to an empty string 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. When true, an asterisk is displayed next to the field label.

When false, empty values are accepted as valid. For those empty values, any field validators are ignored.

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.

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.

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.

The referenced class can be defined in:

validators

optional

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

See Field validators for more information.

i18n in New UI Forms and Vaadin forms

The rendering and behavior of internationalization (i18n) differ between the fields of the New UI Forms and the older Vaadin forms.

Fields with i18n: true
New UI Forms Vaadin

No language identifier is displayed next to the field’s name.

The field value you edit there and save is stored only for the selected language variant.

A two-letter language identifier (for example, en, de, fr) is displayed next to the field, as shown below on the right side of the screenshots - en or de next to the "Body Text" name of the rich text field.

The field value you edit there and save is stored only for the selected language variant.
Fields with i18n: false (or not set, as false is the default)
New UI Forms Vaadin

Editing is only possible in the default language. The field is disabled in non-default language views.

A globe icon is displayed next to the field.

Hovering over the globe icon shows a tooltip with the following messages:

  • In the default language view: "Global field. The field’s value is the same across all language variants."

  • In non-default language views: "Global field. Switch to the default language (<default language name>) to edit this field."

No language identifier is displayed next to the field’s name.

The field is editable.

The value you enter there and save is applied to all language variants.

Default language form views (English)

Rendering of fields in forms in the default language (English)

Non-default language form views (German)

Rendering of fields in forms in a non-default language (German)
Related topics
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules