Unifying playback controls types

framer · Mar 7, 2023 · 88df7ea · 88df7ea
1 parent 1f77c7c
commit 88df7ea
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 18 deletions.
diff --git a/packages/framer-motion/src/animation/animate.ts b/packages/framer-motion/src/animation/animate.ts
@@ -7,8 +7,8 @@ import { isMotionValue } from "../value/utils/is-motion-value"
  * @public
  */
 export interface AnimationPlaybackControls {
+    currentTime?: number | null
     stop: () => void
-    isAnimating: () => boolean
 }
 
 /**
@@ -68,6 +68,5 @@ export function animate<V>(
 
     return {
         stop: () => value.stop(),
-        isAnimating: () => value.isAnimating(),
     }
 }
diff --git a/packages/framer-motion/src/animation/legacy-popmotion/inertia.ts b/packages/framer-motion/src/animation/legacy-popmotion/inertia.ts
@@ -1,8 +1,8 @@
-import { PlaybackControls } from "./types"
 import { animateValue } from "."
 import { velocityPerSecond } from "../../utils/velocity-per-second"
 import { frameData } from "../../frameloop/data"
 import { AnimationOptions } from "../types"
+import { AnimationPlaybackControls } from "../animate"
 
 export function inertia({
     keyframes,
@@ -21,7 +21,7 @@ export function inertia({
     onStop,
 }: AnimationOptions) {
     const origin = keyframes[0]
-    let currentAnimation: PlaybackControls
+    let currentAnimation: AnimationPlaybackControls
 
     function isOutOfBounds(v: number) {
         return (min !== undefined && v < min) || (max !== undefined && v > max)

diff --git a/packages/framer-motion/src/animation/legacy-popmotion/types.ts b/packages/framer-motion/src/animation/legacy-popmotion/types.ts
@@ -12,10 +12,6 @@ export interface AnimationState<V> {
     done: boolean
 }
 
-export interface PlaybackControls {
-    stop: () => void
-}
-
 /**
  * An update function. It accepts a timestamp used to advance the animation.
  */

diff --git a/packages/framer-motion/src/animation/types.ts b/packages/framer-motion/src/animation/types.ts
@@ -76,11 +76,6 @@ export type ControlsAnimationDefinition =
     | TargetAndTransition
     | TargetResolver
 
-export interface PlaybackControls {
-    stop: () => void
-    currentTime?: number
-}
-
 /**
  * @public
  */

diff --git a/packages/framer-motion/src/value/index.ts b/packages/framer-motion/src/value/index.ts
@@ -3,8 +3,8 @@ import { FrameData } from "../frameloop/types"
 import { sync } from "../frameloop"
 import { SubscriptionManager } from "../utils/subscription-manager"
 import { velocityPerSecond } from "../utils/velocity-per-second"
-import { PlaybackControls } from "../animation/types"
 import { warnOnce } from "../utils/warn-once"
+import { AnimationPlaybackControls } from "../animation/animate"
 
 export type Transformer<T> = (v: T) => T
 
@@ -18,7 +18,9 @@ export type Subscriber<T> = (v: T) => void
  */
 export type PassiveEffect<T> = (v: T, safeSetter: (v: T) => void) => void
 
-export type StartAnimation = (complete: () => void) => PlaybackControls | void
+export type StartAnimation = (
+    complete: () => void
+) => AnimationPlaybackControls | void
 
 export interface MotionValueEventCallbacks<V> {
     animationStart: () => void
@@ -109,7 +111,7 @@ export class MotionValue<V = any> {
      *
      * @internal
      */
-    animation?: null | PlaybackControls
+    animation?: null | AnimationPlaybackControls
 
     /**
      * Tracks whether this value can output a velocity. Currently this is only true

diff --git a/packages/framer-motion/src/value/use-spring.ts b/packages/framer-motion/src/value/use-spring.ts
@@ -3,10 +3,10 @@ import { MotionValue } from "../value"
 import { isMotionValue } from "./utils/is-motion-value"
 import { useMotionValue } from "./use-motion-value"
 import { MotionConfigContext } from "../context/MotionConfigContext"
-import { PlaybackControls } from "../animation/legacy-popmotion/types"
 import { animateValue } from "../animation/legacy-popmotion"
 import { SpringOptions } from "../animation/types"
 import { useIsomorphicLayoutEffect } from "../utils/use-isomorphic-effect"
+import { AnimationPlaybackControls } from "../animation/animate"
 
 /**
  * Creates a `MotionValue` that, when `set`, will use a spring animation to animate to its new state.
@@ -32,7 +32,7 @@ export function useSpring(
     config: SpringOptions = {}
 ) {
     const { isStatic } = useContext(MotionConfigContext)
-    const activeSpringAnimation = useRef<PlaybackControls | null>(null)
+    const activeSpringAnimation = useRef<AnimationPlaybackControls | null>(null)
     const value = useMotionValue(isMotionValue(source) ? source.get() : source)
 
     const stopAnimation = () => {