init commit

Release packages

.changeset/empty-paws-cough.md

@@ -1,5 +0,0 @@
----
-'@xyflow/react': patch
----
-
-Optimize zooming performance when panOnScroll mode is enabled

.changeset/friendly-grapes-lay.md

@@ -1,5 +0,0 @@
----
-'@xyflow/react': patch
----
-
-Prevent unnecessary updates when selectNodesOnDrag = false

.changeset/strong-suns-grow.md

@@ -1,5 +0,0 @@
----
-'@xyflow/react': patch
----
-
-Handle undefined node in mini map

examples/react/src/App/routes.ts

@@ -62,6 +62,7 @@ import MovingHandles from '../examples/MovingHandles';
 import DetachedHandle from '../examples/DetachedHandle';
 import ZIndexMode from '../examples/ZIndexMode';
 import Middlewares from '../examples/Middlewares';
+import NodeSelectionBug from '../examples/NodeSelectionBug';
 
 export interface IRoute {
   name: string;
@@ -390,6 +391,11 @@ const routes: IRoute[] = [
     path: 'z-index-mode',
     component: ZIndexMode,
   },
+  {
+    name: 'Node Selection Bug',
+    path: 'node-selection-bug',
+    component: NodeSelectionBug,
+  },
 ];
 
 export default routes;

examples/react/src/examples/NodeSelectionBug/index.tsx

@@ -0,0 +1,41 @@
+import { Node, ReactFlow, useNodesState } from '@xyflow/react';
+
+import '@xyflow/react/dist/style.css';
+import { useRef } from 'react';
+
+export default function App() {
+  const [nodes, setNodes, onNodesChange] = useNodesState<Node>([
+    {
+      id: '0',
+      position: { x: 0, y: 0 },
+      data: { label: 'Rectangle Select Me First' },
+    },
+  ]);
+  const id = useRef(0);
+  return (
+    <>
+      <button
+        onClick={() =>
+          setNodes((nodes) => [
+            ...nodes.map((node) => ({ ...node, selected: false })),
+            {
+              id: (++id.current).toString(),
+              position: { x: -100, y: 100 * Math.floor((id.current + 1) / 2) },
+              data: { label: `Button Node ${id.current}` },
+              selected: true,
+            },
+            {
+              id: (++id.current).toString(),
+              position: { x: 100, y: (100 * id.current) / 2 },
+              data: { label: `Button Node ${id.current}` },
+              selected: true,
+            },
+          ])
+        }
+      >
+        Click me to add nodes that are already selected.
+      </button>
+      <ReactFlow nodes={nodes} onNodesChange={onNodesChange} fitView></ReactFlow>
+    </>
+  );
+}

examples/react/src/examples/UseNodesData/TextNode.tsx

@@ -1,7 +1,8 @@
 import { memo, useState } from 'react';
 import { Position, NodeProps, Handle, useReactFlow } from '@xyflow/react';
+import type { TextNode } from '.';
 
