Skip to main content

useReactFlow

The useReactFlow hook returns the React Flow instance to manipulate nodes, edges and the viewport and get informations about the current state. You can find the list of functions on the React Flow instance page.

caution

This hook can only be used if the component that uses it, is wrapped with a ReactFlowProvider or if it's a child of the <ReactFlow /> component.

Usage​

import ReactFlow, { useReactFlow } from 'react-flow-renderer';

function Flow() {
const reactFlowInstance = useReactFlow();

useEffect(() => {
console.log(reactFlowInstance);
}, []);

return <ReactFlow defaultNodes={[]} />;
}

You can find an example of how to use it here: useReactFlow example