ReactFlowStoreApi
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>;
};| Store | State type | Hook |
|---|---|---|
nodesStore | NodesStore | useNodesStore |
edgesStore | EdgesStore | useEdgesStore |
viewportStore | ViewportStore | useViewportStore |
optionsStore | ReactFlowState | useOptionsStore |
connectionStore | ConnectionStore | useConnectionStore |
selectionStore | SelectionStore | useSelectionStore |
import { useReactFlowStoreApi } from '@xyflow/react';
const store = useReactFlowStoreApi();
// read the current state without re-rendering on changes
const { nodeLookup } = store.nodesStore.getState();