Merge branch 'next' into internal-fix-resizer

examples/react/src/examples/Layouting/index.tsx

@@ -19,6 +19,7 @@ import {
 import initialItems from './initial-elements';
 
 import styles from './layouting.module.css';
+import ReactFlowDevTools from '../DevTools/DevTools';
 
 const dagreGraph = new dagre.graphlib.Graph();
 dagreGraph.setDefaultEdgeLabel(() => ({}));
@@ -98,6 +99,7 @@ const LayoutFlow = () => {
         onEdgesChange={onEdgesChange}
       >
         <Controls />
+        <ReactFlowDevTools />
       </ReactFlow>
       <Panel position="top-right">
         <button onClick={() => onLayout('TB')}>vertical layout</button>

packages/react/CHANGELOG.md

@@ -1,10 +1,14 @@
 # @xyflow/react
 
-## 12.0.0-next.x
+## 12.0.0-next.14
 
 ## Patch changes
 
 - fix hidden nodes
+- use `direction=ltr` for outer wrapper to support rtl sites
+- allow pinch zoom even if `preventScrolling=false`
+- export node and edge change related types
+- only trigger dimensions updates when changes detected
 
 ## 12.0.0-next.13
 

packages/react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyflow/react",
-  "version": "12.0.0-next.13",
+  "version": "12.0.0-next.14",
   "description": "React Flow - A highly customizable React library for building node-based editors and interactive flow charts.",
   "keywords": [
     "react",

packages/react/src/components/NodeWrapper/index.tsx

@@ -123,7 +123,7 @@ export function NodeWrapper<NodeType extends Node>({
       if (targetPosChanged) {
         prevTargetPosition.current = node.targetPosition;
       }
-      store.getState().updateNodeDimensions(new Map([[id, { id, nodeElement: nodeRef.current, force: true }]]));
+      store.getState().updateNodeInternals(new Map([[id, { id, nodeElement: nodeRef.current, force: true }]]));
     }
   }, [id, nodeType, node.sourcePosition, node.targetPosition]);
 

packages/react/src/container/NodeRenderer/useResizeObserver.ts

@@ -2,12 +2,12 @@ import { useEffect, useMemo, useRef } from 'react';
 
 import { ReactFlowState } from '../../types';
 import { useStore } from '../../hooks/useStore';
-import { NodeDimensionUpdate } from '@xyflow/system';
+import { InternalNodeUpdate } from '@xyflow/system';
 
-const selector = (s: ReactFlowState) => s.updateNodeDimensions;
+const selector = (s: ReactFlowState) => s.updateNodeInternals;
 
 export function useResizeObserver() {
-  const updateNodeDimensions = useStore(selector);
+  const updateNodeInternals = useStore(selector);
   const resizeObserverRef = useRef<ResizeObserver>();
 
   const resizeObserver = useMemo(() => {
@@ -16,7 +16,7 @@ export function useResizeObserver() {
     }
 
     const observer = new ResizeObserver((entries: ResizeObserverEntry[]) => {
-      const updates = new Map<string, NodeDimensionUpdate>();
+      const updates = new Map<string, InternalNodeUpdate>();
 
       entries.forEach((entry: ResizeObserverEntry) => {
         const id = entry.target.getAttribute('data-id') as string;
@@ -26,7 +26,7 @@ export function useResizeObserver() {
         });
       });
 
-      updateNodeDimensions(updates);
+      updateNodeInternals(updates);
     });
 
     resizeObserverRef.current = observer;

packages/react/src/hooks/useUpdateNodeInternals.ts

@@ -1,5 +1,5 @@
 import { useCallback } from 'react';
-import type { UpdateNodeInternals, NodeDimensionUpdate } from '@xyflow/system';
+import type { UpdateNodeInternals, InternalNodeUpdate } from '@xyflow/system';
 
 import { useStoreApi } from '../hooks/useStore';
 
@@ -13,9 +13,9 @@ export function useUpdateNodeInternals(): UpdateNodeInternals {
   const store = useStoreApi();
 
   return useCallback<UpdateNodeInternals>((id: string | string[]) => {
-    const { domNode, updateNodeDimensions } = store.getState();
+    const { domNode, updateNodeInternals } = store.getState();
     const updateIds = Array.isArray(id) ? id : [id];
-    const updates = new Map<string, NodeDimensionUpdate>();
+    const updates = new Map<string, InternalNodeUpdate>();
 
     updateIds.forEach((updateId) => {
       const nodeElement = domNode?.querySelector(`.react-flow__node[data-id="${updateId}"]`) as HTMLDivElement;
@@ -25,6 +25,6 @@ export function useUpdateNodeInternals(): UpdateNodeInternals {
       }
     });
 
-    requestAnimationFrame(() => updateNodeDimensions(updates));
+    requestAnimationFrame(() => updateNodeInternals(updates));
   }, []);
 }

packages/react/src/store/index.ts

@@ -5,7 +5,7 @@ import {
   adoptUserNodes,
   updateAbsolutePositions,
   panBy as panBySystem,
-  updateNodeDimensions as updateNodeDimensionsSystem,
+  updateNodeInternals as updateNodeInternalsSystem,
   updateConnectionLookup,
   handleParentExpand,
   NodeChange,
@@ -71,7 +71,7 @@ const createRFStore = ({
       // Every node gets registerd at a ResizeObserver. Whenever a node
       // changes its dimensions, this function is called to measure the
       // new dimensions and update the nodes.
-      updateNodeDimensions: (updates) => {
+      updateNodeInternals: (updates) => {
         const {
           onNodesChange,
           fitView,
@@ -84,9 +84,9 @@ const createRFStore = ({
           debug,
         } = get();
 
-        const changes = updateNodeDimensionsSystem(updates, nodeLookup, domNode, nodeOrigin);
+        const { changes, updatedInternals } = updateNodeInternalsSystem(updates, nodeLookup, domNode, nodeOrigin);
 
-        if (changes.length === 0) {
+        if (!updatedInternals) {
           return;
         }
 

packages/react/src/types/store.ts

@@ -2,7 +2,7 @@ import {
   ConnectionMode,
   type ConnectionStatus,
   type CoordinateExtent,
-  type NodeDimensionUpdate,
+  type InternalNodeUpdate,
   type UpdateNodePositions,
   type NodeOrigin,
   type OnConnect,
@@ -154,7 +154,7 @@ export type ReactFlowActions<NodeType extends Node, EdgeType extends Edge> = {
   setNodes: (nodes: NodeType[]) => void;
   setEdges: (edges: EdgeType[]) => void;
   setDefaultNodesAndEdges: (nodes?: NodeType[], edges?: EdgeType[]) => void;
-  updateNodeDimensions: (updates: Map<string, NodeDimensionUpdate>) => void;
+  updateNodeInternals: (updates: Map<string, InternalNodeUpdate>) => void;
   updateNodePositions: UpdateNodePositions;
   resetSelectedElements: () => void;
   unselectNodesAndEdges: (params?: UnselectNodesAndEdgesParams) => void;

packages/svelte/src/lib/components/NodeWrapper/NodeWrapper.svelte

@@ -52,7 +52,7 @@
     nodeDragThreshold,
     selectNodesOnDrag,
     handleNodeSelection,
-    updateNodeDimensions
+    updateNodeInternals
   } = store;
 
   let nodeRef: HTMLDivElement;
@@ -97,7 +97,7 @@
 
     if (doUpdate) {
       requestAnimationFrame(() =>
-        updateNodeDimensions(
+        updateNodeInternals(
           new Map([
             [
               id,

packages/svelte/src/lib/container/NodeRenderer/NodeRenderer.svelte

@@ -10,7 +10,7 @@
     nodesDraggable,
     nodesConnectable,
     elementsSelectable,
-    updateNodeDimensions
+    updateNodeInternals
   } = useStore();
 
   const resizeObserver: ResizeObserver | null =
@@ -29,7 +29,7 @@
             });
           });
 
-          updateNodeDimensions(updates);
+          updateNodeInternals(updates);
         });
 
   onDestroy(() => {

packages/svelte/src/lib/hooks/useUpdateNodeInternals.ts

@@ -10,7 +10,7 @@ import { useStore } from '$lib/store';
  * @returns function for updating node internals
  */
 export function useUpdateNodeInternals(): UpdateNodeInternals {
-  const { domNode, updateNodeDimensions } = useStore();
+  const { domNode, updateNodeInternals } = useStore();
 
   // @todo: do we want to add this to system?
   const updateInternals = (id: string | string[]) => {
@@ -27,7 +27,7 @@ export function useUpdateNodeInternals(): UpdateNodeInternals {
       }
     });
 
-    requestAnimationFrame(() => updateNodeDimensions(updates));
+    requestAnimationFrame(() => updateNodeInternals(updates));
   };
 
   return updateInternals;

packages/svelte/src/lib/store/index.ts

@@ -5,10 +5,10 @@ import {
   fitView as fitViewUtil,
   getElementsToRemove,
   panBy as panBySystem,
-  updateNodeDimensions as updateNodeDimensionsSystem,
+  updateNodeInternals as updateNodeInternalsSystem,
   addEdge as addEdgeUtil,
   type UpdateNodePositions,
-  type NodeDimensionUpdate,
+  type InternalNodeUpdate,
   type ViewportHelperFunctionOptions,
   type Connection,
   type XYPosition,
@@ -78,16 +78,16 @@ export function createStore({
     store.nodes.update((nds) => nds);
   };
 
-  function updateNodeDimensions(updates: Map<string, NodeDimensionUpdate>) {
+  function updateNodeInternals(updates: Map<string, InternalNodeUpdate>) {
     const nodeLookup = get(store.nodeLookup);
-    const changes = updateNodeDimensionsSystem(
+    const { changes, updatedInternals } = updateNodeInternalsSystem(
       updates,
       nodeLookup,
       get(store.domNode),
       get(store.nodeOrigin)
     );
 
-    if (!changes) {
+    if (!updatedInternals) {
       return;
     }
 
@@ -400,7 +400,7 @@ export function createStore({
     setEdgeTypes,
     addEdge,
     updateNodePositions,
-    updateNodeDimensions,
+    updateNodeInternals,
     zoomIn,
     zoomOut,
     fitView: (options?: FitViewOptions) => fitView(options),

packages/svelte/src/lib/store/types.ts

@@ -1,6 +1,6 @@
 import type { Writable } from 'svelte/store';
 import type {
-  NodeDimensionUpdate,
+  InternalNodeUpdate,
   XYPosition,
   ViewportHelperFunctionOptions,
   Connection,
@@ -27,7 +27,7 @@ export type SvelteFlowStoreActions = {
   setTranslateExtent: (extent: CoordinateExtent) => void;
   fitView: (options?: FitViewOptions) => boolean;
   updateNodePositions: UpdateNodePositions;
-  updateNodeDimensions: (updates: Map<string, NodeDimensionUpdate>) => void;
+  updateNodeInternals: (updates: Map<string, InternalNodeUpdate>) => void;
   unselectNodesAndEdges: (params?: { nodes?: Node[]; edges?: Edge[] }) => void;
   addSelectedNodes: (ids: string[]) => void;
   addSelectedEdges: (ids: string[]) => void;

packages/system/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyflow/system",
-  "version": "0.0.22",
+  "version": "0.0.23",
   "description": "xyflow core system that powers React Flow and Svelte Flow.",
   "keywords": [
     "node-based UI",

packages/system/src/types/nodes.ts

@@ -105,7 +105,7 @@ export type NodeHandleBounds = {
   target: HandleElement[] | null;
 };
 
-export type NodeDimensionUpdate = {
+export type InternalNodeUpdate = {
   id: string;
   nodeElement: HTMLDivElement;
   force?: boolean;

packages/system/src/utils/store.ts

@@ -1,7 +1,7 @@
 import {
   NodeBase,
   CoordinateExtent,
-  NodeDimensionUpdate,
+  InternalNodeUpdate,
   NodeOrigin,
   PanZoomInstance,
   Transform,
@@ -11,7 +11,6 @@ import {
   EdgeBase,
   EdgeLookup,
   InternalNodeBase,
-  NodeChange,
   NodeLookup,
   Rect,
   NodeDimensionChange,
@@ -213,16 +212,17 @@ export function handleParentExpand(
   return changes;
 }
 
-export function updateNodeDimensions<NodeType extends InternalNodeBase>(
-  updates: Map<string, NodeDimensionUpdate>,
+export function updateNodeInternals<NodeType extends InternalNodeBase>(
+  updates: Map<string, InternalNodeUpdate>,
   nodeLookup: Map<string, NodeType>,
   domNode: HTMLElement | null,
   nodeOrigin?: NodeOrigin
-): (NodeDimensionChange | NodePositionChange)[] {
+): { changes: (NodeDimensionChange | NodePositionChange)[]; updatedInternals: boolean } {
   const viewportNode = domNode?.querySelector('.xyflow__viewport');
+  let updatedInternals = false;
 
   if (!viewportNode) {
-    return [];
+    return { changes: [], updatedInternals };
   }
 
   const changes: (NodeDimensionChange | NodePositionChange)[] = [];
@@ -242,24 +242,20 @@ export function updateNodeDimensions<NodeType extends InternalNodeBase>(
           handleBounds: undefined,
         },
       });
+      updatedInternals = true;
     } else if (node) {
       const dimensions = getDimensions(update.nodeElement);
+      const dimensionChanged = node.measured.width !== dimensions.width || node.measured.height !== dimensions.height;
       const doUpdate = !!(
         dimensions.width &&
         dimensions.height &&
-        (node.measured?.width !== dimensions.width ||
-          node.measured?.height !== dimensions.height ||
-          !node.internals.handleBounds ||
-          update.force)
+        (dimensionChanged || !node.internals.handleBounds || update.force)
       );
 
       if (doUpdate) {
         const newNode = {
           ...node,
-          measured: {
-            ...node.measured,
-            ...dimensions,
-          },
+          measured: dimensions,
           internals: {
             ...node.internals,
             handleBounds: {
@@ -270,15 +266,18 @@ export function updateNodeDimensions<NodeType extends InternalNodeBase>(
         };
 
         nodeLookup.set(node.id, newNode);
+        updatedInternals = true;
 
-        changes.push({
-          id: newNode.id,
-          type: 'dimensions',
-          dimensions,
-        });
+        if (dimensionChanged) {
+          changes.push({
+            id: newNode.id,
+            type: 'dimensions',
+            dimensions,
+          });
 
-        if (newNode.expandParent) {
-          triggerChangeNodes.push(newNode);
+          if (newNode.expandParent) {
+            triggerChangeNodes.push(newNode);
+          }
         }
       }
     }
@@ -289,7 +288,7 @@ export function updateNodeDimensions<NodeType extends InternalNodeBase>(
     changes.push(...parentExpandChanges);
   }
 
-  return changes;
+  return { changes, updatedInternals };
 }
 
 export function panBy({