From d5282b27b891c8340b03d09ced041460cd17402e Mon Sep 17 00:00:00 2001 From: Shreyansh Panchal Date: Thu, 23 Apr 2020 18:21:07 +0530 Subject: [PATCH] Added documentation for events Events are missing in the readme file. So i've added documentation for events so, as to avoid #5 --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 0446cc1..078e911 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,15 @@ Multipart upload, with custom Browse button using `slot` api |upload-btn| | X |Provide your own upload list _upload_ button html| |extra | | X |Slot to add extra form elements to send along with the upload| +## Events + +|Event name |Single file uploader|Multi file uploader|Description| +|----------|:------------------:|:-----------------:|-----------| +|startUpload | X | |When start upload if queue is not being used i.e not multiple| +|fileUploaded | X | X |After finishing file upload, Returns response| +|error | X | X |On upload error, Returns error obj| +|chunkUploaded | | X |When uploaded one item of multiple items, Returns FileObj, Curent Part| + ## Demo To demo the uploader you need a server, there is a simple php example