-function TextNode({ id, data }: NodeProps) {
+function TextNode({ id, data }: NodeProps<TextNode>) {
   const { updateNodeData } = useReactFlow();
   const [text, setText] = useState(data.text);
   const updateText = (text: string) => {

examples/react/src/examples/UseNodesData/UppercaseNode.tsx

@@ -1,18 +1,18 @@
 import { memo, useEffect } from 'react';
 import { Position, NodeProps, useReactFlow, Handle, useNodeConnections, useNodesData } from '@xyflow/react';
-import { isTextNode, type TextNode, type MyNode } from '.';
+import { isTextNode, type TextNode, type MyNode, type UppercaseNode } from '.';
 
-function UppercaseNode({ id }: NodeProps) {
+function UppercaseNode({ id }: NodeProps<UppercaseNode>) {
   const { updateNodeData } = useReactFlow();
   const connections = useNodeConnections({
     handleType: 'target',
   });
   const nodesData = useNodesData<MyNode>(connections[0]?.source);
-  const textNode = isTextNode(nodesData) ? nodesData : null;
 
   useEffect(() => {
-    updateNodeData(id, { text: textNode?.data.text.toUpperCase() });
-  }, [textNode]);
+    const text = nodesData?.type === 'text' ? nodesData?.data.text.toUpperCase() : undefined;
+    updateNodeData(id, { text });
+  }, [nodesData]);
 
   return (
     <div style={{ background: '#eee', color: '#222', padding: 10, fontSize: 12, borderRadius: 10 }}>

examples/svelte/src/routes/examples/usenodesdata/UppercaseNode.svelte

@@ -8,22 +8,21 @@
 		type Node,
 		type NodeProps
 	} from '@xyflow/svelte';
-	import { isTextNode, type MyNode } from './+page.svelte';
+	import { type MyNode } from './+page.svelte';
 
 	let { id }: NodeProps<Node<{ text: string }>> = $props();
 
 	const { updateNodeData } = useSvelteFlow();
 	const connections = useNodeConnections({
-		id: id,
 		handleType: 'target'
 	});
 
-	let nodeData = $derived(useNodesData<MyNode>(connections.current[0]?.source));
-	let textNodeData = $derived(isTextNode(nodeData.current) ? nodeData.current.data.text : null);
+	let nodesData = $derived(useNodesData<MyNode>(connections.current[0]?.source));
 
 	$effect.pre(() => {
-		const input = textNodeData?.toUpperCase() ?? '';
-		updateNodeData(id, { text: input });
+		const text =
+			nodesData.current?.type === 'text' ? nodesData.current?.data.text.toUpperCase() : undefined;
+		updateNodeData(id, { text });
 	});
 </script>
 

packages/react/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @xyflow/react
 
+## 12.10.1
+
+### Patch Changes
+
+- [#5704](https://github.com/xyflow/xyflow/pull/5704) [`c91d3d022`](https://github.com/xyflow/xyflow/commit/c91d3d022f4517f4403a898cd02ee891b7e1f2d2) Thanks [@peterkogo](https://github.com/peterkogo)! - Keep `onConnectEnd` and `isValidConnection` up to date in an ongoing connection
+
+- [#5687](https://github.com/xyflow/xyflow/pull/5687) [`2624479ad`](https://github.com/xyflow/xyflow/commit/2624479ad3d0b06fcb690242b2372ff2a7e16f54) Thanks [@vkrol](https://github.com/vkrol)! - Optimize zooming performance when panOnScroll mode is enabled
+
+- [#5682](https://github.com/xyflow/xyflow/pull/5682) [`7b6e46ce1`](https://github.com/xyflow/xyflow/commit/7b6e46ce17f49e759f614a8f933f7dc729635b48) Thanks [@artemtam](https://github.com/artemtam)! - Prevent unnecessary updates when selectNodesOnDrag = false
+
+- [#5703](https://github.com/xyflow/xyflow/pull/5703) [`ce6c869df`](https://github.com/xyflow/xyflow/commit/ce6c869df40b2b013484808c742ca508da4a591f) Thanks [@peterkogo](https://github.com/peterkogo)! - Improve return type of useNodesData. Now you can narrow down the data type by checking the node type.
+
+- [#5692](https://github.com/xyflow/xyflow/pull/5692) [`49646858f`](https://github.com/xyflow/xyflow/commit/49646858f951455921aedbb83725b4225dbdef9d) Thanks [@moklick](https://github.com/moklick)! - Handle undefined node in mini map
+
+- [#5684](https://github.com/xyflow/xyflow/pull/5684) [`382c654c3`](https://github.com/xyflow/xyflow/commit/382c654c315accca2005e39d477eed6649f12e40) Thanks [@ysds](https://github.com/ysds)! - Consolidate drag handler effects in useDrag to fix programmatic selection issues
+
+- Updated dependencies [[`ce6c869df`](https://github.com/xyflow/xyflow/commit/ce6c869df40b2b013484808c742ca508da4a591f)]:
+  - @xyflow/system@0.0.75
+
 ## 12.10.0
 
 ### Minor Changes

packages/react/package.json

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

packages/react/src/components/EdgeWrapper/EdgeUpdateAnchors.tsx

@@ -53,12 +53,10 @@ export function EdgeUpdateAnchors<EdgeType extends Edge = Edge>({
     const {
       autoPanOnConnect,
       domNode,
-      isValidConnection,
       connectionMode,
       connectionRadius,
       lib,
       onConnectStart,
-      onConnectEnd,
       cancelConnection,
       nodeLookup,
       rfId: flowId,
@@ -93,10 +91,10 @@ export function EdgeUpdateAnchors<EdgeType extends Edge = Edge>({
       flowId,
       cancelConnection,
       panBy,
-      isValidConnection,
+      isValidConnection: (...args) => store.getState().isValidConnection?.(...args) ?? true,
       onConnect: onConnectEdge,
       onConnectStart: _onConnectStart,
-      onConnectEnd,
+      onConnectEnd: (...args) => store.getState().onConnectEnd?.(...args),
       onReconnectEnd: _onReconnectEnd,
       updateConnection,
       getTransform: () => store.getState().transform,

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

@@ -142,10 +142,10 @@ function HandleComponent(
         panBy: currentStore.panBy,
         cancelConnection: currentStore.cancelConnection,
         onConnectStart: currentStore.onConnectStart,
-        onConnectEnd: currentStore.onConnectEnd,
+        onConnectEnd: (...args) => store.getState().onConnectEnd?.(...args),
         updateConnection: currentStore.updateConnection,
         onConnect: onConnectExtended,
-        isValidConnection: isValidConnection || currentStore.isValidConnection,
+        isValidConnection: isValidConnection || ((...args) => store.getState().isValidConnection?.(...args) ?? true),
         getTransform: () => store.getState().transform,
         getFromHandle: () => store.getState().connection.fromHandle,
         autoPanSpeed: currentStore.autoPanSpeed,

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

@@ -51,11 +51,14 @@ export function NodesSelection<NodeType extends Node>({
     }
   }, [disableKeyboardA11y]);
 
+  const shouldRender = !userSelectionActive && width !== null && height !== null;
+
   useDrag({
     nodeRef,
+    disabled: !shouldRender,
   });
 
-  if (userSelectionActive || !width || !height) {
+  if (!shouldRender) {
     return null;
   }
 

packages/react/src/hooks/useDrag.ts

@@ -52,22 +52,23 @@ export function useDrag({
   }, []);
 
   useEffect(() => {
-    if (disabled) {
-      xyDrag.current?.destroy();
-    } else if (nodeRef.current) {
-      xyDrag.current?.update({
-        noDragClassName,
-        handleSelector,
-        domNode: nodeRef.current,
-        isSelectable,
-        nodeId,
-        nodeClickDistance,
-      });
-      return () => {
-        xyDrag.current?.destroy();
-      };
+    if (disabled || !nodeRef.current || !xyDrag.current) {
+      return;
     }
-  }, [noDragClassName, handleSelector, disabled, isSelectable, nodeRef, nodeId]);
+
+    xyDrag.current.update({
+      noDragClassName,
+      handleSelector,
+      domNode: nodeRef.current,
+      isSelectable,
+      nodeId,
+      nodeClickDistance,
+    });
+
+    return () => {
+      xyDrag.current?.destroy();
+    };
+  }, [noDragClassName, handleSelector, disabled, isSelectable, nodeRef, nodeId, nodeClickDistance]);
 
   return dragging;
 }

packages/react/src/hooks/useNodesData.ts

@@ -1,5 +1,5 @@
 import { useCallback } from 'react';
-import { shallowNodeData } from '@xyflow/system';
+import { DistributivePick, shallowNodeData } from '@xyflow/system';
 
 import { useStore } from '../hooks/useStore';
 import type { Node } from '../types';
@@ -25,11 +25,11 @@ import type { Node } from '../types';
 export function useNodesData<NodeType extends Node = Node>(
   /** The id of the node to get the data from. */
   nodeId: string
-): Pick<NodeType, 'id' | 'type' | 'data'> | null;
+): DistributivePick<NodeType, 'id' | 'type' | 'data'> | null;
 export function useNodesData<NodeType extends Node = Node>(
   /** The ids of the nodes to get the data from. */
   nodeIds: string[]
-): Pick<NodeType, 'id' | 'type' | 'data'>[];
+): DistributivePick<NodeType, 'id' | 'type' | 'data'>[];
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function useNodesData(nodeIds: any): any {
   const nodesData = useStore(

packages/svelte/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @xyflow/svelte
 
+## 1.5.1
+
+### Patch Changes
+
+- [#5704](https://github.com/xyflow/xyflow/pull/5704) [`c91d3d022`](https://github.com/xyflow/xyflow/commit/c91d3d022f4517f4403a898cd02ee891b7e1f2d2) Thanks [@peterkogo](https://github.com/peterkogo)! - Keep `onConnectEnd` and `isValidConnection` up to date in an ongoing connection
+
+- [#5703](https://github.com/xyflow/xyflow/pull/5703) [`ce6c869df`](https://github.com/xyflow/xyflow/commit/ce6c869df40b2b013484808c742ca508da4a591f) Thanks [@peterkogo](https://github.com/peterkogo)! - Improve return type of useNodesData. Now you can narrow down the data type by checking the node type.
+
+- [#5698](https://github.com/xyflow/xyflow/pull/5698) [`7eeebc9c0`](https://github.com/xyflow/xyflow/commit/7eeebc9c04ce88f821363e3ea83e4dae36e04c45) Thanks [@peterkogo](https://github.com/peterkogo)! - Fix child nodes not updating on the Minimap when parent is dragged
+
+- Updated dependencies [[`ce6c869df`](https://github.com/xyflow/xyflow/commit/ce6c869df40b2b013484808c742ca508da4a591f)]:
+  - @xyflow/system@0.0.75
+
 ## 1.5.0
 
 ### Minor Changes

packages/svelte/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyflow/svelte",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Svelte Flow - A highly customizable Svelte library for building node-based editors, workflow systems, diagrams and more.",
   "keywords": [
     "svelte",

packages/svelte/src/lib/components/EdgeReconnectAnchor/EdgeReconnectAnchor.svelte

@@ -79,9 +79,9 @@
       flowId,
       cancelConnection,
       panBy,
-      isValidConnection,
+      isValidConnection: (...args) => store.isValidConnection?.(...args) ?? true,
       onConnectStart: _onConnectStart,
-      onConnectEnd: onconnectend,
+      onConnectEnd: (...args) => store.onconnectend?.(...args),
       onConnect: (connection) => {
         const reconnectedEdge = { ...edge, ...connection };
         const newEdge = onbeforereconnect

packages/svelte/src/lib/components/Handle/Handle.svelte

@@ -125,21 +125,14 @@
         autoPanOnConnect: store.autoPanOnConnect,
         autoPanSpeed: store.autoPanSpeed,
         flowId: store.flowId,
-        isValidConnection: isValidConnection ?? store.isValidConnection,
+        isValidConnection:
+          isValidConnection || ((...args) => store.isValidConnection?.(...args) ?? true),
         updateConnection: store.updateConnection,
         cancelConnection: store.cancelConnection,
         panBy: store.panBy,
         onConnect: onConnectExtended,
-        onConnectStart: (event, startParams) => {
-          store.onconnectstart?.(event, {
-            nodeId: startParams.nodeId,
-            handleId: startParams.handleId,
-            handleType: startParams.handleType
-          });
-        },
-        onConnectEnd: (event, connectionState) => {
-          store.onconnectend?.(event, connectionState);
-        },
+        onConnectStart: store.onconnectstart,
+        onConnectEnd: (...args) => store.onconnectend?.(...args),
         getTransform: () => [store.viewport.x, store.viewport.y, store.viewport.zoom],
         getFromHandle: () => store.connection.fromHandle,
         dragThreshold: store.connectionDragThreshold,

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

@@ -1,4 +1,4 @@
-import { shallowNodeData } from '@xyflow/system';
+import { shallowNodeData, type DistributivePick } from '@xyflow/system';
 
 import type { Node } from '$lib/types';
 import { useStore } from '$lib/store';
@@ -12,10 +12,10 @@ import { useStore } from '$lib/store';
  */
 export function useNodesData<NodeType extends Node = Node>(
   nodeId: string
-): { current: Pick<NodeType, 'id' | 'data' | 'type'> | null };
+): { current: DistributivePick<NodeType, 'id' | 'data' | 'type'> | null };
 export function useNodesData<NodeType extends Node = Node>(
   nodeIds: string[]
-): { current: Pick<NodeType, 'id' | 'data' | 'type'>[] };
+): { current: DistributivePick<NodeType, 'id' | 'data' | 'type'>[] };
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function useNodesData(nodeIds: any): any {
   const { nodes, nodeLookup } = $derived(useStore());

packages/svelte/src/lib/plugins/Minimap/Minimap.svelte

@@ -6,12 +6,7 @@
 </script>
 
 <script lang="ts">
-  import {
-    getBoundsOfRects,
-    getInternalNodesBounds,
-    getNodeDimensions,
-    nodeHasDimensions
-  } from '@xyflow/system';
+  import { getBoundsOfRects, getInternalNodesBounds, nodeHasDimensions } from '@xyflow/system';
 
   import { useStore } from '$lib/store';
   import { Panel } from '$lib/container/Panel';
@@ -45,9 +40,6 @@
   let store = $derived(useStore());
   let ariaLabelConfig = $derived(store.ariaLabelConfig);
 
-  const nodeColorFunc = nodeColor === undefined ? undefined : getAttrFunction(nodeColor);
-  const nodeStrokeColorFunc = getAttrFunction(nodeStrokeColor);
-  const nodeClassFunc = getAttrFunction(nodeClass);
   const shapeRendering =
     // @ts-expect-error - TS doesn't know about chrome
     typeof window === 'undefined' || !!window.chrome ? 'crispEdges' : 'geometricPrecision';
@@ -119,20 +111,16 @@
       {#each store.nodes as userNode (userNode.id)}
         {@const node = store.nodeLookup.get(userNode.id)}
         {#if node && nodeHasDimensions(node) && !node.hidden}
-          {@const nodeDimesions = getNodeDimensions(node)}
           <MinimapNode
             id={node.id}
-            x={node.internals.positionAbsolute.x}
-            y={node.internals.positionAbsolute.y}
-            {...nodeDimesions}
             selected={node.selected}
             {nodeComponent}
-            color={nodeColorFunc?.(node)}
+            color={nodeColor === undefined ? undefined : getAttrFunction(nodeColor)(userNode)}
             borderRadius={nodeBorderRadius}
-            strokeColor={nodeStrokeColorFunc(node)}
+            strokeColor={getAttrFunction(nodeStrokeColor)(userNode)}
             strokeWidth={nodeStrokeWidth}
             {shapeRendering}
-            class={nodeClassFunc(node)}
+            class={getAttrFunction(nodeClass)(userNode)}
           />
         {/if}
       {/each}

packages/svelte/src/lib/plugins/Minimap/MinimapNode.svelte

@@ -1,14 +1,15 @@
 <script lang="ts">
-  import type { ClassValue } from 'svelte/elements';
   import type { Component } from 'svelte';
   import type { MiniMapNodeProps } from './types';
+  import { useInternalNode } from '$lib/hooks/useInternalNode.svelte';
+  import { getNodeDimensions } from '@xyflow/system';
 
   let {
     id,
-    x,
-    y,
-    width,
-    height,
+    x: xProp,
+    y: yProp,
+    width: widthProp,
+    height: heightProp,
     borderRadius = 5,
     color,
     shapeRendering,
@@ -17,21 +18,26 @@
     selected,
     class: className,
     nodeComponent
-  }: {
-    id: string;
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    borderRadius?: number;
-    color?: string;
-    shapeRendering: string;
-    strokeColor?: string;
-    strokeWidth?: number;
-    selected?: boolean;
-    class?: ClassValue;
+  }: MiniMapNodeProps & {
     nodeComponent?: Component<MiniMapNodeProps>;
   } = $props();
+
+  let internalNode = $derived(useInternalNode(id));
+
+  let { width, height, x, y } = $derived.by(() => {
+    if (!internalNode.current) {
+      return { width: 0, height: 0, x: 0, y: 0 };
+    }
+
+    const { width, height } = getNodeDimensions(internalNode.current);
+
+    return {
+      width: widthProp ?? width,
+      height: heightProp ?? height,
+      x: xProp ?? internalNode.current.internals.positionAbsolute.x,
+      y: yProp ?? internalNode.current.internals.positionAbsolute.y
+    };
+  });
 </script>
 
 {#if nodeComponent}

packages/svelte/src/lib/plugins/Minimap/types.ts

@@ -12,10 +12,10 @@ export type GetMiniMapNodeAttribute = (node: Node) => string;
  */
 export type MiniMapNodeProps = {
   id: string;
-  x: number;
-  y: number;
-  width: number;
-  height: number;
+  x?: number;
+  y?: number;
+  width?: number;
+  height?: number;
   borderRadius?: number;
   class?: ClassValue;
   color?: string;

packages/system/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @xyflow/system
 
+## 0.0.75
+
+### Patch Changes
+
+- [#5703](https://github.com/xyflow/xyflow/pull/5703) [`ce6c869df`](https://github.com/xyflow/xyflow/commit/ce6c869df40b2b013484808c742ca508da4a591f) Thanks [@peterkogo](https://github.com/peterkogo)! - Improve return type of useNodesData. Now you can narrow down the data type by checking the node type.
+
 ## 0.0.74
 
 ### Patch Changes

packages/system/package.json

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

packages/system/src/types/utils.ts

@@ -56,3 +56,10 @@ export type Transform = [number, number, number];
  * to represent an unbounded extent.
  */
 export type CoordinateExtent = [[number, number], [number, number]];
+
+/**
+ * Using Pick with a union type (e.g. `NodeType`) will merge every property type along all union members.
+ * See https://github.com/microsoft/TypeScript/issues/28339#issuecomment-463577347
+ * Note: Currently you are able to Pick properties that are not in the type without error.
+ */
+export type DistributivePick<T, K extends string> = T extends unknown ? { [P in Extract<keyof T, K>]: T[P] } : never;