Skip to Content
📣 We just released Svelte Flow 1.0 Alpha — try it out and give us your feedback!

addEdge()

Source on GitHub 

This util is a convenience function to add a new Edge to an array of edges. It also performs some validation to make sure you don’t add an invalid edge or duplicate an existing one.

import { addEdge } from '@xyflow/svelte'; let edges = $state.raw([]); const onAddEdge = () => { const newEdge = { id: '1-2', source: '1', target: '2', }; edges = addEdge(newEdge, edges.current); };

Signature

Parameters:
NameTypeDefault
edgeParamsEdgeType | Connection

Either an Edge or a Connection you want to add.

edgesEdgeType[]

The array of all current edges.

Returns:
EdgeType[]

A new array of edges with the new edge added.

Notes

  • If an edge with the same target and source already exists (and the same targetHandle and sourceHandle if those are set), then this util won’t add a new edge even if the id property is different.
Last updated on