@react-three/fiber 8.15.12 → 8.15.14

package/dist/declarations/src/web/Canvas.d.ts

@@ -1,24 +1,24 @@
-import * as React from 'react';
-import type { Options as ResizeOptions } from 'react-use-measure';
-import { RenderProps } from '../core';
-export interface CanvasProps extends Omit<RenderProps<HTMLCanvasElement>, 'size'>, React.HTMLAttributes<HTMLDivElement> {
-    children: React.ReactNode;
-    /** Canvas fallback content, similar to img's alt prop */
-    fallback?: React.ReactNode;
-    /**
-     * Options to pass to useMeasure.
-     * @see https://github.com/pmndrs/react-use-measure#api
-     */
-    resize?: ResizeOptions;
-    /** The target where events are being subscribed to, default: the div that wraps canvas */
-    eventSource?: HTMLElement | React.MutableRefObject<HTMLElement>;
-    /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
-    eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen';
-}
-export interface Props extends CanvasProps {
-}
-/**
- * A DOM canvas which accepts threejs elements as children.
- * @see https://docs.pmnd.rs/react-three-fiber/api/canvas
- */
-export declare const Canvas: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLCanvasElement>>;
+import * as React from 'react';
+import type { Options as ResizeOptions } from 'react-use-measure';
+import { RenderProps } from '../core';
+export interface CanvasProps extends Omit<RenderProps<HTMLCanvasElement>, 'size'>, React.HTMLAttributes<HTMLDivElement> {
+    children: React.ReactNode;
+    /** Canvas fallback content, similar to img's alt prop */
+    fallback?: React.ReactNode;
+    /**
+     * Options to pass to useMeasure.
+     * @see https://github.com/pmndrs/react-use-measure#api
+     */
+    resize?: ResizeOptions;
+    /** The target where events are being subscribed to, default: the div that wraps canvas */
+    eventSource?: HTMLElement | React.MutableRefObject<HTMLElement>;
+    /** The event prefix that is cast into canvas pointer x/y events, default: "offset" */
+    eventPrefix?: 'offset' | 'client' | 'page' | 'layer' | 'screen';
+}
+export interface Props extends CanvasProps {
+}
+/**
+ * A DOM canvas which accepts threejs elements as children.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/canvas
+ */
+export declare const Canvas: React.ForwardRefExoticComponent<Props & React.RefAttributes<HTMLCanvasElement>>;

package/dist/declarations/src/web/events.d.ts

@@ -1,5 +1,5 @@
-import { UseBoundStore } from 'zustand';
-import { RootState } from '../core/store';
-import { EventManager } from '../core/events';
-/** Default R3F event manager for web */
-export declare function createPointerEvents(store: UseBoundStore<RootState>): EventManager<HTMLElement>;
+import { UseBoundStore } from 'zustand';
+import { RootState } from '../core/store';
+import { EventManager } from '../core/events';
+/** Default R3F event manager for web */
+export declare function createPointerEvents(store: UseBoundStore<RootState>): EventManager<HTMLElement>;

package/dist/{index-5bde93f1.esm.js → index-29b7121b.esm.js}

@@ -123,9 +123,10 @@ function createRenderer(_roots, _getEventPriority) {
       } else if (child.isObject3D && parentInstance.isObject3D) {
         var _child$__r3f4;
         parentInstance.remove(child);
-        // Remove interactivity
+        // @ts-ignore
+        // Remove interactivity on the initial root
         if ((_child$__r3f4 = child.__r3f) != null && _child$__r3f4.root) {
-          removeInteractivity(child.__r3f.root, child);
+          removeInteractivity(findInitialRoot(child), child);
         }
       }
 
@@ -197,9 +198,9 @@ function createRenderer(_roots, _getEventPriority) {
     }
     appendChild(parent, newInstance);
 
