React Flow

Highly customizable library for building an interactive node-based UI, work...

Diagram / Flow chartReactGraph
wbkd/react-flowreactflow.devreact-flow-renderer

README

readme-header-dark
readme-header


GitHub License MIT
npm downloads
GitHub Repo stars
GitHub release (latest by date)

A highly customizable React component for building interactive graphs and node-based editors.

🚀 Getting Started | 📖 Documentation | 📺 Examples | ☎️ Discord | 💎 React Flow Pro



Key Features


- Easy to use: Seamless zooming and panning, single- and multi selection of graph elements and keyboard shortcuts are supported out of the box
- Customizable: Different node and edge types and support for custom nodes with multiple handles and custom edges
- Fast rendering: Only nodes that have changed are re-rendered and only those in the viewport are displayed
- Hooks and Utils: Hooks for handling nodes, edges and the viewport and graph helper functions
- Plugin Components: Background, MiniMap and Controls
- Reliable: Written in Typescript and tested with cypress

Commercial Usage


Are you using React Flow for a personal project? Great! No sponsorship needed, you can support us by reporting any bugs you find, sending us screenshots of your projects, and starring us on Github 🌟

Are you using React Flow at your organization and making money from it? Awesome! We rely on your support to keep React Flow developed and maintained under an MIT License, just how we like it. You can do that on the React Flow Pro website or through Github Sponsors.

You can find more information in our React Flow Pro FAQs.

Installation


The easiest way to get the latest version of React Flow is to install it via npm, yarn or pnpm:

  1. ``` sh
  2. npm install reactflow
  3. ```

Quickstart


This is only a very basic usage example of React Flow. To see everything that is possible with the library, please refer to the website for guides, examples and the full API reference.

  1. ``` js
  2. import { useCallback } from 'react';
  3. import ReactFlow, {
  4.   MiniMap,
  5.   Controls,
  6.   Background,
  7.   useNodesState,
  8.   useEdgesState,
  9.   addEdge,
  10. } from 'reactflow';

  12. import 'reactflow/dist/style.css';

  14. const initialNodes = [
  15.   { id: '1', position: { x: 0, y: 0 }, data: { label: '1' } },
  16.   { id: '2', position: { x: 0, y: 100 }, data: { label: '2' } },
  17. ];

  19. const initialEdges = [{ id: 'e1-2', source: '1', target: '2' }];

  21. function Flow() {
  22.   const [nodes, setNodes, onNodesChange] = useNodesState(initialNodes);
  23.   const [edges, setEdges, onEdgesChange] = useEdgesState(initialEdges);

  25.   const onConnect = useCallback((params) => setEdges((eds) => addEdge(params, eds)), [setEdges]);

  27.   return (
  28.     <ReactFlow
  29.       nodes={nodes}
  30.       edges={edges}
  31.       onNodesChange={onNodesChange}
  32.       onEdgesChange={onEdgesChange}
  33.       onConnect={onConnect}
  34.     >
  35.       <MiniMap />
  36.       <Controls />
  37.       <Background />
  38.     </ReactFlow>
  39.   );
  40. }

  42. export default Flow;
  43. ```

Development


Before you can start developing please make sure that you have pnpm installed (npm i -g pnpm). Then install the dependencies using pnpm: pnpm install.

Run pnpm build once and then you can use pnpm dev for local development.

Testing


Testing is done with cypress. You can find the tests in the [examples/cypress](/examples/cypress/) folder. In order to run the tests do:

  1. ```sh
  2. pnpm test
  3. ```

Maintainers


React Flow is the full-time project of Moritz and Christopher of webkid, based in Berlin. If you need help or want to talk to us about a collaboration, reach out through our contact form or by joining the React Flow Discord Server.

- Moritz Klack • Twitter • Github
- Christopher Möller • Twitter • Github

Any support you provide goes directly towards the development and maintenance of React Flow, allowing us to continue to operate as an independent company, working on what we think is best for React Flow as an open-source library.

Community Packages


- useUndoable - Hook for undo/redo functionality with an explicit React Flow example
- react-flow-smart-edge - Custom edge that doesn't intersect with nodes
- Feliz.ReactFlow - Feliz React Bindings for React Flow

Credits


React Flow was initially developed for datablocks, a graph-based editor for transforming, analyzing and visualizing data in the browser. Under the hood, React Flow depends on these great libraries:

- d3-zoom - used for zoom, pan and drag interactions with the graph canvas
- d3-drag - used for making the nodes draggable
- zustand - internal state management

License


React Flow is MIT licensed.