Add a sample to clarify animation callback

facebook · Nov 9, 2017 · a83d343 · a83d343
1 parent e9393f6
commit a83d343
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/Libraries/Animated/src/AnimatedImplementation.js b/Libraries/Animated/src/AnimatedImplementation.js
@@ -563,6 +563,16 @@ const event = function(argMapping: Array<?Mapping>, config?: EventConfig): any {
  * was called on it before it could finish (e.g. because it was interrupted by a
  * gesture or another animation), then it will receive `{finished: false}`.
  *
+ * ```javascript
+ * this.animateValue.spring({}).start(function onComplete({finished}) {
+ *   if (finished === true) {
+ *     console.log('Animation was stopped')
+ *   } else {
+ *     console.log('Animation was aborted')
+ *   }
+ * })
+ * ```
+ *
  * ### Using the native driver
  *
  * By using the native driver, we send everything about the animation to native