@weasel-js/animator 0.0.0-stage → 1.9.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 orochi235
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,38 @@
-# Temporary Holding Version
+# @weasel-js/animator
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Tweens, springs, holds, staggers, and timelines on one frame loop, with no scene underneath.
+
+Part of [weasel](https://github.com/orochi235/weasel), a domain-agnostic 2D
+scene-graph canvas kit for React. See the
+[API reference](https://orochi235.github.io/weasel/api/).
+
+```sh
+npm install @weasel-js/animator
+```
+
+```tsx
+import { createTarget, useAnimator } from '@weasel-js/animator';
+
+const animator = useAnimator();
+let x = 0;
+const target = createTarget({ get: () => x, set: (v) => { x = v; }, show: draw });
+
+animator.tween({ target, to: 100, ms: 300 });
+animator.spring({ target, to: 40 }); // bends the motion; neither cancels the other
+```
+
+| Export | What it is |
+|---|---|
+| `useAnimator()` | The animator: `tween`, `spring`, `physics`, `decay`, `hold`, `loop`, `stagger`, `timeline`, and `watch`. The frame loop stops while its host is unseen. |
+| `createTarget(opts)` | One value an animator moves. Animations on a target add, so a second one bends the first. |
+| `createTargetTable(opts)` | Many like values as rows of flat arrays, shown in one pass. |
+| `sampleTrack`, the `Track` types | Keyframe tracks for `animator.timeline`. |
+| `resolveSkeleton`, `skeletonAxes`, `solveIk`, `mirrorPose` | Skeleton math: joints to matrices, a skeleton pose as a target's axes, two-bone IK. |
+| `tweenVertexColors` and its siblings, `ColorOverrideRegistry` | Per-vertex color animation, and the table a renderer reads the colors from. |
+| `createSlew`, `slewToward` | A value that follows another at a bounded rate. |
+
+Moving a scene node's pose is `@weasel-js/core`'s half: `tweenPose`, `springPose`,
+`momentum`, `bindRig`, and `useAnimatedReflow` drive this animator against a scene. How
+animations combine on a target is in
+[concepts](https://github.com/orochi235/weasel/blob/main/docs/concepts.md) under
+"Animation target".