diff --git a/README.md b/README.md index cf791a3..f77ccb2 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,10 @@ It supports RTL layout and dark mode out of the box. ### Special Thanks **A simple display of gratitude and appreciation to those who provided helped and kind support.** #### Version 2 -- [![MohsinAli](https://img.shields.io/badge/MohsinAli-Debug_%7C_Test_%7C_Fix-red?style=plastic)](https://github.com/mohsinalimat) -- [![Robert C](https://img.shields.io/badge/Robert_C-Debug_%7C_Test-blue?style=plastic)](https://github.com/robert1112) -- [![NirajRegmi](https://img.shields.io/badge/NirajRegmi-Debug_%7C_Test-blue?style=plastic)](https://github.com/NirajRegmi) -- [![galaxlabs](https://img.shields.io/badge/galaxlabs-Enhancement-a2eeef?style=plastic)](https://github.com/galaxlabs) +- [![MohsinAli](https://img.shields.io/badge/MohsinAli-Debug_%7C_Test_%7C_Fix-ff0000?style=plastic)](https://github.com/mohsinalimat) +- [![Robert C](https://img.shields.io/badge/Robert_C-Debug_%7C_Test-orange?style=plastic)](https://github.com/robert1112) +- [![NirajRegmi](https://img.shields.io/badge/NirajRegmi-Debug_%7C_Test-orange?style=plastic)](https://github.com/NirajRegmi) +- [![galaxlabs](https://img.shields.io/badge/galaxlabs-Enhancement-blue?style=plastic)](https://github.com/galaxlabs) #### Version 1 - [![CA. B.C.Chechani](https://img.shields.io/badge/CA._B.C.Chechani-Debug_%7C_Test-blue?style=plastic)](https://github.com/chechani) @@ -178,35 +178,35 @@ You can't modify the original fields of a doctype, so create a new field or clon ### Available Field Options | Option | Description | | :--- | :--- | -| **dialog_title** | Upload dialog title to be displayed ️(🔶Frappe >= v14.0.0).

🔹Example: **"Upload Images"**
🔹Default: **"Upload"** | -| **upload_notes** | Upload text to be displayed.

🔹Example: **"Only images and videos, with maximum size of 2MB, are allowed to be uploaded"**
🔹Default: **""** | -| **disable_auto_save** | Disable form auto save after upload.

🔹Default: **false** | -| **disable_file_browser** | Disable file browser uploads.

⚠️ *(File browser is always disabled in Web Form)*

🔹Default: **false** | -| **allow_multiple** | Allow multiple uploads.

⚠️ *(Field value is a JSON array of files url)*

🔹Default: **false** | -| **max_file_size** | Maximum file size (in bytes) that is allowed to be uploaded.

🔹Example: **2048** for **2KB**
🔹Default: **Value of maximum file size in Frappe's settings** | -| **allowed_file_types** | Array of allowed file types (mimes) or extensions to upload. Prefix escaped RegExp string types with **$**.

⚠️ *(File extensions must have a leading dot ".")*
⚠️ *(RegExp string types will not be used to in HTML accept attribute)*

🔹Example: **["image/*", "video/*", ".pdf", ".doc", "$audio\/([a-z]+)"]**
🔹Default: **null** or **["image/*"]** | -| **max_number_of_files** | Maximum number of files allowed to be uploaded if multiple upload is allowed.

⚠️ *(Bypassing the maximum attachments of doctype might not work)*

🔹Example: **4**
🔹Default: **Value of maximum attachments set for the doctype** | -| **crop_image_aspect_ratio** | Crop aspect ratio for images (🔶Frappe >= v14.0.0).

🔹Example: **1** or **16/9** or **4/3**
🔹Default: **null** | -| **as_public** | Force uploads to be saved in public folder by default.

🔹Default: **false** | -| **allowed_filename** | Only allow files that match a specific file name to be uploaded.

🔹Example: (String)**"picture.png"** or (RegExp String)**"/picture\-([0-9]+)\.png/"**
🔹Default: **null** | -| **allow_reload** | Allow reloading attachments (🔶Frappe >= v13.0.0).

🔶 Affect the visibility of the reload button.🔶

🔹Default: **true** | -| **allow_remove** | Allow removing and clearing attachments.

🔶 Affect the visibility of the remove and clear buttons.🔶

