@react-three/fiber 8.13.0 → 8.13.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @react-three/fiber
 
+## 8.13.1
+
+### Patch Changes
+
+- c9fe03ba: fix: primitive swap and reactive portals
+
 ## 8.13.0
 
 ### Minor Changes

package/dist/declarations/src/core/index.d.ts

@@ -4,7 +4,7 @@ import * as THREE from 'three';
 import * as React from 'react';
 import { UseBoundStore } from 'zustand';
 import * as ReactThreeFiber from '../three-types';
-import { Renderer, context, RootState, Size, Dpr, Performance, PrivateKeys } from './store';
+import { Renderer, context, RootState, Size, Dpr, Performance } from './store';
 import { extend, Root } from './renderer';
 import { addEffect, addAfterEffect, addTail, flushGlobalEffects } from './loop';
 import { EventManager, ComputeFunction } from './events';
@@ -43,14 +43,13 @@ export declare type ReconcilerRoot<TCanvas extends Canvas> = {
 declare function createRoot<TCanvas extends Canvas>(canvas: TCanvas): ReconcilerRoot<TCanvas>;
 declare function render<TCanvas extends Canvas>(children: React.ReactNode, canvas: TCanvas, config: RenderProps<TCanvas>): UseBoundStore<RootState>;
 declare function unmountComponentAtNode<TCanvas extends Canvas>(canvas: TCanvas, callback?: (canvas: TCanvas) => void): void;
-export declare type InjectState = Partial<Omit<RootState, PrivateKeys> & {
+export declare type InjectState = Partial<Omit<RootState, 'events'> & {
     events?: {
         enabled?: boolean;
         priority?: number;
         compute?: ComputeFunction;
         connected?: any;
     };
-    size?: Size;
 }>;
 declare function createPortal(children: React.ReactNode, container: THREE.Object3D, state?: InjectState): JSX.Element;
 declare const act: any;

package/dist/declarations/src/core/store.d.ts

@@ -1,10 +1,9 @@
+/// <reference types="webxr" />
 import * as THREE from 'three';
 import * as React from 'react';
 import { GetState, SetState, StoreApi, UseBoundStore } from 'zustand';
 import { DomEvent, EventManager, PointerCaptureTarget, ThreeEvent } from './events';
 import { Camera } from './utils';
-export declare const privateKeys: readonly ["set", "get", "setSize", "setFrameloop", "setDpr", "events", "invalidate", "advance", "size", "viewport"];
-export declare type PrivateKeys = typeof privateKeys[number];
 export interface Intersection extends THREE.Intersection {
     eventObject: THREE.Object3D;
 }

package/dist/{index-22ee0173.esm.js → index-13b06ff5.esm.js}

@@ -150,13 +150,7 @@ function createRenderer(_roots, _getEventPriority) {
       }
 
       // Remove references
-      if (child.__r3f) {
-        delete child.__r3f.root;
-        delete child.__r3f.objects;
-        delete child.__r3f.handlers;
-        delete child.__r3f.memoizedProps;
-        if (!isPrimitive) delete child.__r3f;
-      }
+      delete child.__r3f;
 
       // Dispose item whenever the reconciler feels like it
       if (shouldDispose && child.dispose && child.type !== 'Scene') {
@@ -1206,8 +1200,6 @@ function createEvents(store) {
   };
 }
 
-// Keys that shouldn't be copied between R3F stores
-const privateKeys = ['set', 'get', 'setSize', 'setFrameloop', 'setDpr', 'events', 'invalidate', 'advance', 'size', 'viewport'];
 const isRenderer = def => !!(def != null && def.render);
 const context = /*#__PURE__*/React.createContext(null);
 const createStore = (invalidate, advance) => {
@@ -2037,7 +2029,6 @@ function unmountComponentAtNode(canvas, callback) {
 }
 function createPortal(children, container, state) {
   return /*#__PURE__*/React.createElement(Portal, {
-    key: container.uuid,
     children: children,
     container: container,
     state: state
@@ -2061,26 +2052,9 @@ function Portal({
   const previousRoot = useStore();
   const [raycaster] = React.useState(() => new THREE.Raycaster());
   const [pointer] = React.useState(() => new THREE.Vector2());
-  const inject = React.useCallback((rootState, injectState) => {
-    const intersect = {
-      ...rootState
-    }; // all prev state props
-
-    // Only the fields of "rootState" that do not differ from injectState
-    // Some props should be off-limits
-    // Otherwise filter out the props that are different and let the inject layer take precedence
-    Object.keys(rootState).forEach(key => {
-      if (
-      // Some props should be off-limits
-      privateKeys.includes(key) ||
-      // Otherwise filter out the props that are different and let the inject layer take precedence
-      // Unless the inject layer props is undefined, then we keep the root layer
-      rootState[key] !== injectState[key] && injectState[key]) {
-        delete intersect[key];
-      }
-    });
-    let viewport = undefined;
-    if (injectState && size) {
+  const inject = useMutableCallback((rootState, injectState) => {
+    let viewport;
+    if (injectState.camera && size) {
       const camera = injectState.camera;
       // Calculate the override viewport, if present
       viewport = rootState.viewport.getCurrentViewport(camera, new THREE.Vector3(), size);
@@ -2089,7 +2063,9 @@ function Portal({
     }
     return {
       // The intersect consists of the previous root state
-      ...intersect,
+      ...rootState,
+      get: injectState.get,
+      set: injectState.set,
       // Portals have their own scene, which forms the root, a raycaster and a pointer
       scene: container,
       raycaster,
@@ -2100,7 +2076,7 @@ function Portal({
       // Events, size and viewport can be overridden by the inject layer
       events: {
         ...rootState.events,
-        ...(injectState == null ? void 0 : injectState.events),
+        ...injectState.events,
         ...events
       },
       size: {
@@ -2111,53 +2087,33 @@ function Portal({
         ...rootState.viewport,
         ...viewport
       },
-      ...rest
-    };
-  }, [state]);
-  const [usePortalStore] = React.useState(() => {
-    // Create a mirrored store, based on the previous root with a few overrides ...
-    const previousState = previousRoot.getState();
-    const store = create((set, get) => ({
-      ...previousState,
-      scene: container,
-      raycaster,
-      pointer,
-      mouse: pointer,
-      previousRoot,
-      events: {
-        ...previousState.events,
-        ...events
-      },
-      size: {
-        ...previousState.size,
-        ...size
-      },
-      ...rest,
-      // Set and get refer to this root-state
-      set,
-      get,
       // Layers are allowed to override events
-      setEvents: events => set(state => ({
+      setEvents: events => injectState.set(state => ({
         ...state,
         events: {
           ...state.events,
           ...events
         }
       }))
-    }));
-    return store;
+    };
   });
-  React.useEffect(() => {
+  const usePortalStore = React.useMemo(() => {
+    const store = create((set, get) => ({
+      ...rest,
+      set,
+      get
+    }));
+
     // Subscribe to previous root-state and copy changes over to the mirrored portal-state
-    const unsub = previousRoot.subscribe(prev => usePortalStore.setState(state => inject(prev, state)));
-    return () => {
-      unsub();
-      usePortalStore.destroy();
-    };
-  }, []);
+    const onMutate = prev => store.setState(state => inject.current(prev, state));
+    onMutate(previousRoot.getState());
+    previousRoot.subscribe(onMutate);
+    return store;
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [previousRoot, container]);
   React.useEffect(() => {
-    usePortalStore.setState(injectState => inject(previousRoot.getState(), injectState));
-  }, [inject]);
+    return () => usePortalStore.destroy();
+  }, [usePortalStore]);
   return /*#__PURE__*/React.createElement(React.Fragment, null, reconciler.createPortal( /*#__PURE__*/React.createElement(context.Provider, {
     value: usePortalStore
   }, children), usePortalStore, null));

package/dist/{index-ed22818c.cjs.prod.js → index-948f4806.cjs.prod.js}

@@ -177,13 +177,7 @@ function createRenderer(_roots, _getEventPriority) {
       }
 
       // Remove references
-      if (child.__r3f) {
-        delete child.__r3f.root;
-        delete child.__r3f.objects;
-        delete child.__r3f.handlers;
-        delete child.__r3f.memoizedProps;
-        if (!isPrimitive) delete child.__r3f;
-      }
+      delete child.__r3f;
 
       // Dispose item whenever the reconciler feels like it
       if (shouldDispose && child.dispose && child.type !== 'Scene') {
@@ -1233,8 +1227,6 @@ function createEvents(store) {
   };
 }
 
-// Keys that shouldn't be copied between R3F stores
-const privateKeys = ['set', 'get', 'setSize', 'setFrameloop', 'setDpr', 'events', 'invalidate', 'advance', 'size', 'viewport'];
 const isRenderer = def => !!(def != null && def.render);
 const context = /*#__PURE__*/React__namespace.createContext(null);
 const createStore = (invalidate, advance) => {
@@ -2064,7 +2056,6 @@ function unmountComponentAtNode(canvas, callback) {
 }
 function createPortal(children, container, state) {
   return /*#__PURE__*/React__namespace.createElement(Portal, {
-    key: container.uuid,
     children: children,
     container: container,
     state: state
@@ -2088,26 +2079,9 @@ function Portal({
   const previousRoot = useStore();
   const [raycaster] = React__namespace.useState(() => new THREE__namespace.Raycaster());
   const [pointer] = React__namespace.useState(() => new THREE__namespace.Vector2());
-  const inject = React__namespace.useCallback((rootState, injectState) => {
-    const intersect = {
-      ...rootState
-    }; // all prev state props
-
-    // Only the fields of "rootState" that do not differ from injectState
-    // Some props should be off-limits
-    // Otherwise filter out the props that are different and let the inject layer take precedence
-    Object.keys(rootState).forEach(key => {
-      if (
-      // Some props should be off-limits
-      privateKeys.includes(key) ||
-      // Otherwise filter out the props that are different and let the inject layer take precedence
-      // Unless the inject layer props is undefined, then we keep the root layer
-      rootState[key] !== injectState[key] && injectState[key]) {
-        delete intersect[key];
-      }
-    });
-    let viewport = undefined;
-    if (injectState && size) {
+  const inject = useMutableCallback((rootState, injectState) => {
+    let viewport;
+    if (injectState.camera && size) {
       const camera = injectState.camera;
       // Calculate the override viewport, if present
       viewport = rootState.viewport.getCurrentViewport(camera, new THREE__namespace.Vector3(), size);
@@ -2116,7 +2090,9 @@ function Portal({
     }
     return {
       // The intersect consists of the previous root state
-      ...intersect,
+      ...rootState,
+      get: injectState.get,
+      set: injectState.set,
       // Portals have their own scene, which forms the root, a raycaster and a pointer
       scene: container,
       raycaster,
@@ -2127,7 +2103,7 @@ function Portal({
       // Events, size and viewport can be overridden by the inject layer
       events: {
         ...rootState.events,
-        ...(injectState == null ? void 0 : injectState.events),
+        ...injectState.events,
         ...events
       },
       size: {
@@ -2138,53 +2114,33 @@ function Portal({
         ...rootState.viewport,
         ...viewport
       },
-      ...rest
-    };
-  }, [state]);
-  const [usePortalStore] = React__namespace.useState(() => {
-    // Create a mirrored store, based on the previous root with a few overrides ...
-    const previousState = previousRoot.getState();
-    const store = create__default["default"]((set, get) => ({
-      ...previousState,
-      scene: container,
-      raycaster,
-      pointer,
-      mouse: pointer,
-      previousRoot,
-      events: {
-        ...previousState.events,
-        ...events
-      },
-      size: {
-        ...previousState.size,
-        ...size
-      },
-      ...rest,
-      // Set and get refer to this root-state
-      set,
-      get,
       // Layers are allowed to override events
-      setEvents: events => set(state => ({
+      setEvents: events => injectState.set(state => ({
         ...state,
         events: {
           ...state.events,
           ...events
         }
       }))
-    }));
-    return store;
+    };
   });
-  React__namespace.useEffect(() => {
+  const usePortalStore = React__namespace.useMemo(() => {
+    const store = create__default["default"]((set, get) => ({
+      ...rest,
+      set,
+      get
+    }));
+
     // Subscribe to previous root-state and copy changes over to the mirrored portal-state
-    const unsub = previousRoot.subscribe(prev => usePortalStore.setState(state => inject(prev, state)));
-    return () => {
-      unsub();
-      usePortalStore.destroy();
-    };
-  }, []);
+    const onMutate = prev => store.setState(state => inject.current(prev, state));
+    onMutate(previousRoot.getState());
+    previousRoot.subscribe(onMutate);
+    return store;
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [previousRoot, container]);
   React__namespace.useEffect(() => {
-    usePortalStore.setState(injectState => inject(previousRoot.getState(), injectState));
-  }, [inject]);
+    return () => usePortalStore.destroy();
+  }, [usePortalStore]);
   return /*#__PURE__*/React__namespace.createElement(React__namespace.Fragment, null, reconciler.createPortal( /*#__PURE__*/React__namespace.createElement(context.Provider, {
     value: usePortalStore
   }, children), usePortalStore, null));

package/dist/{index-f4b96a62.cjs.dev.js → index-a0deb08b.cjs.dev.js}

@@ -177,13 +177,7 @@ function createRenderer(_roots, _getEventPriority) {
       }
 
       // Remove references
-      if (child.__r3f) {
-        delete child.__r3f.root;
-        delete child.__r3f.objects;
-        delete child.__r3f.handlers;
-        delete child.__r3f.memoizedProps;
-        if (!isPrimitive) delete child.__r3f;
-      }
+      delete child.__r3f;
 
       // Dispose item whenever the reconciler feels like it
       if (shouldDispose && child.dispose && child.type !== 'Scene') {
@@ -1233,8 +1227,6 @@ function createEvents(store) {
   };
 }
 
-// Keys that shouldn't be copied between R3F stores
-const privateKeys = ['set', 'get', 'setSize', 'setFrameloop', 'setDpr', 'events', 'invalidate', 'advance', 'size', 'viewport'];
 const isRenderer = def => !!(def != null && def.render);
 const context = /*#__PURE__*/React__namespace.createContext(null);
 const createStore = (invalidate, advance) => {
@@ -2064,7 +2056,6 @@ function unmountComponentAtNode(canvas, callback) {
 }
 function createPortal(children, container, state) {
   return /*#__PURE__*/React__namespace.createElement(Portal, {
-    key: container.uuid,
     children: children,
     container: container,
     state: state
@@ -2088,26 +2079,9 @@ function Portal({
   const previousRoot = useStore();
   const [raycaster] = React__namespace.useState(() => new THREE__namespace.Raycaster());
   const [pointer] = React__namespace.useState(() => new THREE__namespace.Vector2());
-  const inject = React__namespace.useCallback((rootState, injectState) => {
-    const intersect = {
-      ...rootState
-    }; // all prev state props
-
-    // Only the fields of "rootState" that do not differ from injectState
-    // Some props should be off-limits
-    // Otherwise filter out the props that are different and let the inject layer take precedence
-    Object.keys(rootState).forEach(key => {
-      if (
-      // Some props should be off-limits
-      privateKeys.includes(key) ||
-      // Otherwise filter out the props that are different and let the inject layer take precedence
-      // Unless the inject layer props is undefined, then we keep the root layer
-      rootState[key] !== injectState[key] && injectState[key]) {
-        delete intersect[key];
-      }
-    });
-    let viewport = undefined;
-    if (injectState && size) {
+  const inject = useMutableCallback((rootState, injectState) => {
+    let viewport;
+    if (injectState.camera && size) {
       const camera = injectState.camera;
       // Calculate the override viewport, if present
       viewport = rootState.viewport.getCurrentViewport(camera, new THREE__namespace.Vector3(), size);
@@ -2116,7 +2090,9 @@ function Portal({
     }
     return {
       // The intersect consists of the previous root state
-      ...intersect,
+      ...rootState,
+      get: injectState.get,
+      set: injectState.set,
       // Portals have their own scene, which forms the root, a raycaster and a pointer
       scene: container,
       raycaster,
@@ -2127,7 +2103,7 @@ function Portal({
       // Events, size and viewport can be overridden by the inject layer
       events: {
         ...rootState.events,
-        ...(injectState == null ? void 0 : injectState.events),
+        ...injectState.events,
         ...events
       },
       size: {
@@ -2138,53 +2114,33 @@ function Portal({
         ...rootState.viewport,
         ...viewport
       },
-      ...rest
-    };
-  }, [state]);
-  const [usePortalStore] = React__namespace.useState(() => {
-    // Create a mirrored store, based on the previous root with a few overrides ...
-    const previousState = previousRoot.getState();
-    const store = create__default["default"]((set, get) => ({
-      ...previousState,
-      scene: container,
-      raycaster,
-      pointer,
-      mouse: pointer,
-      previousRoot,
-      events: {
-        ...previousState.events,
-        ...events
-      },
-      size: {
-        ...previousState.size,
-        ...size
-      },
-      ...rest,
-      // Set and get refer to this root-state
-      set,
-      get,
       // Layers are allowed to override events
-      setEvents: events => set(state => ({
+      setEvents: events => injectState.set(state => ({
         ...state,
         events: {
           ...state.events,
           ...events
         }
       }))
-    }));
-    return store;
+    };
   });
-  React__namespace.useEffect(() => {
+  const usePortalStore = React__namespace.useMemo(() => {
+    const store = create__default["default"]((set, get) => ({
+      ...rest,
+      set,
+      get
+    }));
+
     // Subscribe to previous root-state and copy changes over to the mirrored portal-state
-    const unsub = previousRoot.subscribe(prev => usePortalStore.setState(state => inject(prev, state)));
-    return () => {
-      unsub();
-      usePortalStore.destroy();
-    };
-  }, []);
+    const onMutate = prev => store.setState(state => inject.current(prev, state));
+    onMutate(previousRoot.getState());
+    previousRoot.subscribe(onMutate);
+    return store;
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [previousRoot, container]);
   React__namespace.useEffect(() => {
-    usePortalStore.setState(injectState => inject(previousRoot.getState(), injectState));
-  }, [inject]);
+    return () => usePortalStore.destroy();
+  }, [usePortalStore]);
   return /*#__PURE__*/React__namespace.createElement(React__namespace.Fragment, null, reconciler.createPortal( /*#__PURE__*/React__namespace.createElement(context.Provider, {
     value: usePortalStore
   }, children), usePortalStore, null));

package/dist/react-three-fiber.cjs.dev.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var index = require('./index-f4b96a62.cjs.dev.js');
+var index = require('./index-a0deb08b.cjs.dev.js');
 var _extends = require('@babel/runtime/helpers/extends');
 var React = require('react');
 var THREE = require('three');

package/dist/react-three-fiber.cjs.prod.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var index = require('./index-ed22818c.cjs.prod.js');
+var index = require('./index-948f4806.cjs.prod.js');
 var _extends = require('@babel/runtime/helpers/extends');
 var React = require('react');
 var THREE = require('three');

package/dist/react-three-fiber.esm.js

@@ -1,5 +1,5 @@
-import { c as createEvents, e as extend, u as useMutableCallback, a as useIsomorphicLayoutEffect, b as createRoot, i as isRef, E as ErrorBoundary, B as Block, d as unmountComponentAtNode } from './index-22ee0173.esm.js';
-export { t as ReactThreeFiber, w as _roots, v as act, o as addAfterEffect, n as addEffect, p as addTail, m as advance, j as applyProps, f as context, c as createEvents, g as createPortal, b as createRoot, k as dispose, e as extend, q as flushGlobalEffects, s as getRootState, l as invalidate, h as reconciler, r as render, d as unmountComponentAtNode, A as useFrame, C as useGraph, x as useInstanceHandle, D as useLoader, y as useStore, z as useThree } from './index-22ee0173.esm.js';
+import { c as createEvents, e as extend, u as useMutableCallback, a as useIsomorphicLayoutEffect, b as createRoot, i as isRef, E as ErrorBoundary, B as Block, d as unmountComponentAtNode } from './index-13b06ff5.esm.js';
+export { t as ReactThreeFiber, w as _roots, v as act, o as addAfterEffect, n as addEffect, p as addTail, m as advance, j as applyProps, f as context, c as createEvents, g as createPortal, b as createRoot, k as dispose, e as extend, q as flushGlobalEffects, s as getRootState, l as invalidate, h as reconciler, r as render, d as unmountComponentAtNode, A as useFrame, C as useGraph, x as useInstanceHandle, D as useLoader, y as useStore, z as useThree } from './index-13b06ff5.esm.js';
 import _extends from '@babel/runtime/helpers/esm/extends';
 import * as React from 'react';
 import * as THREE from 'three';

package/native/dist/react-three-fiber-native.cjs.dev.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var index = require('../../dist/index-f4b96a62.cjs.dev.js');
+var index = require('../../dist/index-a0deb08b.cjs.dev.js');
 var _extends = require('@babel/runtime/helpers/extends');
 var React = require('react');
 var THREE = require('three');

package/native/dist/react-three-fiber-native.cjs.prod.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var index = require('../../dist/index-ed22818c.cjs.prod.js');
+var index = require('../../dist/index-948f4806.cjs.prod.js');
 var _extends = require('@babel/runtime/helpers/extends');
 var React = require('react');
 var THREE = require('three');

package/native/dist/react-three-fiber-native.esm.js

@@ -1,5 +1,5 @@
-import { c as createEvents, e as extend, u as useMutableCallback, b as createRoot, E as ErrorBoundary, B as Block, d as unmountComponentAtNode } from '../../dist/index-22ee0173.esm.js';
-export { t as ReactThreeFiber, w as _roots, v as act, o as addAfterEffect, n as addEffect, p as addTail, m as advance, j as applyProps, f as context, c as createEvents, g as createPortal, b as createRoot, k as dispose, e as extend, q as flushGlobalEffects, s as getRootState, l as invalidate, h as reconciler, r as render, d as unmountComponentAtNode, A as useFrame, C as useGraph, x as useInstanceHandle, D as useLoader, y as useStore, z as useThree } from '../../dist/index-22ee0173.esm.js';
+import { c as createEvents, e as extend, u as useMutableCallback, b as createRoot, E as ErrorBoundary, B as Block, d as unmountComponentAtNode } from '../../dist/index-13b06ff5.esm.js';
+export { t as ReactThreeFiber, w as _roots, v as act, o as addAfterEffect, n as addEffect, p as addTail, m as advance, j as applyProps, f as context, c as createEvents, g as createPortal, b as createRoot, k as dispose, e as extend, q as flushGlobalEffects, s as getRootState, l as invalidate, h as reconciler, r as render, d as unmountComponentAtNode, A as useFrame, C as useGraph, x as useInstanceHandle, D as useLoader, y as useStore, z as useThree } from '../../dist/index-13b06ff5.esm.js';
 import _extends from '@babel/runtime/helpers/esm/extends';
 import * as React from 'react';
 import * as THREE from 'three';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-three/fiber",
-  "version": "8.13.0",
+  "version": "8.13.1",
   "description": "A React renderer for Threejs",
   "keywords": [
     "react",

package/readme.md

@@ -201,7 +201,7 @@ Visit [docs.pmnd.rs](https://docs.pmnd.rs/react-three-fiber)
 
 # Fundamentals
 
-You need to be versed in both React and Threejs before rushing into this. If you are unsure about React consult the official [React docs](https://reactjs.org/docs/getting-started.html), especially [the section about hooks](https://reactjs.org/docs/hooks-reference.html). As for Threejs, make sure you at least glance over the following links:
+You need to be versed in both React and Threejs before rushing into this. If you are unsure about React consult the official [React docs](https://react.dev/learn), especially [the section about hooks](https://react.dev/reference/react). As for Threejs, make sure you at least glance over the following links:
 
 1. Make sure you have a [basic grasp of Threejs](https://threejs.org/docs/index.html#manual/en/introduction/Creating-a-scene). Keep that site open.
 2. When you know what a scene is, a camera, mesh, geometry, material, fork the [demo above](https://github.com/pmndrs/react-three-fiber#what-does-it-look-like).