Skip to content

Commit dc75e9c

Browse files
authored
Merge pull request mendix#10893 from r0b1n/update-file-uploader-docs
Document current state of file uploader widget
2 parents 9ead514 + 28878df commit dc75e9c

1 file changed

Lines changed: 32 additions & 12 deletions

File tree

content/en/docs/marketplace/platform-supported-content/modules/file-uploader.md

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: "Describes the configuration and usage of the File Uploader module,
77

88
## Introduction
99

10-
The [File Uploader](https://marketplace.mendix.com/link/component/235351) enables you to upload files or images by dragging and dropping them onto the widget, or by using the file selection dialog box.
10+
The [File Uploader](https://marketplace.mendix.com/link/component/235351) enables you to upload files or images by dragging and dropping them onto the widget, or by using the file selection dialog box.
1111

1212
It supports multi-file uploading, and includes an image-only mode that previews thumbnails of the uploaded images. The module comes with a domain model containing the entities and nanoflows it needs to function properly.
1313

@@ -54,7 +54,7 @@ For an advanced setup, useful when modifying the context entity is not possible,
5454

5555
#### General Tab {#general}
5656

57-
##### Upload mode
57+
##### Upload Mode
5858

5959
* **Files** — Allows all file types by default, and adds a configuration option to specify a custom set of allowed file types.
6060
* **Images** — Limits uploads to images and shows a preview thumbnail.
@@ -75,7 +75,7 @@ This configuration is only shown for the **Files** upload mode. Users can manual
7575

7676
##### Maximum Number of Files
7777

78-
This configuration sets a limit on how many files can be uploaded at once.
78+
This configuration sets a limit on how many files can be uploaded in total.
7979

8080
##### Maximum File Size (MB)
8181

@@ -87,15 +87,35 @@ Configures the displayed text used in **File Uploader**.
8787

8888
#### Advanced Tab {#advanced}
8989

90-
* **Object creation timeout** — Configures the timeouts to wait until object creation has failed. The value is in seconds.
91-
* **Enable custom buttons** — Allows the use of custom action buttons that will be displayed on the right side of file list instead of the standard
92-
buttons. If set to **Yes**, the default action buttons will be hidden.
93-
* **Custom buttons** — Adds custom buttons that will be used in file uploader.
94-
* **Caption** — Captions text configuration for the custom button.
95-
* **Icon** — Provides icon configuration for the custom button.
96-
* **Action** — Provides **On click** action configuration for the custom button.
97-
* **Default file action** — If set to **Yes**, the action in the button will be use as default click action for the file.
98-
* **Visible** — If set to **False**, the button will be hidden.
90+
##### Object Creation Timeout
91+
92+
Configures the timeout to wait until object creation has failed. The value is in seconds.
93+
94+
##### On Upload Success
95+
96+
This action runs after a successful upload. When uploading multiple files at once, it will run for every successfully uploaded file, and this file will be passed as an argument to the action.
97+
98+
##### On Upload Failure
99+
100+
This action runs when an upload to the server started, but failed during the process. The created object will be passed to the action. This is useful to perform cleanups from empty, dangling objects that were created but did not have content uploaded to them.
101+
102+
{{% alert color="info" %}}
103+
This action will not run if a validation error occurred on the client side, for example, if a provided file was too big or had an incorrect extension.
104+
{{% /alert %}}
105+
106+
##### Enable Custom Buttons
107+
108+
Allows the use of custom action buttons that will be displayed on the right side of the file list instead of the standard buttons. If set to **Yes**, the default action buttons will be hidden.
109+
110+
##### Custom Buttons
111+
112+
Adds custom buttons that will be used in the file uploader:
113+
114+
* **Caption** — Caption text configuration for the custom button.
115+
* **Icon** — Provides icon configuration for the custom button.
116+
* **Action** — Provides **On click** action configuration for the custom button.
117+
* **Default file action** — If set to **Yes**, the action in the button will be used as the default click action for the file.
118+
* **Visible** — If set to **False**, the button will be hidden.
99119

100120
### Nanoflows
101121

0 commit comments

Comments
 (0)