physics-animator 0.13.0 → 0.15.0

package/dist/cjs/react/useSpringState.js

@@ -11,6 +11,11 @@ const useSpringValue_js_1 = require("./useSpringValue.js");
  */
 function useSpringState(options) {
     const [state, setState] = (0, react_1.useState)(options.initial);
-    (0, useSpringValue_js_1.useSpringValue)(options, setState);
-    return state;
+    const [target, setTarget] = (0, react_1.useState)(options.initial);
+    (0, useSpringValue_js_1.useSpringValue)({
+        ...options,
+        initial: options.initial,
+        target
+    }, setState);
+    return { state, target, setTarget };
 }

package/dist/esm/react/useSpringState.js

@@ -8,6 +8,11 @@ import { useSpringValue } from "./useSpringValue.js";
  */
 export function useSpringState(options) {
     const [state, setState] = useState(options.initial);
-    useSpringValue(options, setState);
-    return state;
+    const [target, setTarget] = useState(options.initial);
+    useSpringValue({
+        ...options,
+        initial: options.initial,
+        target
+    }, setState);
+    return { state, target, setTarget };
 }

package/dist/types/Animator.d.ts

@@ -2,6 +2,7 @@ import { EventSignal } from "@haxiomic/event-signal";
 import { IFieldAnimator } from "./animators/IFieldAnimator.js";
 import { SpringParameters } from "./animators/SpringAnimator.js";
 import { EasingStepFn } from "./animators/TweenAnimator.js";
+type Public<T> = Pick<T, keyof T>;
 /**
  * Physically based animation of numeric properties of objects
  *
@@ -44,14 +45,14 @@ export declare class Animator {
     protected beforeChange: EventSignal<void, void>;
     protected afterChange: EventSignal<void, void>;
     constructor(onBeforeStep?: (dt_s: number) => void, onAfterStep?: (dt_s: number) => void);
-    setTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>): void;
-    animateTo<Obj extends Record<string, any>, Parameters, State, FieldType>(object: Obj, target: Partial<Obj>, animator?: IFieldAnimator<Parameters, State, FieldType>, params?: Parameters | null): void;
-    springTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, params: SpringParameters | null): void;
-    customTweenTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, duration_s: number, easingFn: EasingStepFn): void;
-    linearTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, duration_s: number): void;
-    easeInOutTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, duration_s: number): void;
-    easeInTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, duration_s: number): void;
-    easeOutTo<Obj extends Record<string, any>>(object: Obj, target: Partial<Obj>, duration_s: number): void;
+    setTo<Obj>(object: Obj, target: Partial<Public<Obj>>): void;
+    animateTo<Obj, Parameters, State, FieldType>(object: Obj, target: Partial<Public<Obj>>, animator?: IFieldAnimator<Parameters, State, FieldType>, params?: Parameters | null): void;
+    springTo<Obj>(object: Obj, target: Partial<Public<Obj>>, params: SpringParameters | null): void;
+    customTweenTo<Obj>(object: Obj, target: Partial<Public<Obj>>, duration_s: number, easingFn: EasingStepFn): void;
+    linearTo<Obj>(object: Obj, target: Partial<Public<Obj>>, duration_s: number): void;
+    easeInOutTo<Obj>(object: Obj, target: Partial<Public<Obj>>, duration_s: number): void;
+    easeInTo<Obj>(object: Obj, target: Partial<Public<Obj>>, duration_s: number): void;
+    easeOutTo<Obj>(object: Obj, target: Partial<Public<Obj>>, duration_s: number): void;
     onCompleteField<Obj, Name extends keyof Obj>(object: Obj, field: Name, callback: (object: Obj, field: Name) => void, once?: 'once'): {
         priority: number;
         listener: (event: {

package/dist/types/react/useSpringState.d.ts

@@ -1,5 +1,6 @@
 import { Animator } from "../Animator.js";
 import { SpringParameters } from "../animators/SpringAnimator.js";
+type WidenNumber<T> = T extends number ? number : T;
 /**
  * A value that animates to a target value using a spring animation.
  * This **will** cause a re-render when the value changes.
@@ -11,5 +12,9 @@ export declare function useSpringState<T extends number | number[] | {
 }>(options: {
     animator?: Animator;
     initial: T;
-    target: T;
-} & SpringParameters): T;
+} & SpringParameters): {
+    readonly state: WidenNumber<T>;
+    readonly target: WidenNumber<T>;
+    readonly setTarget: import("react").Dispatch<import("react").SetStateAction<WidenNumber<T>>>;
+};
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "physics-animator",
-  "version": "0.13.0",
+  "version": "0.15.0",
   "author": "haxiomic (George Corney)",
   "license": "MIT",
   "description": "A TypeScript animation system grounded in physics with three.js and react support.",