feat: add pause and resume in useSpring/useTransitions ref api

Author: chenesan

packages/core/src/types/spring.ts

@@ -176,6 +176,30 @@ export type SpringStopFn<T> = T extends object
     : (keys?: OneOrMore<string>) => void
   : () => void
 
+/**
+ * Pause animating `SpringValue`.
+ *
+ * The `T` parameter can be a set of animated values (as an object type)
+ * or a primitive type for a single animated value.
+ */
+export type SpringPauseFn<T> = T extends object
+  ? T extends ReadonlyArray<number | string>
+    ? () => void
+    : (keys?: OneOrMore<string>) => void
+  : () => void
+
+/**
+ * Resume paused `SpringValue`.
+ *
+ * The `T` parameter can be a set of animated values (as an object type)
+ * or a primitive type for a single animated value.
+ */
+export type SpringResumeFn<T> = T extends object
+  ? T extends ReadonlyArray<number | string>
+    ? () => void
+    : (keys?: OneOrMore<string>) => void
+  : () => void
+
 /**
  * Update the props of each spring, individually or all at once.
  *
@@ -202,6 +226,8 @@ export interface SpringHandle<T extends Indexable = any> {
   update: SpringsUpdateFn<T>
   start: () => AsyncResult<T[]>
   stop: SpringStopFn<T>
+  pause: SpringPauseFn<T>
+  resume: SpringResumeFn<T>
 }
 
 export type SpringConfig = Partial<Omit<AnimationConfig, 'w0'>>

packages/core/src/useSprings.ts

@@ -131,6 +131,8 @@ export function useSprings(
         }
       },
       stop: keys => each(ctrls, ctrl => ctrl.stop(keys)),
+      pause: keys => each(ctrls, ctrl => ctrl.pause(keys)),
+      resume: keys => each(ctrls, ctrl => ctrl.resume(keys)),
     }),
     []
   )

packages/core/src/useTransition.tsx

@@ -312,6 +312,8 @@ export function useTransition(
         }
       },
       stop: keys => each(usedTransitions.current!, t => t.ctrl.stop(keys)),
+      pause: keys => each(usedTransitions.current!, t => t.ctrl.pause(keys)),
+      resume: keys => each(usedTransitions.current!, t => t.ctrl.resume(keys)),
     }),
     []
   )