Mirrors/uppy
1
0
Fork 0
mirror of https://github.com/transloadit/uppy.git synced 2026-07-28 04:34:01 +00:00
Code Issues Projects Releases Wiki Activity

update docs about separate hidePauseResumeButton and hideCancelButton options

Browse source
This commit is contained in:
Artur Paikin 2018-10-30 01:25:48 +03:00
parent 539504f520
commit f06563bbc9
2 changed files with 28 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

22
website/src/docs/dashboard.md
View file

@ -129,26 +129,40 @@ By default, when a file upload has completed, the file icon in the Dashboard tur
### `showProgressDetails: false`
By default, progress in StatusBar is shown as a simple percentage. If you would like to also display remaining upload size and time, set this to `true`.
Passed to the Status Bar plugin used in the Dashboard.
By default, progress in Status Bar is shown as a simple percentage. If you would like to also display remaining upload size and time, set this to `true`.
`showProgressDetails: false`: Uploading: 45%
`showProgressDetails: true`: Uploading: 45%・43 MB of 101 MB・8s left
### `hideUploadButton: false`
Passed to the Status Bar plugin used in the Dashboard.
Hide the upload button. Use this if you are providing a custom upload button somewhere, and using the `uppy.upload()` API.
### `hideRetryButton: false`
Passed to the Status Bar plugin used in the Dashboard.
Hide the retry button. Use this if you are providing a custom retry button somewhere, and using the `uppy.retryAll()` or `uppy.retryUpload(fileID)` API.
### `hidePauseResumeCancelButtons: false`
### `hidePauseResumeButton: false`
Hide the cancel or pause/resume buttons (for resumable uploads, via [tus](http://tus.io), for example). Use this if you are providing custom cancel or pause/resume buttons somewhere, and using the `uppy.pauseResume(fileID)`, `uppy.cancelAll()` or `uppy.removeFile(fileID)` API.
Passed to the Status Bar plugin used in the Dashboard.
Hide pause/resume buttons (for resumable uploads, via [tus](http://tus.io), for example). Use this if you are providing custom cancel or pause/resume buttons somewhere, and using the `uppy.pauseResume(fileID)` or `uppy.removeFile(fileID)` API.
### `hideCancelButton: false`
Passed to the Status Bar plugin used in the Dashboard.
Hide the cancel button. Use this if you are providing a custom retry button somewhere, and using the `uppy.cancelAll()` API.
### `hideProgressAfterFinish: false`
Hide StatusBar after the upload has finished.
Hide Status Bar after the upload has finished.
### `showSelectedFiles: true`

12
website/src/docs/statusbar.md
View file

@ -77,13 +77,21 @@ By default, progress in the Status Bar is shown as simple percentage. If you wou
`showProgressDetails: false`: Uploading: 45%
`showProgressDetails: true`: Uploading: 45%・43 MB of 101 MB・8s left
### `hideUploadButton: false`
Hide the upload button. Use this if you are providing a custom upload button somewhere, and using the `uppy.upload()` API.
### `hideRetryButton: false`
Hide the retry button. Use this if you are providing a custom retry button somewhere, and using the `uppy.retryAll()` or `uppy.retryUpload(fileID)` API.
### `hidePauseResumeCancelButtons: false`
### `hidePauseResumeButton: false`
Hide the cancel or pause/resume buttons (for resumable uploads, via [tus](http://tus.io), for example). Use this if you are providing custom cancel or pause/resume buttons somewhere, and using the `uppy.pauseResume(fileID)`, `uppy.cancelAll()` or `uppy.removeFile(fileID)` API.
Hide pause/resume buttons (for resumable uploads, via [tus](http://tus.io), for example). Use this if you are providing custom cancel or pause/resume buttons somewhere, and using the `uppy.pauseResume(fileID)` or `uppy.removeFile(fileID)` API.
### `hideCancelButton: false`
Hide the cancel button. Use this if you are providing a custom retry button somewhere, and using the `uppy.cancelAll()` API.
### `locale: {}`