-    // Re-bind event handlers
+    // Re-bind event handlers on the initial root
     if (newInstance.raycast && newInstance.__r3f.eventCount) {
-      const rootState = newInstance.__r3f.root.getState();
+      const rootState = findInitialRoot(newInstance).getState();
       rootState.internal.interaction.push(newInstance);
     }
     [fiber, fiber.alternate].forEach(fiber => {
@@ -299,10 +300,10 @@ function createRenderer(_roots, _getEventPriority) {
     commitMount(instance, _type, _props, _int) {
       var _instance$__r3f4;
       // https://github.com/facebook/react/issues/20271
-      // This will make sure events are only added once to the central container
+      // This will make sure events are only added once to the central container on the initial root
       const localState = (_instance$__r3f4 = instance.__r3f) != null ? _instance$__r3f4 : {};
       if (instance.raycast && localState.handlers && localState.eventCount) {
-        instance.__r3f.root.getState().internal.interaction.push(instance);
+        findInitialRoot(instance).getState().internal.interaction.push(instance);
       }
     },
     getPublicInstance: instance => instance,
@@ -354,12 +355,12 @@ function createRenderer(_roots, _getEventPriority) {
 }
 
 var _window$document, _window$navigator;
-/**
- * Returns `true` with correct TS type inference if an object has a configurable color space (since r152).
+/**
+ * Returns `true` with correct TS type inference if an object has a configurable color space (since r152).
  */
 const hasColorSpace = object => 'colorSpace' in object || 'outputColorSpace' in object;
-/**
- * The current THREE.ColorManagement instance, if present.
+/**
+ * The current THREE.ColorManagement instance, if present.
  */
 const getColorManagement = () => {
   var _ColorManagement;
@@ -368,14 +369,14 @@ const getColorManagement = () => {
 const isOrthographicCamera = def => def && def.isOrthographicCamera;
 const isRef = obj => obj && obj.hasOwnProperty('current');
 
-/**
- * An SSR-friendly useLayoutEffect.
- *
- * React currently throws a warning when using useLayoutEffect on the server.
- * To get around it, we can conditionally useEffect on the server (no-op) and
- * useLayoutEffect elsewhere.
- *
- * @see https://github.com/facebook/react/issues/14927
+/**
+ * An SSR-friendly useLayoutEffect.
+ *
+ * React currently throws a warning when using useLayoutEffect on the server.
+ * To get around it, we can conditionally useEffect on the server (no-op) and
+ * useLayoutEffect elsewhere.
+ *
+ * @see https://github.com/facebook/react/issues/14927
  */
 const useIsomorphicLayoutEffect = typeof window !== 'undefined' && ((_window$document = window.document) != null && _window$document.createElement || ((_window$navigator = window.navigator) == null ? void 0 : _window$navigator.product) === 'ReactNative') ? React.useLayoutEffect : React.useEffect;
 function useMutableCallback(fn) {
@@ -420,13 +421,22 @@ function calculateDpr(dpr) {
   return Array.isArray(dpr) ? Math.min(Math.max(dpr[0], target), dpr[1]) : dpr;
 }
 
-/**
- * Returns instance root state
+/**
+ * Returns instance root state
  */
 const getRootState = obj => {
   var _r3f;
   return (_r3f = obj.__r3f) == null ? void 0 : _r3f.root.getState();
 };
+
+/**
+ * Returns the instances initial (outmost) root
+ */
+function findInitialRoot(child) {
+  let root = child.__r3f.root;
+  while (root.getState().previousRoot) root = root.getState().previousRoot;
+  return root;
+}
 // A collection of compare functions
 const is = {
   obj: a => a === Object(a) && !is.arr(a) && typeof a !== 'function',
@@ -477,8 +487,8 @@ const is = {
   }
 };
 
-/**
- * Collects nodes and materials from a THREE.Object3D.
+/**
+ * Collects nodes and materials from a THREE.Object3D.
  */
 function buildGraph(object) {
   const data = {
@@ -744,12 +754,14 @@ function applyProps$1(instance, data) {
     }
     invalidateInstance(instance);
   }
-  if (localState.parent && rootState.internal && instance.raycast && prevHandlers !== localState.eventCount) {
+  if (localState.parent && instance.raycast && prevHandlers !== localState.eventCount) {
+    // Get the initial root state's internals
+    const internal = findInitialRoot(instance).getState().internal;
     // Pre-emptively remove the instance from the interaction manager
-    const index = rootState.internal.interaction.indexOf(instance);
-    if (index > -1) rootState.internal.interaction.splice(index, 1);
+    const index = internal.interaction.indexOf(instance);
+    if (index > -1) internal.interaction.splice(index, 1);
     // Add the instance to the interaction manager only when it has handlers
-    if (localState.eventCount) rootState.internal.interaction.push(instance);
+    if (localState.eventCount) internal.interaction.push(instance);
   }
 
   // Call the update lifecycle when it is being updated, but only when it is part of the scene.
@@ -818,9 +830,9 @@ function getEventPriority() {
   }
 }
 
-/**
- * Release pointer captures.
- * This is called by releasePointerCapture in the API, and when an object is removed.
+/**
+ * Release pointer captures.
+ * This is called by releasePointerCapture in the API, and when an object is removed.
  */
 function releaseInternalPointerCapture(capturedMap, obj, captures, pointerId) {
   const captureData = captures.get(obj);
@@ -1155,19 +1167,19 @@ function createEvents(store) {
         // Check presence of handlers
         if (!(instance != null && instance.eventCount)) return;
 
-        /*
-        MAYBE TODO, DELETE IF NOT: 
-          Check if the object is captured, captured events should not have intersects running in parallel
-          But wouldn't it be better to just replace capturedMap with a single entry?
-          Also, are we OK with straight up making picking up multiple objects impossible?
-          
-        const pointerId = (data as ThreeEvent<PointerEvent>).pointerId        
-        if (pointerId !== undefined) {
-          const capturedMeshSet = internal.capturedMap.get(pointerId)
-          if (capturedMeshSet) {
-            const captured = capturedMeshSet.get(eventObject)
-            if (captured && captured.localState.stopped) return
-          }
+        /*
+        MAYBE TODO, DELETE IF NOT: 
+          Check if the object is captured, captured events should not have intersects running in parallel
+          But wouldn't it be better to just replace capturedMap with a single entry?
+          Also, are we OK with straight up making picking up multiple objects impossible?
+          
+        const pointerId = (data as ThreeEvent<PointerEvent>).pointerId        
+        if (pointerId !== undefined) {
+          const capturedMeshSet = internal.capturedMap.get(pointerId)
+          if (capturedMeshSet) {
+            const captured = capturedMeshSet.get(eventObject)
+            if (captured && captured.localState.stopped) return
+          }
         }*/
 
         if (isPointerMove) {
@@ -1473,21 +1485,21 @@ let globalEffects = new Set();
 let globalAfterEffects = new Set();
 let globalTailEffects = new Set();
 
-/**
- * Adds a global render callback which is called each frame.
- * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#addEffect
+/**
+ * Adds a global render callback which is called each frame.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#addEffect
  */
 const addEffect = callback => createSubs(callback, globalEffects);
 
-/**
- * Adds a global after-render callback which is called each frame.
- * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#addAfterEffect
+/**
+ * Adds a global after-render callback which is called each frame.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#addAfterEffect
  */
 const addAfterEffect = callback => createSubs(callback, globalAfterEffects);
 
-/**
- * Adds a global callback which is called when rendering stops.
- * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#addTail
+/**
+ * Adds a global callback which is called when rendering stops.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#addTail
  */
 const addTail = callback => createSubs(callback, globalTailEffects);
 function run(effects, timestamp) {
@@ -1586,24 +1598,24 @@ function createLoop(roots) {
   }
   return {
     loop,
-    /**
-     * Invalidates the view, requesting a frame to be rendered. Will globally invalidate unless passed a root's state.
-     * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#invalidate
+    /**
+     * Invalidates the view, requesting a frame to be rendered. Will globally invalidate unless passed a root's state.
+     * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#invalidate
      */
     invalidate,
-    /**
-     * Advances the frameloop and runs render effects, useful for when manually rendering via `frameloop="never"`.
-     * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
+    /**
+     * Advances the frameloop and runs render effects, useful for when manually rendering via `frameloop="never"`.
+     * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#advance
      */
     advance
   };
 }
 
-/**
- * Exposes an object's {@link LocalState}.
- * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
- *
- * **Note**: this is an escape hatch to react-internal fields. Expect this to change significantly between versions.
+/**
+ * Exposes an object's {@link LocalState}.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/additional-exports#useInstanceHandle
+ *
+ * **Note**: this is an escape hatch to react-internal fields. Expect this to change significantly between versions.
  */
 function useInstanceHandle(ref) {
   const instance = React.useRef(null);
@@ -1616,18 +1628,18 @@ function useStore() {
   return store;
 }
 
-/**
- * Accesses R3F's internal state, containing renderer, canvas, scene, etc.
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
+/**
+ * Accesses R3F's internal state, containing renderer, canvas, scene, etc.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usethree
  */
 function useThree(selector = state => state, equalityFn) {
   return useStore()(selector, equalityFn);
 }
 
-/**
- * Executes a callback before render in a shared frame loop.
- * Can order effects with render priority or manually render with a positive priority.
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
+/**
+ * Executes a callback before render in a shared frame loop.
+ * Can order effects with render priority or manually render with a positive priority.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useframe
  */
 function useFrame(callback, renderPriority = 0) {
   const store = useStore();
@@ -1639,9 +1651,9 @@ function useFrame(callback, renderPriority = 0) {
   return null;
 }
 
-/**
- * Returns a node graph of an object with named nodes & materials.
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usegraph
+/**
+ * Returns a node graph of an object with named nodes & materials.
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#usegraph
  */
 function useGraph(object) {
   return React.useMemo(() => buildGraph(object), [object]);
@@ -1663,11 +1675,11 @@ function loadingFn(extensions, onProgress) {
     }, onProgress, error => reject(new Error(`Could not load ${input}: ${error == null ? void 0 : error.message}`)))))).finally(() => loader.dispose == null ? void 0 : loader.dispose());
   };
 }
-/**
- * Synchronously loads and caches assets with a three loader.
- *
- * Note: this hook's caller must be wrapped with `React.Suspense`
- * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
+/**
+ * Synchronously loads and caches assets with a three loader.
+ *
+ * Note: this hook's caller must be wrapped with `React.Suspense`
+ * @see https://docs.pmnd.rs/react-three-fiber/api/hooks#useloader
  */
 function useLoader(Proto, input, extensions, onProgress) {
   // Use suspense to load async assets
@@ -1679,16 +1691,16 @@ function useLoader(Proto, input, extensions, onProgress) {
   return Array.isArray(input) ? results : results[0];
 }
 
-/**
- * Preloads an asset into cache as a side-effect.
+/**
+ * Preloads an asset into cache as a side-effect.
  */
 useLoader.preload = function (Proto, input, extensions) {
   const keys = Array.isArray(input) ? input : [input];
   return preload(loadingFn(extensions), [Proto, ...keys]);
 };
 
-/**
- * Removes a loaded asset from cache.
+/**
+ * Removes a loaded asset from cache.
  */
 useLoader.clear = function (Proto, input) {
   const keys = Array.isArray(input) ? input : [input];
@@ -2084,10 +2096,10 @@ function Portal({
   children,
   container
 }) {
-  /** This has to be a component because it would not be able to call useThree/useStore otherwise since
-   *  if this is our environment, then we are not in r3f's renderer but in react-dom, it would trigger
-   *  the "R3F hooks can only be used within the Canvas component!" warning:
-   *  <Canvas>
+  /** This has to be a component because it would not be able to call useThree/useStore otherwise since
+   *  if this is our environment, then we are not in r3f's renderer but in react-dom, it would trigger
+   *  the "R3F hooks can only be used within the Canvas component!" warning:
+   *  <Canvas>
    *    {createPortal(...)} */
   const {
     events,