These pages describe the current main. What is newer than the latest release on npm is listed under
Unreleased in the changelog.
|
|
| Getting started |
Install, a first diagram, making it interactive, and the first things that trip people |
| Examples |
Two complete Vite apps: a layout viewer and a controlled editor |
|
|
| An org chart |
A tree of people with collapsible branches, laid out by d3-hierarchy |
| Lay out a DAG with dagre |
Positions from dagre, ELK or d3-hierarchy, and which to pick |
| A flowchart editor with undo and redo |
Drag, connect, delete, shapes, copy and paste, snap guides — and undo |
| Export to PNG, JPEG or SVG |
The whole diagram as an image: resolution, background, a social card, the clipboard |
| Save and load as JSON |
toObject() to storage or a file and back, with a check for files you did not write |
| A workflow builder in Next.js |
Laid out in a Server Component, hydrated into an editor, nothing jumps |
|
|
| API reference |
Canvas props, nodes and edges, handles, sub-flows, the instance, controlled flows |
| Components and hooks |
Handle, Background, Controls, MiniMap, NodeToolbar, NodeResizer, useReactFlow… |
| Features |
The small core and its opt-in features: what each adds, what needs it, writing your own |
| The “pro” modules |
Undo/redo, copy and paste, snap guides, export, smart edges, flowchart shapes, a collapsible tree — free, separate entry points |
| Theming |
The --flowinger-* CSS variables |
| Server rendering |
What renders on the server and what waits for the client |
| What 1.0 promises |
What semantic versioning covers from 1.0, and what it does not |
| Upgrading to 1.0 |
<ReactFlow> takes React Flow’s defaults, and the other changes — and how to be ready on 0.9 |
|
|
| Migrating from React Flow |
A checklist: the defaults that differ, types, what is missing and what to do instead |
| React Flow coverage |
How much of its API this covers, measured from its own type declarations |
| Benchmarks |
Mount, pan, zoom and drag against React Flow at 1,000–10,000 nodes, culled and not — and how to re-run them |
|
|
| Roadmap |
Where it is going, and where help is most useful |
| Changelog |
What changed in each release |
| Contributing |
What fits, what “done” means here, how to run everything |
| Design record |
What was built, what was measured, what was tried and dropped |
