Configuration

All options are passed to flowCanvas(). Every option has a sensible default — most flows only need nodes and edges.

<div x-data="flowCanvas({
    nodes: [...],
    edges: [...],
    background: 'dots',
    controls: true,
})">

Sections

Section Description
Canvas Background, zoom limits, color mode, debug
Nodes Node options, data shape, type registry
Edges Edge options, data shape, type registry
Connections Drag-connect, click-to-connect, validation, multi/easy/proximity connect
Viewport Pan, zoom, culling, auto-pan
Interaction Selection, touch, keyboard shortcuts, accessibility
Features History, loading, drop zone, shapes, child validation, compute, auto-layout
Events Event callbacks, error handling, Livewire bridge

Data

Option Type Default Description
nodes FlowNode[] [] Initial nodes. See Node data shape.
edges FlowEdge[] [] Initial edges. See Edge data shape.
viewport Partial<Viewport> { x: 0, y: 0, zoom: 1 } Initial viewport position and zoom.