Skip to Content
React Flow 13 is here! Read the announcement →
ReferenceTypes

ReactFlowState

Source on GitHub 

The general state and configuration of a React Flow instance returned by the useOptionsStore() hook. This store is useful for accessing many of the options set on the <ReactFlow /> component.

NameTypeDefault
pubSubPubSub
rfIdstring
onNodesChangeOnNodesChange<NodeType> | null
onEdgesChangeOnEdgesChange<EdgeType> | null
hasDefaultNodesboolean
hasDefaultEdgesboolean
domNodeHTMLDivElement | null
noPanClassNamestring
panZoomPanZoomInstance | null
minZoomnumber
maxZoomnumber
translateExtentCoordinateExtent
nodeExtentCoordinateExtent
nodeOriginNodeOrigin
nodeDragThresholdnumber
connectionDragThresholdnumber
nodesSelectionActiveboolean
userSelectionActiveboolean
connectionModeConnectionMode
snapToGridboolean
snapGridSnapGrid
nodesDraggableboolean
autoPanOnNodeFocusboolean
nodesConnectableboolean
nodesFocusableboolean
edgesFocusableboolean
edgesReconnectableboolean
elementsSelectableboolean
elevateNodesOnSelectboolean
elevateEdgesOnSelectboolean
selectNodesOnDragboolean
multiSelectionActiveboolean
onNodeDragStartOnNodeDrag<NodeType> | undefined
onNodeDragOnNodeDrag<NodeType> | undefined
onNodeDragStopOnNodeDrag<NodeType> | undefined
onSelectionDragStartOnSelectionDrag | undefined
onSelectionDragOnSelectionDrag | undefined
onSelectionDragStopOnSelectionDrag | undefined
onMoveStartOnMove | undefined
onMoveOnMove | undefined
onMoveEndOnMove | undefined
onConnectOnConnect | undefined
onConnectStartOnConnectStart | undefined
onConnectEndOnConnectEnd | undefined
onClickConnectStartOnConnectStart | undefined
onClickConnectEndOnConnectEnd | undefined
connectOnClickboolean
defaultEdgeOptionsDefaultEdgeOptions | undefined
fitViewQueuedboolean
fitViewOptionsFitViewOptions<Node<Record<string, unknown>, string | undefined>> | undefined
fitViewResolver{ promise: Promise<boolean>; resolve: (value: boolean | PromiseLike<boolean>) => void; reject: (reason?: unknown) => void; } | null
onNodesDeleteOnNodesDelete<NodeType> | undefined
onEdgesDeleteOnEdgesDelete<EdgeType> | undefined
onDeleteOnDelete<Node<Record<string, unknown>, string | undefined>, Edge<Record<string, unknown>, string | undefined>> | undefined
onErrorOnError | undefined
onViewportChangeStartOnViewportChange | undefined
onViewportChangeOnViewportChange | undefined
onViewportChangeEndOnViewportChange | undefined
onBeforeDeleteOnBeforeDelete<NodeType, EdgeType> | undefined
onSelectionChangeHandlersOnSelectionChangeFunc<NodeType, EdgeType>[]
ariaLiveMessagestring
autoPanOnConnectboolean
autoPanOnNodeDragboolean
autoPanSpeednumber
connectionRadiusnumber
isValidConnectionIsValidConnection<EdgeType> | undefined
debugboolean
ariaLabelConfig{ 'node.a11yDescription.default': string; 'node.a11yDescription.keyboardDisabled': string; 'node.a11yDescription.ariaLiveMessage': ({ direction, x, y }: { direction: string; x: number; y: number; }) => string; ... 7 more ...; 'handle.ariaLabel': string; }
zIndexModeZIndexMode
onNodesChangeMiddlewareMapMap<symbol, (changes: NodeChange<NodeType>[]) => NodeChange<NodeType>[]>
onEdgesChangeMiddlewareMapMap<symbol, (changes: EdgeChange<EdgeType>[]) => EdgeChange<EdgeType>[]>
setNodes(nodes: NodeType[]) => void
setEdges(edges: EdgeType[]) => void
setDefaultNodesAndEdges(nodes?: NodeType[] | undefined, edges?: EdgeType[] | undefined) => void
updateNodeInternals(updates: Map<string, InternalNodeUpdate>, params?: { triggerFitView: boolean; } | undefined) => void
updateNodePositionsUpdateNodePositions
resetSelectedElements() => void
unselectNodesAndEdges(params?: UnselectNodesAndEdgesParams<NodeType, EdgeType> | undefined) => void
addSelectedNodes(nodeIds: string[]) => void
addSelectedEdges(edgeIds: string[]) => void
setMinZoom(minZoom: number) => void
setMaxZoom(maxZoom: number) => void
setTranslateExtent(translateExtent: CoordinateExtent) => void
setNodeExtent(nodeExtent: CoordinateExtent) => void
cancelConnection() => void
updateConnectionUpdateConnection<InternalNode<NodeType>>
updateConnectionClickStart(connectionClickStartHandle: (Pick<HandleBounds, "nodeId" | "id"> & Required<Pick<HandleBounds, "type">>) | null) => void
reset() => void
emitNodeChanges(changes: NodeChange<NodeType>[]) => void
emitEdgeChanges(changes: EdgeChange<EdgeType>[]) => void
panByPanBy
setCenter(x: number, y: number, options?: ViewportHelperFunctionOptions & { zoom?: number; }) => Promise<boolean>