Basic upload field

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

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
          class: info.magnolia.ui.form.field.definition.BasicUploadFieldDefinition
          label: Upload
          allowedMimeTypePattern: text/xml
          binaryNodeName: import

Node name	Value
form
tabs
tabUpload
fields
upload
allowedMimeTypePattern	text/xml
binaryNodeName	import
class	info.magnolia.ui.form.field.definition.BasicUploadFieldDefinition
label	Import XML file

You can use common field properties and the properties in the tables below in a basic upload field definition:

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
`selectNewCaption`	optional, default is `Select a file to upload...` Text displayed as tooltip on the upload button.
`dropZoneCaption`	optional, default is `or <em>drag a file into this area</em> to upload it` Text displayed as label for dropping invitation.
`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
`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.
`fileDetailFormatCaption`	optional, default is `Format` Text displayed as file format label.
`fileDetailSourceCaption`	optional, default is `Source` Text displayed as file source label.
`deleteCaption`	optional, default is `Upload a new File...` Text displayed as tooltip on the delete icon.
`selectAnotherCaption`	optional, default is `Upload a new File...` Text displayed on the upload button.
`successNoteCaption`	optional, default is `Your file has been uploaded successfully` Text displayed in the success note.
`errorNoteCaption`	optional, default is `An Error occurred while uploading your file` Text displayed in the error note.
`sizeInterruption`	optional, default is `A file size limitation` Text displayed in the warning when file size > `maxUploadSize`
`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.

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

Page tree

Basic upload field

Basic upload field properties