Connection Basics

Connections are edges created interactively by the user. WireFlow supports drag-to-connect, click-to-connect, and reconnection out of the box.

Drag to connect

The default connection method. Drag from a source handle to a target handle to create an edge.

1. Pointer down on a source handle starts the connection.
2. A temporary dashed line follows the cursor.
3. Valid target handles highlight as the cursor approaches (within connectionSnapRadius).
4. Release on a valid target handle to create the edge.
5. Release on empty space to cancel.

Auto-pan activates when dragging near the canvas edge.

<x-flow :nodes="$nodes" :edges="$edges">
    <x-slot:node>
        <x-flow-handle type="target" position="top" />
        <span x-text="node.data.label"></span>
        <x-flow-handle type="source" position="bottom" />
    </x-slot:node>
</x-flow>

<div x-data="flowCanvas({
    nodes: [
        { id: 'a', position: { x: 0, y: 0 }, data: { label: 'Source' } },
        { id: 'b', position: { x: 250, y: 100 }, data: { label: 'Target A' } },
        { id: 'c', position: { x: 500, y: 0 }, data: { label: 'Target B' } },
    ],
    edges: [],
    background: 'dots',
    fitViewOnInit: true,
    controls: false,
    pannable: false,
    zoomable: false,
})" class="flow-container" style="height: 250px;">
    <div x-flow-viewport>
        <template x-for="node in nodes" :key="node.id">
            <div x-flow-node="node">
                <div x-flow-handle:target></div>
                <span x-text="node.data.label"></span>
                <div x-flow-handle:source></div>
            </div>
        </template>
    </div>
</div>

Click to connect

Create edges by clicking handles instead of dragging. Enabled by default.

1. Click a source handle to select it (receives .flow-handle-active CSS class).
2. Valid target handles highlight with .flow-handle-valid.
3. Click a valid target handle to complete the connection.
4. Click empty space or press Escape to cancel.

Disable click-to-connect via the :config prop:

<x-flow :nodes="$nodes" :edges="$edges" :config="[
    'connectOnClick' => false,
]">
    <x-slot:node>
        <x-flow-handle type="target" position="top" />
        <span x-text="node.data.label"></span>
        <x-flow-handle type="source" position="bottom" />
    </x-slot:node>
</x-flow>

Connection line

Customize the temporary line shown during a connection drag via :config:

<x-flow :nodes="$nodes" :edges="$edges" :config="[
    'connectionLineType' => 'bezier',
    'connectionLineStyle' => [
        'stroke' => '#6366f1',
        'strokeWidth' => 2,
        'strokeDasharray' => '6 3',
    ],
]">
    <x-slot:node>
        <x-flow-handle type="target" position="top" />
        <span x-text="node.data.label"></span>
        <x-flow-handle type="source" position="bottom" />
    </x-slot:node>
</x-flow>

Reconnection

Drag existing edge endpoints to reconnect them to different handles. Enabled by default via the edges-reconnectable prop.

<x-flow :nodes="$nodes" :edges="$edges" :edges-reconnectable="true">
    <x-slot:node>
        <x-flow-handle type="target" position="top" />
        <span x-text="node.data.label"></span>
        <x-flow-handle type="source" position="bottom" />
    </x-slot:node>
</x-flow>

Disable reconnection:

<x-flow :nodes="$nodes" :edges="$edges" :edges-reconnectable="false">

Per-edge control

Each edge has a reconnectable property you can set in your PHP array:

public array $edges = [
    [
        'id' => 'e1-2',
        'source' => '1',
        'target' => '2',
        'reconnectable' => 'source', // Only source end can be reconnected
    ],
];

Connection snap radius

Control how close the cursor must be to a handle before it snaps:

<x-flow :nodes="$nodes" :edges="$edges" :config="[
    'connectionSnapRadius' => 30,
]">

The default is 20 pixels.

Connection mode

The connectionMode config controls handle matching:

<x-flow :nodes="$nodes" :edges="$edges" :config="[
    'connectionMode' => 'loose',
]">

See also

• Advanced Connections -- multi-connect, easy-connect, and proximity connect
• Connection Events -- handle connection events on the server
• Components -- <x-flow> props and handle configuration