Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: MOTION-157

Status
colourRed
titleDeprecated

Note

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.

Javadoc resource link
rangeHigherVersion6.0
classNameinfo.magnolia.ui.form.field.definition.BasicUploadFieldDefinition
renderTypeasynchronous
 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.

Image Added

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

Image Added

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

Image Added

Table of Contents

Basic upload field properties

Simple basic upload field definition:

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

Include Page
_Referencing fields shortcut info - 5 UI
_Referencing fields shortcut info - 5 UI

Include Page
_Common upload field properties - 5 UI
_Common upload field properties - 5 UI

Common field properties:

Include Page
_Common field properties - 5 UI
_Common field properties - 5 UI

Info

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