useNodeConnections()

This hook returns an array of connections on a specific node, handle type (‘source’, ‘target’) or handle ID.


import { useNodeConnections } from '@xyflow/react';
 
export default function () {
  const connections = useNodeConnections({
    handleType: 'target',
    handleId: 'my-handle',
  });
 
  return (
    <div>There are currently {connections.length} incoming connections!</div>
  );
}

Signature

Name	Type
#Params
#`id?`	`string` ID of the node, filled in automatically if used inside custom node
#`handleType?`	`"source" \| "target"` What type of handle connections do you want to observer?
#`handleId?`	`string` ID of the handle
#`onConnect?`	`(connections: Connection[]) => void`
#`onDisconnect?`	`(connections: Connection[]) => void`
#Returns
#	`NodeConnection[]`