🔹Default: **true** | -| **users** 🔴 | Array of custom options for a specific user or group of users.

🔹Example: **[{"for": "Guest", "disabled": true}, {"for": ["Administrator", "user"], "allow_multiple": true}]**
🔹Default: **null** | -| **roles** 🔴 | Array of custom options for a specific role or group of roles.
⚠️ *(Custom options for users is prioritized over roles.)*

🔹Example: **[{"for": ["Administrator", "System"], "allow_multiple": true}]**
🔹Default: **null** | - -🔴 New - 🔶 Changed +| **dialog_title** | Upload dialog title to be displayed ️(🔶Frappe >= v14.0.0).

🔹Example: ```"Upload Images"```
🔹Default: ```"Upload"``` | +| **upload_notes** | Upload text to be displayed.

🔹Example: ```"Only images and videos, with maximum size of 2MB, are allowed to be uploaded"```
🔹Default: ```""``` | +| **disable_auto_save** | Disable form auto save after upload.

🔹Default: ```false``` | +| **disable_file_browser** | Disable file browser uploads.

⚠️ *(File browser is always disabled in Web Form)*

🔹Default: ```false``` | +| **allow_multiple** | Allow multiple uploads.

⚠️ *(Field value is a JSON array of files url)*

🔹Default: ```false``` | +| **max_file_size** | Maximum file size (in bytes) that is allowed to be uploaded.

🔹Example: ```2048``` for ```2KB```
🔹Default: ```Value of maximum file size in Frappe's settings``` | +| **allowed_file_types** | Array of allowed file types (mimes) or extensions to upload. Prefix escaped RegExp string types with ```$```.

⚠️ *(File extensions must have a leading dot ".")*
⚠️ *(RegExp string types will not be used to in HTML accept attribute)*

🔹Example: ```["image/*", "video/*", ".pdf", ".doc", "$audio\/([a-z]+)"]```
🔹Default: ```null``` or ```["image/*"]``` | +| **max_number_of_files** | Maximum number of files allowed to be uploaded if multiple upload is allowed.

⚠️ *(Bypassing the maximum attachments of doctype might not work)*

🔹Example: ```4```
🔹Default: ```Value of maximum attachments set for the doctype``` | +| **crop_image_aspect_ratio** | Crop aspect ratio for images (🔶Frappe >= v14.0.0).

🔹Example: ```1``` or ```16/9``` or ```4/3```
🔹Default: ```null``` | +| **as_public** | Force uploads to be saved in public folder by default.

🔹Default: ```false``` | +| **allowed_filename** | Only allow files that match a specific file name to be uploaded.

🔹Example: (String)```"picture.png"``` or (RegExp String)```"/picture\-([0-9]+)\.png/"```
🔹Default: ```null``` | +| **allow_reload** | Allow reloading attachments (🔶Frappe >= v13.0.0).

🔶 Affect the visibility of the reload button.🔶

🔹Default: ```true``` | +| **allow_remove** | Allow removing and clearing attachments.

🔶 Affect the visibility of the remove and clear buttons.🔶

🔹Default: ```true``` | +| **users** 🔴 | Array of custom options for a specific user or group of users.

🔹Example: ```[{"for": "Guest", "disabled": true}, {"for": ["Administrator", "user"], "allow_multiple": true}]```
🔹Default: ```null``` | +| **roles** 🔴 | Array of custom options for a specific role or group of roles.
⚠️ *(Custom options for users is prioritized over roles.)*

🔹Example: ```[{"for": ["Administrator", "System"], "allow_multiple": true}]```
🔹Default: ```null``` | + +🔴 New - 🔵 Changed --- ### Available JavaScript Methods | Method | Description | | :--- | :--- | -| **toggle_auto_save(enable: Boolean !Optional)** 🔶 | Enable/Disable form auto save after upload. | +| **toggle_auto_save(enable: Boolean !Optional)** 🔵 | Enable/Disable form auto save after upload. | | **toggle_reload(allow: Boolean !Optional)** | Allow/Deny reloading attachments and toggle the reload button (🔶Frappe >= v13.0.0). | | **toggle_remove(allow: Boolean !Optional)** | Allow/Deny removing and clearing attachments and toggle the clear and remove buttons. | | **set_options(options: JSON Object)** | Set or change the plugin options. | -🔴 New - 🔶 Changed +🔴 New - 🔵 Changed ---