reactflow

library11.11.4jsnpmunverified

React Flow is a highly customizable React library for building interactive graphs, node-based editors, and complex flow charts. The package `reactflow` is currently at version 11.11.4, which represents the actively maintained v11 stable release line. The project maintains a consistent release cadence with frequent patch updates and less frequent minor/major releases. Key differentiators include its intuitive API for seamless zooming and panning, extensive customization options for both nodes and edges, performant rendering achieved by only re-rendering changed elements, and a rich set of hooks and utility functions for graph manipulation. It also provides essential plugin components like MiniMap, Controls, and Background out-of-the-box. The library is built with TypeScript and tested with Cypress, ensuring reliability and a robust developer experience. Users should note that the upcoming v12 release will transition to a new package name, `@xyflow/react`.

web-framework

github ↗package ↗homepage ↗

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ReactFlow is the default export of the library, not a named export. Ensure you are importing the default component for the main canvas.

import ReactFlow from 'reactflow';

Hooks like useNodesState, useEdgesState, and utilities like addEdge are named exports.

import { useNodesState } from 'reactflow';

Helper components such as MiniMap, Controls, and Background are named exports.

import { MiniMap, Controls, Background } from 'reactflow';

The core stylesheet is crucial for proper rendering and requires a direct import path to the `dist` folder.

import 'reactflow/dist/style.css';

This quickstart demonstrates a basic React Flow setup with initial nodes and edges, enabling drag, zoom, pan, and interactive connecting. It includes `MiniMap`, `Controls`, and `Background` components for enhanced user experience.

import { useCallback } from 'react'; import ReactFlow, { MiniMap, Controls, Background, useNodesState, useEdgesState, addEdge, } from 'reactflow'; import 'reactflow/dist/style.css'; const initialNodes = [ { id: '1', position: { x: 0, y: 0 }, data: { label: 'Node 1' } }, { id: '2', position: { x: 250, y: 150 }, data: { label: 'Node 2' } }, { id: '3', position: { x: 100, y: 250 }, data: { label: 'Node 3' } }, ]; const initialEdges = [ { id: 'e1-2', source: '1', target: '2', label: 'to the next' }, { id: 'e2-3', source: '2', target: '3', animated: true }, ]; function Flow() { const [nodes, setNodes, onNodesChange] = useNodesState(initialNodes); const [edges, setEdges, onEdgesChange] = useEdgesState(initialEdges); const onConnect = useCallback((params) => setEdges((eds) => addEdge(params, eds)), [setEdges]); return ( <div style={{ width: '100vw', height: '100vh' }}> <ReactFlow nodes={nodes} edges={edges} onNodesChange={onNodesChange} onEdgesChange={onEdgesChange} onConnect={onConnect} fitView > <MiniMap /> <Controls /> <Background variant="dots" gap={12} size={1} /> </ReactFlow> </div> ); } export default Flow;

Debug

Known footguns

breakingThe `reactflow` package (v11) is being succeeded by `@xyflow/react` (v12). This transition involves a package name change and significant API updates. Users of `reactflow` should plan for a migration when moving to v12.

gotchaForgetting to import the `reactflow/dist/style.css` stylesheet will result in an unstyled and potentially non-functional React Flow canvas, as essential layout and component styles are missing.

gotchaReact Flow requires `react` and `react-dom` as peer dependencies with versions `>=17`. Using older versions of React may lead to compatibility issues or errors.

gotchaWhen implementing custom nodes or edges, they must be explicitly registered with the `nodeTypes` and `edgeTypes` props on the `ReactFlow` component. Failing to do so will prevent your custom elements from rendering.

Upgrade

Version history

Breaking-change detection hasn't run for this library yet.

Audit

Security & dependencies

CVE tracking and dependency tree are planned for a later release.

Agent activity

0 hits · last 30 days

No traffic data recorded yet.

Resources

githubhttps://github.com/xyflow/xyflow ↗

packagehttps://www.npmjs.com/package/reactflow ↗

homepagehttps://reactflow.dev ↗