Upload
Collaborate with us
Edit this page on GitHub
The Upload widget lets users browse and select a local file, which you can then upload to the server.
Notes:
-
Users can drag a file to the Upload widget in most modern browsers. However, they can't do it in Internet Explorer 11, as that browser doesn't support drag-and-drop.
-
The widget can handle files up to 250MB. Larger files might not be loaded properly and end up empty, with a file size of 0 bytes.
Properties
| Name | Description | Mandatory | Default value | Observations |
|---|---|---|---|---|
| Name | Identifies an element in the scope where it is defined, like a screen, action, or module. | Yes | ||
| File Content | Holds the file selected by the user. | Yes | ||
| File Name | Holds the name of the file. | |||
| Accept | Specifies the type of UI placeholder. The placeholder hints the expected input type. | Yes | Image | The possible values are: Image, Video, Any. |
| Mandatory | Boolean literal or expression that defines if the widget is required. | Yes | False | |
| Style Classes | Specifies one or more style classes to apply to the widget. Separate multiple values with spaces. | "upload" | When Accept has the value Image, an additional class 'upload-image-withoverlay' is added to this property. | |
| Attributes | ||||
| Property | Name of an attribute to add to the HTML translation for this element. | You can pick a property from the drop-down list or type a free text. The name of the property will not be validated by the platform. Duplicated properties are not allowed. Spaces, " or ' are also not allowed. |
||
| Value | Value of the attribute. | You can type the value directly or write expressions using the Expression Editor. If the Value is empty, the corresponding HTML tag is created as property="property". For example, the nowrap property does not require a value, therefore nowrap="nowrap" is added. |
||
Events
| Name | Description | Mandatory | Observations |
|---|---|---|---|
| On Change | Screen action to be executed or a screen to navigate to when the value of the element changes. | ||
| Transition | Transition effect applied when navigating to another screen. | By default defined at module level. | |
| Event | JavaScript or custom event to be handled. | ||
| Handler | JavaScript event handler. |
Runtime Properties
| Name | Description | Read Only | Type | Observations |
|---|---|---|---|---|
| Id | Identifies the widget instance at runtime (HTML 'id' attribute). You can use it in JavaScript and Extended Properties. | Yes | Text | |
| Valid | False when required inputs are not present or the input value does not comply with the defined data type. You can override this property value when performing custom validations. | Boolean | ||
| ValidationMessage | Message describing the built-in validation constraints not satisfied when 'Valid' is False. You can override this property value when performing custom validations. | Text |