[MGNLUI-6822] DOC: New properties, default values and i18n keys for 'UploadFieldDefinition' Created: 13/Aug/21  Updated: 25/Aug/21  Resolved: 25/Aug/21

Status: Closed
Project: Magnolia UI
Component/s: None
Affects Version/s: 6.2.12
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Ashraf Khamis Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: fields, i18n, upload
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
documentation
documents MGNLUI-6390 allowedMimeTypePattern property doesn... Closed
documents MGNLUI-6543 maxUploadSize property doesn't work a... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Epic Link: Migrate Assets
Sprint: UI FW 35
Story Points: 3

 Description   

The following properties should be added to https://docs.magnolia-cms.com/product-docs/6.2/Templating/Dialog-definition/Field-definition/List-of-fields/Upload-field.html#_common_upload_field_properties:

  • typeAbortMessage (default is translated fields.uploadField.upload.abort key)
  • sizeAbortMessage (the value is i18n-able)

https://git.magnolia-cms.com/projects/PLATFORM/repos/ui/browse/magnolia-ui-framework/src/main/java/info/magnolia/ui/field/UploadFieldDefinition.java#79-80

The allowedMimeTypePattern property is no longer a regex pattern. Instead, it is a list of accepted MIME types with possible wildcards. The default value is "" (all types).

https://git.magnolia-cms.com/projects/PLATFORM/repos/ui/browse/magnolia-ui-framework/src/main/java/info/magnolia/ui/field/UploadFieldDefinition.java#77

For more information, see this Magnolia DAM app configuration snippet (https://git.magnolia-cms.com/projects/MODULES/repos/dam/browse/magnolia-dam-app-jcr/src/main/resources/dam-app-jcr/dialogs/uploadAndEdit.yaml#9) or https://vaadin.com/docs/latest/ds/components/upload/#upload-restrictions.

If used, the following i18n key needs to be configured in the Assets app (see https://docs.magnolia-cms.com/product-docs/6.2/Administration/Language/Generic-i18n-keys.html for other apps):

  • dam.upload.field.sizeAbortMessage


 Comments   
Comment by Ashraf Khamis [ 25/Aug/21 ]

Added notes about typeAbortMessage and sizeAbortMessage and updated the description for allowedMimeTypePattern as well as the upload and DAM upload fields at https://docs.magnolia-cms.com/product-docs/6.2/Templating/Dialog-definition/Field-definition/List-of-fields/Upload-field.html and https://docs.magnolia-cms.com/product-docs/6.2/Apps/List-of-apps/Magnolia-Assets-subapp/DAM-upload-field.html. Deleted all common label properties and moved https://docs.magnolia-cms.com/product-docs/6.2/Templating/Dialog-definition/Field-definition/List-of-fields/Upload-field.html back under https://docs.magnolia-cms.com/product-docs/6.2/Templating/Dialog-definition/Field-definition.html.

Reviewed by Adam & Roman.

Generated at Mon Feb 12 09:40:21 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.