Add onStart callback

vinutv · Jun 19, 2018 · 7f4f854 · 7f4f854
1 parent 5eeedf3
commit 7f4f854
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/API.md b/API.md
@@ -38,6 +38,8 @@ class Spring extends React.PureComponent {
     from: PropTypes.object,
     // Animates to ...
     to: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
+    // Callback when the animation starts to animate
+    onStart: PropTypes.func,
     // Callback when the animation comes to a still-stand
     onRest: PropTypes.func,
     // Frame by frame callback, first argument passed is the animated value

diff --git a/index.d.ts b/index.d.ts
@@ -27,6 +27,10 @@ declare module 'react-spring' {
      * @default {}
      */
     to: DS;
+    /**
+     * Callback when the animation starts to animate
+     */
+    onStart?: () => void;
     /**
      * Callback when the animation comes to a still-stand
      */

diff --git a/src/Spring.js b/src/Spring.js
@@ -32,6 +32,7 @@ export default class Spring extends React.Component {
     to: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
     from: PropTypes.object,
     native: PropTypes.bool,
+    onStart: PropTypes.func,
     onRest: PropTypes.func,
     onFrame: PropTypes.func,
     children: PropTypes.oneOfType([
@@ -97,6 +98,7 @@ export default class Spring extends React.Component {
       immediate,
       reset,
       onFrame,
+      onStart,
       onRest,
       inject,
       native,
@@ -172,6 +174,7 @@ export default class Spring extends React.Component {
 
       entry.start = cb => {
         if (entry.animation.__getValue() === toValue) return entry.onFinish(cb)
+        if (onStart) onStart()
         controller(
           entry.animation,
           { to: toValue, ...callProp(config, name) },