@animatter/react 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alanshown
+
+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,7 @@
-# Temporary Holding Version
+# @animatter/react
 
-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.
+Optional React lifecycle hooks for the shared Animatter runtime. Peer dependencies: React >=18 and animatter ^0.1.0. Version 0.1.0 is packed locally from the monorepo; no npm publication is claimed.
+
+useAnimatter returns {ref,world}; useSurface registers a ref and cleans up on unmount. Keep surface option objects stable. World options are captured on mount; configure the world for live changes.
+
+[Usage and tests](https://github.com/Alanshown/Animatter.js/blob/main/README.md#framework-integrations). MIT.

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+import { type RefObject } from "react";
+import { type AnimatterWorld, type SurfaceOptions, type WorldOptions } from "animatter";
+/** Options are captured on mount. Use world.configure/setMode for live changes. */
+export declare function useAnimatter(options?: Omit<WorldOptions, "root">): {
+    ref: RefObject<HTMLDivElement | null>;
+    world: AnimatterWorld | null;
+};
+/** Cleans up on world/options identity change, unmount, and React StrictMode remount. */
+export declare function useSurface<T extends HTMLElement>(world: AnimatterWorld | null, options?: SurfaceOptions): RefObject<T | null>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAA+B,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AACpE,OAAO,EAEL,KAAK,cAAc,EACnB,KAAK,cAAc,EACnB,KAAK,YAAY,EAClB,MAAM,WAAW,CAAC;AACnB,mFAAmF;AACnF,wBAAgB,YAAY,CAAC,OAAO,GAAE,IAAI,CAAC,YAAY,EAAE,MAAM,CAAM,GAAG;IACtE,GAAG,EAAE,SAAS,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IACtC,KAAK,EAAE,cAAc,GAAG,IAAI,CAAC;CAC9B,CAaA;AACD,yFAAyF;AACzF,wBAAgB,UAAU,CAAC,CAAC,SAAS,WAAW,EAC9C,KAAK,EAAE,cAAc,GAAG,IAAI,EAC5B,OAAO,GAAE,cAAmB,GAC3B,SAAS,CAAC,CAAC,GAAG,IAAI,CAAC,CAMrB"}

package/dist/index.js

@@ -0,0 +1,27 @@
+import { useEffect, useRef, useState } from "react";
+import { createWorld, } from "animatter";
+/** Options are captured on mount. Use world.configure/setMode for live changes. */
+export function useAnimatter(options = {}) {
+    const ref = useRef(null), initial = useRef(options);
+    const [world, setWorld] = useState(null);
+    useEffect(() => {
+        if (!ref.current)
+            return;
+        const instance = createWorld({ ...initial.current, root: ref.current });
+        setWorld(instance);
+        return () => {
+            instance.destroy();
+        };
+    }, []);
+    return { ref, world };
+}
+/** Cleans up on world/options identity change, unmount, and React StrictMode remount. */
+export function useSurface(world, options = {}) {
+    const ref = useRef(null);
+    useEffect(() => {
+        if (world && ref.current)
+            return world.register(ref.current, options);
+    }, [world, options]);
+    return ref;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAkB,MAAM,OAAO,CAAC;AACpE,OAAO,EACL,WAAW,GAIZ,MAAM,WAAW,CAAC;AACnB,mFAAmF;AACnF,MAAM,UAAU,YAAY,CAAC,UAAsC,EAAE;IAInE,MAAM,GAAG,GAAG,MAAM,CAAiB,IAAI,CAAC,EACtC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAC5B,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAwB,IAAI,CAAC,CAAC;IAChE,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,GAAG,CAAC,OAAO;YAAE,OAAO;QACzB,MAAM,QAAQ,GAAG,WAAW,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QACxE,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACnB,OAAO,GAAG,EAAE;YACV,QAAQ,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IACP,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC;AACxB,CAAC;AACD,yFAAyF;AACzF,MAAM,UAAU,UAAU,CACxB,KAA4B,EAC5B,UAA0B,EAAE;IAE5B,MAAM,GAAG,GAAG,MAAM,CAAI,IAAI,CAAC,CAAC;IAC5B,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,KAAK,IAAI,GAAG,CAAC,OAAO;YAAE,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IACrB,OAAO,GAAG,CAAC;AACb,CAAC"}

package/package.json

@@ -1,6 +1,47 @@
 {
   "name": "@animatter/react",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "type": "module",
+  "license": "MIT",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "peerDependencies": {
+    "animatter": "^0.1.0",
+    "react": ">=18"
+  },
+  "description": "React lifecycle hooks for the shared Animatter.js physics interaction runtime",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Alanshown/Animatter.js.git",
+    "directory": "packages/react"
+  },
+  "homepage": "https://github.com/Alanshown/Animatter.js#readme",
+  "bugs": {
+    "url": "https://github.com/Alanshown/Animatter.js/issues"
+  },
+  "author": "Alanshown",
+  "keywords": [
+    "physics",
+    "interaction",
+    "animation",
+    "typescript",
+    "web",
+    "react"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}