Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation for events #15

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down