FlowProps
All available configuration options for Vue Flow.Core Properties
Unique identifier for the flow instance
Array of nodes in the flow
Array of edges in the flow
All elements (nodes + edges)
Node & Edge Types
Custom node type components. Alternative to using slots
Custom edge type components. Alternative to using slots
Connection Settings
Connection mode:
'strict' or 'loose'. Default: 'strict'Options for the connection line appearance and behavior
Radius around handles where connections can be made
Function to validate connections before they are created
Automatically create edges when connections are made
Allow connections with click handlers (useful for touch devices)
Interaction Settings
Enable/disable dragging for all nodes. Default:
trueEnable/disable connecting for all nodes. Default:
trueEnable/disable selecting elements. Default:
trueSelect nodes when dragging. Default:
trueEnable/disable updating edges. Can be
boolean, 'source', or 'target'Distance in pixels before drag is triggered. Default:
0Keyboard Settings
Key(s) to delete selected elements. Default:
'Backspace'Key(s) to enable selection mode. Default:
'Shift'Key(s) to enable multi-selection. Default:
'Meta' (Cmd/Ctrl)Key(s) to enable zoom. Default:
'Meta'Key(s) to enable panning. Default:
'Space'Disable keyboard accessibility features
Viewport & Zoom
Initial viewport position and zoom level
Minimum zoom level. Default:
0.5Maximum zoom level. Default:
2Enable zoom on scroll. Default:
trueEnable zoom on pinch (touch). Default:
trueEnable zoom on double click. Default:
trueEnable panning on scroll. Default:
falseSpeed of panning when scrolling. Default:
0.5Pan direction:
'free', 'vertical', or 'horizontal'. Default: 'free'Enable panning by dragging. Can be boolean or array of mouse buttons. Default:
truePrevent page scrolling inside viewport. Default:
trueDistance that mouse can move between mousedown/up to trigger click. Default:
0Extent & Boundaries
Limits for panning the viewport
Default extent for all nodes
Grid & Snapping
Enable snapping nodes to grid. Default:
falseGrid size as
[x, y]. Default: [15, 15]Selection
Selection mode:
'partial' or 'full'. Default: 'full'Performance
Only render elements visible in viewport. Default:
falseAuto Pan
Auto pan when connecting near viewport edges. Default:
trueAuto pan when dragging nodes near viewport edges. Default:
trueSpeed of auto panning. Default:
15Initial Behavior
Fit view to nodes on initialization. Default:
falseEdge Settings
Default options applied to new edges
Radius of edge updater handles. Default:
10Default color for edge markers. Default:
'#b1b1b7'Elevate edges when selected using z-index. Default:
falseFocus
Enable focus for nodes (a11y). Default:
trueEnable focus for edges (a11y). Default:
trueElevate nodes when selected using z-index + 1000. Default:
falseClass Names
Class name to disable dragging. Default:
'nodrag'Class name to disable wheel events. Default:
'nowheel'Class name to disable panning. Default:
'nopan'Changes
Apply default change handlers automatically. Default:
trueViewportTransform
Represents the viewport transformation state.X translation of viewport
Y translation of viewport
Zoom level of viewport
FlowExportObject
Object structure for exporting flow state.Exported nodes
Exported edges
Exported viewport (position + zoom)
Exported viewport position
Exported zoom level
Example
FlowImportObject
Partial flow state for importing.SelectionMode
Enum for selection behavior.- Partial: Elements are selected if they partially overlap the selection box
- Full: Elements are selected only if fully contained in the selection box
Position
Enum for handle positions.XYPosition
2D coordinate position.Dimensions
Size dimensions.Rect
Rectangle with position and dimensions.XYPosition and Dimensions.
Box
Bounding box coordinates.Left coordinate
Top coordinate
Right coordinate
Bottom coordinate
SnapGrid
Grid size for snapping.Example
Styles
Extended CSS properties with theme vars.ThemeVars
Built-in CSS custom properties:--vf-node-color--vf-box-shadow--vf-node-bg--vf-node-text--vf-connection-path--vf-handle