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

ReactFlowStoreApi

Source on GitHub 

The ReactFlowStoreApi is returned by the useReactFlowStoreApi() hook. It holds the Zustand store API (getState, setState, subscribe) of each individual store, so you can read state on demand without subscribing your component to changes.

export type ReactFlowStoreApi<NodeType extends Node = Node, EdgeType extends Edge = Edge> = { optionsStore: StoreApi<ReactFlowState<NodeType, EdgeType>>; viewportStore: StoreApi<ViewportStore>; connectionStore: StoreApi<ConnectionStore<NodeType>>; nodesStore: StoreApi<NodesStore<NodeType>>; edgesStore: StoreApi<EdgesStore<EdgeType>>; selectionStore: StoreApi<SelectionStore>; };
StoreState typeHook
nodesStoreNodesStoreuseNodesStore
edgesStoreEdgesStoreuseEdgesStore
viewportStoreViewportStoreuseViewportStore
optionsStoreReactFlowStateuseOptionsStore
connectionStoreConnectionStoreuseConnectionStore
selectionStoreSelectionStoreuseSelectionStore
import { useReactFlowStoreApi } from '@xyflow/react'; const store = useReactFlowStoreApi(); // read the current state without re-rendering on changes const { nodeLookup } = store.nodesStore.getState();