@shopify/react-native-skia/src/animation/spring/useSpring.ts

High-performance React Native Graphics using Skia

import type { SkiaValue } from "../../values/types";
import type {
  SpringConfig,
  AnimationParams,
  AnimationCallback,
} from "../types";
import { useTiming } from "../timing";

import { Spring } from "./Spring";
import { createSpringEasing } from "./functions/spring";

/**
 * Creats a spring based animation value that will run whenever
 * the animation parameters change.
 * @param toOrParams
 * @param config
 * @returns
 */
export const useSpring = (
  toOrParams: number | AnimationParams,
  config?: SpringConfig,
  callback?: AnimationCallback
): SkiaValue<number> =>
  useTiming(
    toOrParams,
    createSpringEasing(config ?? Spring.Config.Default),
    callback
  );