mujoco-react 0.1.0 → 0.2.0

package/README.md

@@ -31,13 +31,13 @@ const config: SceneConfig = {
 };
 
 function App() {
-  const apiRef = useRef<MujocoSimAPI | null>(null);
+  const apiRef = useRef<MujocoSimAPI>(null);
 
   return (
     <MujocoProvider>
       <MujocoCanvas
+        ref={apiRef}
         config={config}
-        onReady={(api) => { apiRef.current = api; }}
         camera={{ position: [2, -1.5, 2.5], up: [0, 0, 1], fov: 45 }}
         shadows
         style={{ width: '100%', height: '100vh' }}
@@ -392,7 +392,7 @@ Ref-based site position/quaternion tracking.
 
 ## MujocoSimAPI
 
-The full API object returned by `onReady` and available via `useMujocoSim().api`:
+The full API object available via `ref` or `useMujocoSim().api`:
 
 ### Simulation Control
 

package/dist/index.d.ts

@@ -490,8 +490,10 @@ declare function MujocoProvider({ wasmUrl, children, onError }: MujocoProviderPr
  * MujocoCanvas — thin R3F Canvas wrapper for MuJoCo scenes.
  * Accepts all R3F Canvas props and forwards them through.
  * Supports declarative physics config props (spec 1.1).
+ *
+ * Forward ref exposes MujocoSimAPI (not the canvas element).
  */
-declare const MujocoCanvas: react.ForwardRefExoticComponent<Omit<MujocoCanvasProps, "ref"> & react.RefAttributes<HTMLCanvasElement>>;
+declare const MujocoCanvas: react.ForwardRefExoticComponent<Omit<MujocoCanvasProps, "ref"> & react.RefAttributes<MujocoSimAPI>>;
 
 /**
  * @license
@@ -578,6 +580,7 @@ declare function useAfterPhysicsStep(callback: PhysicsStepCallback): void;
 interface MujocoSimProviderProps {
     mujoco: MujocoModule;
     config: SceneConfig;
+    apiRef?: React.ForwardedRef<MujocoSimAPI>;
     onReady?: (api: MujocoSimAPI) => void;
     onError?: (error: Error) => void;
     onStep?: (time: number) => void;
@@ -590,7 +593,7 @@ interface MujocoSimProviderProps {
     interpolate?: boolean;
     children: React.ReactNode;
 }
-declare function MujocoSimProvider({ mujoco, config, onReady, onError, onStep, onSelection, gravity, timestep, substeps, paused, speed, interpolate, children, }: MujocoSimProviderProps): react_jsx_runtime.JSX.Element;
+declare function MujocoSimProvider({ mujoco, config, apiRef: externalApiRef, onReady, onError, onStep, onSelection, gravity, timestep, substeps, paused, speed, interpolate, children, }: MujocoSimProviderProps): react_jsx_runtime.JSX.Element;
 
 /**
  * @license

package/dist/index.js

@@ -553,6 +553,7 @@ function useAfterPhysicsStep(callback) {
 function MujocoSimProvider({
   mujoco,
   config,
+  apiRef: externalApiRef,
   onReady,
   onError,
   onStep,
@@ -731,8 +732,16 @@ function MujocoSimProvider({
     };
   }, [mujoco, config]);
   useEffect(() => {
-    if (status === "ready" && onReady) {
-      onReady(apiRef.current);
+    if (status === "ready") {
+      const api2 = apiRef.current;
+      if (onReady) onReady(api2);
+      if (externalApiRef) {
+        if (typeof externalApiRef === "function") {
+          externalApiRef(api2);
+        } else {
+          externalApiRef.current = api2;
+        }
+      }
     }
   }, [status]);
   useFrame((state) => {
@@ -1542,11 +1551,12 @@ var MujocoCanvas = forwardRef(
     if (wasmStatus === "error" || wasmStatus === "loading" || !mujoco) {
       return null;
     }
-    return /* @__PURE__ */ jsx(Canvas, { ref, ...canvasProps, children: /* @__PURE__ */ jsx(
+    return /* @__PURE__ */ jsx(Canvas, { ...canvasProps, children: /* @__PURE__ */ jsx(
       MujocoSimProvider,
       {
         mujoco,
         config,
+        apiRef: ref,
         onReady,
         onError,
         onStep,