Magnolia 5.7 reached extended end of life on May 31, 2022. Support for this branch is limited, see End-of-life policy. Please note that to cover the extra maintenance effort, this EEoL period is a paid extension in the life of the branch. Customers who opt for the extended maintenance will need a new license key to run future versions of Magnolia 5.7. If you have any questions or to subscribe to the extended maintenance, please get in touch with your local contact at Magnolia.

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.

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

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

Basic upload field properties

Simple basic upload field definition:

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

Node name

Value

 form


 tabs


 tabUpload


 fields


 upload


 allowedMimeTypePattern

text/xml

 binaryNodeName

import

 fieldType

basicUpload

 label

Import XML file

See Referencing fields for further information.

Properties:
<field name>

required

Name of the field.

allowedMimeTypePattern

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.

binaryNodeName

optional, default is binaryNodeName

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

editFileFormat

optional, default is false

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

editFileName

optional, default is false

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

maxUploadSize

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>

required

Name of the field

Empty view

dropZoneCaption

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

Text displayed as label for dropping invitation.

selectNewCaption

optional, default is Select a file to upload...

Text displayed as tooltip on the upload button.

warningNoteCaption

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

Text displayed in the warning note.

In progress view

inProgressCaption

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

Text displayed as title.

inProgressRatioCaption

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

Text displayed as file upload ratio.

Completed view

dropZoneCaption

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

Text displayed as label for dropping invitation.

errorNoteCaption

optional, default is An Error occurred while uploading your file

Text displayed in the error note.

fileDetailFormatCaption

optional, default is Format

Text displayed as file format label.

fileDetailHeaderCaption

optional, default is File detail

Text displayed as file detail header.

fileDetailNameCaption

optional, default is Name

Text displayed as file name label.

fileDetailSizeCaption

optional, default is Size

Text displayed as file size label.

fileDetailSourceCaption

optional, default is Source

Text displayed as file source label.

selectAnotherCaption

optional, default is Upload a new File...

Text displayed on the upload button.

sizeInterruption

optional, default is A file size limitation

Text displayed in the warning when file size > maxUploadSize

successNoteCaption

optional, default is Your file has been uploaded successfully

Text displayed in the success note.

typeInterruption

optional, default is An unsupported upload file type

Text displayed in the warning when file type not in allowedMimeTypePattern

userInterruption

optional, default is A user action

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

Common field properties:

fieldType

or

class

required

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

Use the Definitions app to check the correct form of the name.

defaultValue

optional

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

(info) Applied only when creating a new item, not for already existing items.

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 products.product.description. Use alphanumeric characters in literal values. Not applicable to the 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.

i18nBasename

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.

label

optional

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 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 label: " " in YAML.

name

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

optional

The placeholder text to be displayed in the empty field. The property replaces the deprecated placeholder text field.

(warning) 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.

readOnly

optional, default is false

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

required

optional, default is false

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

requiredErrorMessage

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.

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

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.

(warning) 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

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