You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -178,35 +178,35 @@ You can't modify the original fields of a doctype, so create a new field or clon
178
178
### Available Field Options
179
179
| Option | Description |
180
180
| :--- | :--- |
181
-
|**dialog_title**| Upload dialog title to be displayed ️(🔶Frappe >= v14.0.0).<br /><br />🔹Example: **"Upload Images"**<br />🔹Default: **"Upload"**|
182
-
|**upload_notes**| Upload text to be displayed.<br /><br />🔹Example: **"Only images and videos, with maximum size of 2MB, are allowed to be uploaded"**<br />🔹Default: **""**|
183
-
|**disable_auto_save**| Disable form auto save after upload.<br /><br />🔹Default: **false**|
184
-
|**disable_file_browser**| Disable file browser uploads.<br /><br />⚠️ *(File browser is always disabled in Web Form)*<br /><br />🔹Default: **false**|
185
-
|**allow_multiple**| Allow multiple uploads.<br /><br />⚠️ *(Field value is a JSON array of files url)*<br /><br />🔹Default: **false**|
186
-
|**max_file_size**| Maximum file size (in bytes) that is allowed to be uploaded.<br /><br />🔹Example: **2048** for **2KB**<br />🔹Default: **Value of maximum file size in Frappe's settings**|
187
-
|**allowed_file_types**| Array of allowed file types (mimes) or extensions to upload. Prefix escaped RegExp string types with **$**.<br /><br />⚠️ *(File extensions must have a leading dot ".")*<br />⚠️ *(RegExp string types will not be used to in HTML accept attribute)*<br /><br />🔹Example: **["image/*", "video/*", ".pdf", ".doc", "$audio\/([a-z]+)"]**<br />🔹Default: **null** or **["image/*"]**|
188
-
|**max_number_of_files**| Maximum number of files allowed to be uploaded if multiple upload is allowed.<br /><br />⚠️ *(Bypassing the maximum attachments of doctype might not work)*<br /><br />🔹Example: **4**<br />🔹Default: **Value of maximum attachments set for the doctype**|
189
-
|**crop_image_aspect_ratio**| Crop aspect ratio for images (🔶Frappe >= v14.0.0).<br /><br />🔹Example: **1** or **16/9** or **4/3**<br />🔹Default: **null**|
190
-
|**as_public**| Force uploads to be saved in public folder by default.<br /><br />🔹Default: **false**|
191
-
|**allowed_filename**| Only allow files that match a specific file name to be uploaded.<br /><br />🔹Example: (String)**"picture.png"** or (RegExp String)**"/picture\-([0-9]+)\.png/"**<br />🔹Default: **null**|
192
-
|**allow_reload**| Allow reloading attachments (🔶Frappe >= v13.0.0).<br /><br />🔶 Affect the visibility of the reload button.🔶<br /><br />🔹Default: **true**|
193
-
|**allow_remove**| Allow removing and clearing attachments.<br /><br />🔶 Affect the visibility of the remove and clear buttons.🔶<br /><br />🔹Default: **true**|
194
-
|**users** 🔴 | Array of custom options for a specific user or group of users.<br /><br />🔹Example: **[{"for": "Guest", "disabled": true}, {"for": ["Administrator", "user"], "allow_multiple": true}]**<br />🔹Default: **null**|
195
-
|**roles** 🔴 | Array of custom options for a specific role or group of roles.<br />⚠️ *(Custom options for users is prioritized over roles.)*<br /><br />🔹Example: **[{"for": ["Administrator", "System"], "allow_multiple": true}]**<br />🔹Default: **null**|
196
-
197
-
🔴 New - 🔶 Changed
181
+
|**dialog_title**| Upload dialog title to be displayed ️(🔶Frappe >= v14.0.0).<br /><br />🔹Example: ```"Upload Images"```<br />🔹Default: ```"Upload"```|
182
+
|**upload_notes**| Upload text to be displayed.<br /><br />🔹Example: ```"Only images and videos, with maximum size of 2MB, are allowed to be uploaded"```<br />🔹Default: ```""```|
183
+
|**disable_auto_save**| Disable form auto save after upload.<br /><br />🔹Default: ```false```|
184
+
|**disable_file_browser**| Disable file browser uploads.<br /><br />⚠️ *(File browser is always disabled in Web Form)*<br /><br />🔹Default: ```false```|
185
+
|**allow_multiple**| Allow multiple uploads.<br /><br />⚠️ *(Field value is a JSON array of files url)*<br /><br />🔹Default: ```false```|
186
+
|**max_file_size**| Maximum file size (in bytes) that is allowed to be uploaded.<br /><br />🔹Example: ```2048``` for ```2KB```<br />🔹Default: ```Value of maximum file size in Frappe's settings```|
187
+
|**allowed_file_types**| Array of allowed file types (mimes) or extensions to upload. Prefix escaped RegExp string types with ```$```.<br /><br />⚠️ *(File extensions must have a leading dot ".")*<br />⚠️ *(RegExp string types will not be used to in HTML accept attribute)*<br /><br />🔹Example: ```["image/*", "video/*", ".pdf", ".doc", "$audio\/([a-z]+)"]```<br />🔹Default: ```null``` or ```["image/*"]```|
188
+
|**max_number_of_files**| Maximum number of files allowed to be uploaded if multiple upload is allowed.<br /><br />⚠️ *(Bypassing the maximum attachments of doctype might not work)*<br /><br />🔹Example: ```4```<br />🔹Default: ```Value of maximum attachments set for the doctype```|
189
+
|**crop_image_aspect_ratio**| Crop aspect ratio for images (🔶Frappe >= v14.0.0).<br /><br />🔹Example: ```1``` or ```16/9``` or ```4/3```<br />🔹Default: ```null```|
190
+
|**as_public**| Force uploads to be saved in public folder by default.<br /><br />🔹Default: ```false```|
191
+
|**allowed_filename**| Only allow files that match a specific file name to be uploaded.<br /><br />🔹Example: (String)```"picture.png"``` or (RegExp String)```"/picture\-([0-9]+)\.png/"```<br />🔹Default: ```null```|
192
+
|**allow_reload**| Allow reloading attachments (🔶Frappe >= v13.0.0).<br /><br />🔶 Affect the visibility of the reload button.🔶<br /><br />🔹Default: ```true```|
193
+
|**allow_remove**| Allow removing and clearing attachments.<br /><br />🔶 Affect the visibility of the remove and clear buttons.🔶<br /><br />🔹Default: ```true```|
194
+
|**users** 🔴 | Array of custom options for a specific user or group of users.<br /><br />🔹Example: ```[{"for": "Guest", "disabled": true}, {"for": ["Administrator", "user"], "allow_multiple": true}]```<br />🔹Default: ```null```|
195
+
|**roles** 🔴 | Array of custom options for a specific role or group of roles.<br />⚠️ *(Custom options for users is prioritized over roles.)*<br /><br />🔹Example: ```[{"for": ["Administrator", "System"], "allow_multiple": true}]```<br />🔹Default: ```null```|
196
+
197
+
🔴 New - 🔵 Changed
198
198
199
199
---
200
200
201
201
### Available JavaScript Methods
202
202
| Method | Description |
203
203
| :--- | :--- |
204
-
|**toggle_auto_save(enable: Boolean !Optional)**🔶| Enable/Disable form auto save after upload. |
204
+
|**toggle_auto_save(enable: Boolean !Optional)**🔵| Enable/Disable form auto save after upload. |
205
205
|**toggle_reload(allow: Boolean !Optional)**| Allow/Deny reloading attachments and toggle the reload button (🔶Frappe >= v13.0.0). |
206
206
|**toggle_remove(allow: Boolean !Optional)**| Allow/Deny removing and clearing attachments and toggle the clear and remove buttons. |
207
207
|**set_options(options: JSON Object)**| Set or change the plugin options. |
0 commit comments