Explorar o código

Add reset-progress event to docs (#1922)

* document reset-progress event

* reword progress reset behaviour

* remove totalProgress reference
Alexis Hope %!s(int64=5) %!d(string=hai) anos
pai
achega
23b8e820ea
Modificáronse 2 ficheiros con 10 adicións e 1 borrados
  1. 0 1
      packages/@uppy/core/src/index.js
  2. 10 0
      website/src/docs/uppy.md

+ 0 - 1
packages/@uppy/core/src/index.js

@@ -315,7 +315,6 @@ class Uppy {
       totalProgress: 0
     })
 
-    // TODO Document on the website
     this.emit('reset-progress')
   }
 

+ 10 - 0
website/src/docs/uppy.md

@@ -755,3 +755,13 @@ uppy.on('restriction-failed', (file, error) => {
   // do some customized logic like showing system notice to users
 })
 ```
+
+### `reset-progress`
+
+Fired when `uppy.resetProgress()` is called, each file has its upload progress reset to zero.
+
+```javascript
+uppy.on('reset-progress', () => {
+  // progress was reset
+})
+```