Reconnect Edge
An edge is reconnectable by dragging it to another handle if you are using the
onReconnect
handler prop. The handler gets
called after the edge gets dropped to a new handle. You can use the
reconnectEdge
helper function to update your
edges state accordingly.
import React, { useCallback } from 'react';
import {
ReactFlow,
Background,
useNodesState,
useEdgesState,
Controls,
reconnectEdge,
addEdge,
} from '@xyflow/react';
import '@xyflow/react/dist/style.css';
const initialNodes = [
{
id: '1',
type: 'input',
data: {
label: (
<>
Node <strong>A</strong>
</>
),
},
position: { x: 250, y: 0 },
},
{
id: '2',
data: {
label: (
<>
Node <strong>B</strong>
</>
),
},
position: { x: 75, y: 0 },
},
{
id: '3',
data: {
label: (
<>
Node <strong>C</strong>
</>
),
},
position: { x: 400, y: 100 },
style: {
background: '#D6D5E6',
color: '#333',
width: 180,
},
},
{
id: '4',
data: {
label: (
<>
Node <strong>D</strong>
</>
),
},
position: { x: -75, y: 100 },
},
{
id: '5',
data: {
label: (
<>
Node <strong>E</strong>
</>
),
},
position: { x: 150, y: 100 },
},
{
id: '6',
data: {
label: (
<>
Node <strong>F</strong>
</>
),
},
position: { x: 150, y: 250 },
},
];
const initialEdges = [
{
id: 'e1-3',
source: '1',
target: '3',
label: 'This edge can only be updated from source',
reconnectable: 'source',
},
{
id: 'e2-4',
source: '2',
target: '4',
label: 'This edge can only be updated from target',
reconnectable: 'target',
},
{
id: 'e5-6',
source: '5',
target: '6',
label: 'This edge can be updated from both sides',
},
];
const EdgeReconnect = () => {
const [nodes, setNodes, onNodesChange] = useNodesState(initialNodes);
const [edges, setEdges, onEdgesChange] = useEdgesState(initialEdges);
// gets called after end of edge gets dragged to another source or target
const onReconnect = useCallback(
(oldEdge, newConnection) =>
setEdges((els) => reconnectEdge(oldEdge, newConnection, els)),
[],
);
const onConnect = useCallback(
(params) => setEdges((els) => addEdge(params, els)),
[],
);
return (
<ReactFlow
nodes={nodes}
edges={edges}
onNodesChange={onNodesChange}
onEdgesChange={onEdgesChange}
snapToGrid
onReconnect={onReconnect}
onConnect={onConnect}
fitView
attributionPosition="top-right"
style={{ backgroundColor: "#F7F9FB" }}
>
<Controls />
<Background />
</ReactFlow>
);
};
export default EdgeReconnect;
A couple of properties interact with one another to determine whether an edge is updatable or not:
-
By default the
edgesReconnectable
is set totrue
. -
For edges to actually be draggable, though, it is also necessary to define a
onReconnect
handler. -
Individual edges can refine or override the
edgesReconnectable
prop by setting theirupdatable
property.-
true
means the edge is updatable even ifedgesReconnectable
-
"source"
or"target"
means the edge is updatable only from the source or target handle regardless of theedgesReconnectable
prop. -
false
means the edge is not updatable even ifedgesReconnectable
is set totrue
.
-