Merge pull request #5013 from xyflow/fix-connection-component-type

Fix connection component type

.changeset/happy-hats-lay.md

@@ -0,0 +1,5 @@
+---
+'@xyflow/react': patch
+---
+
+Pass `NodeType` type argument from `ReactFlowProps` to `connectionLineComponent` property.

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

@@ -11,12 +11,12 @@ import {
 
 import { useStore } from '../../hooks/useStore';
 import { getSimpleBezierPath } from '../Edges/SimpleBezierEdge';
-import type { ConnectionLineComponent, ReactFlowState } from '../../types';
+import type { ConnectionLineComponent, Node, ReactFlowState } from '../../types';
 import { useConnection } from '../../hooks/useConnection';
 
-type ConnectionLineWrapperProps = {
+type ConnectionLineWrapperProps<NodeType extends Node = Node> = {
   type: ConnectionLineType;
-  component?: ConnectionLineComponent;
+  component?: ConnectionLineComponent<NodeType>;
   containerStyle?: CSSProperties;
   style?: CSSProperties;
 };
@@ -29,7 +29,12 @@ const selector = (s: ReactFlowState) => ({
   height: s.height,
 });
 
-export function ConnectionLineWrapper({ containerStyle, style, type, component }: ConnectionLineWrapperProps) {
+export function ConnectionLineWrapper<NodeType extends Node = Node>({
+  containerStyle,
+  style,
+  type,
+  component,
+}: ConnectionLineWrapperProps<NodeType>) {
   const { nodesConnectable, width, height, isValid, inProgress } = useStore(selector, shallow);
   const renderConnection = !!(width && nodesConnectable && inProgress);
 
@@ -45,21 +50,27 @@ export function ConnectionLineWrapper({ containerStyle, style, type, component }
       className="react-flow__connectionline react-flow__container"
     >
       <g className={cc(['react-flow__connection', getConnectionStatus(isValid)])}>
-        <ConnectionLine style={style} type={type} CustomComponent={component} isValid={isValid} />
+        <ConnectionLine<NodeType> style={style} type={type} CustomComponent={component} isValid={isValid} />
       </g>
     </svg>
   );
 }
 
-type ConnectionLineProps = {
+type ConnectionLineProps<NodeType extends Node = Node> = {
   type: ConnectionLineType;
   style?: CSSProperties;
-  CustomComponent?: ConnectionLineComponent;
+  CustomComponent?: ConnectionLineComponent<NodeType>;
   isValid: boolean | null;
 };
 
-const ConnectionLine = ({ style, type = ConnectionLineType.Bezier, CustomComponent, isValid }: ConnectionLineProps) => {
-  const { inProgress, from, fromNode, fromHandle, fromPosition, to, toNode, toHandle, toPosition } = useConnection();
+const ConnectionLine = <NodeType extends Node = Node>({
+  style,
+  type = ConnectionLineType.Bezier,
+  CustomComponent,
+  isValid,
+}: ConnectionLineProps<NodeType>) => {
+  const { inProgress, from, fromNode, fromHandle, fromPosition, to, toNode, toHandle, toPosition } =
+    useConnection<NodeType>();
 
   if (!inProgress) {
     return;

packages/react/src/container/GraphView/index.tsx

@@ -170,7 +170,7 @@ function GraphViewComponent<NodeType extends Node = Node, EdgeType extends Edge
           disableKeyboardA11y={disableKeyboardA11y}
           rfId={rfId}
         />
-        <ConnectionLineWrapper
+        <ConnectionLineWrapper<NodeType>
           style={connectionLineStyle}
           type={connectionLineType}
           component={connectionLineComponent}

packages/react/src/types/component-props.ts

@@ -259,7 +259,7 @@ export interface ReactFlowProps<NodeType extends Node = Node, EdgeType extends E
   /** Styles to be applied to the connection line */
   connectionLineStyle?: CSSProperties;
   /** React Component to be used as a connection line */
-  connectionLineComponent?: ConnectionLineComponent;
+  connectionLineComponent?: ConnectionLineComponent<NodeType>;
   /** Styles to be applied to the container of the connection line */
   connectionLineContainerStyle?: CSSProperties;
   /** 'strict' connection mode will only allow you to connect source handles to target handles.