Basic upload field - 5 UI


This basic upload field definition has been deprecated since Magnolia 6.0. It is part of the Magnolia 5 UI framework.

For the updated implementation, see Upload field for Magnolia 6 UI instead.

BasicUploadFieldDefinition renders a field to upload a file to a Magnolia JCR workspace. The file is stored on the node of the current context of the form (within a dialog or subApp), which could be a content app item, a page or a component of a page.

class: info.magnolia.ui.form.field.definition.BasicUploadFieldDefinition

fieldType: basicUpload

The basic upload field has three states. You can set properties for each.

  • Empty is the starting point where no file has been selected. You can select a file with the button or drag it into the box.

Empty field in the Import dialog

  • In progress displays a progress bar and incremental percentages and uploaded/total ratio.

In progress field in the Import dialog uploading a file

  • Completed displays a success notification and summary of file info.

Completed field in the Import dialog

Basic upload field properties

Simple basic upload field definition:

    - name: tabUpload
      label: Upload
        - name: upload
          fieldType: basicUpload
          label: Upload
          allowedMimeTypePattern: text/xml
          binaryNodeName: import

Referencing fields shortcut info - 5 UI

See Referencing fields for further information.

Common upload field properties - 5 UI

Property Description

<field name>


Name of the field.


optional, default is .* (all types)

Regular expression to filter allowed files by their MIME type. For example, to allow only Excel files set the value to application.(excel|xls). To allow images only, set the value to image.. For more information about the supported pattern, see Pattern. For digital asset management MIME types see MediaType.


optional, default is binaryNodeName

Name of the subnode that will contain the file binary and related information.


optional, default is false

When set to true, the file extension displayed in the Format field is editable.


optional, default is false

When set to true, the file name displayed in the Name field is editable.


optional, default is 2^63 (9.2 EB)

Maximum file size in bytes.

Caption properties. Values are typically retrieved from a message bundle.

<field name>


Name of the field

Empty view


optional, default is or <em>drag a file into this area</em> to upload it

Text displayed as label for dropping invitation.


optional, default is Select a file to upload…​

Text displayed as tooltip on the upload button.


optional, default is You have aborted the upload of your file

Text displayed in the warning note.

In progress view


optional, default is Uploading file {0}...

Text displayed as title.


optional, default is {0} of {1} uploaded

Text displayed as file upload ratio.

Completed view


optional, default is Upload a new File…​

Text displayed as tooltip on the delete icon.


optional, default is An Error occurred while uploading your file

Text displayed in the error note.


optional, default is Format

Text displayed as file format label.


optional, default is File detail

Text displayed as file detail header.


optional, default is Name

Text displayed as file name label.


optional, default is Size

Text displayed as file size label.


optional, default is Source

Text displayed as file source label.


optional, default is Upload a new File…​

Text displayed on the upload button.


optional, default is A file size limitation

Text displayed in the warning when file size > maxUploadSize


optional, default is Your file has been uploaded successfully

Text displayed in the success note.


optional, default is An unsupported upload file type

Text displayed in the warning when file type not in allowedMimeTypePattern


optional, default is A user action

Text displayed in the warning when the user interrupts the upload.

Common field properties - 5 UI

Property Description

fieldType`or `class


Defines the field type via either a field alias name or a fully-qualified field definition class name. See Field definition: Field types.

To check the correct form of the name, use the Definitions app.



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.



Help text displayed when the user clicks the help icon. The value can be literal or retrieved from the message bundle with a key. Use alphanumeric characters in literal values. Not applicable to the static field.


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.


optional, default is the message bundle defined in the dialog definition_

Message bundle such as com.example.messages for localized field labels. You can set this property in the parent dialog, form or tab definition. Child fields will inherit the bundle.



Field label displayed to editors. The value can be literal such as Product name or retrieved from the message bundle with a key such as products.product.label. Use alphanumeric characters in literal values.

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

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.


optional, default is the name of the field’s parent node_

Name of the node where the value is saved. The name jcrName is reserved. Use alphanumeric characters.



Placeholder text to be displayed when the field is empty. The value is i18n-able.

Applicable to text, link and combobox fields.


optional, default is false

Makes the field uneditable. Adding this property has the same effect as creating a static field.


optional, default is false

Makes the field required (mandatory). An asterisk is displayed next to the field label. See also Checking for null values.


optional, default is This field is required

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 validation.message.required.



Adds one or more style names to this component. Multiple styles can be specified as a space-separated list of style names such as checkbox disabled. 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.



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.

Complex field definitions may define a different default transformer in their constructor. See Transforming field values for more.


optional, most fields set a default value automatically

JCR property type of the stored value such as String, Boolean, Date or any other supported and defined data type.

When using the basic upload field in a composite or multivalue field, use the DelegatingCompositeFieldTransformer. The other transformer classes do not work.


DX Core



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
6.3 beta

Magnolia 6.3 beta

Magnolia 6.3 is in beta. We are updating docs based on development and feedback. Consider the 6.3 docs currently in a state of progress and not final.

We are working on some 6.3-beta known issues during this phase.