Skip to main content

Introduction

React Flow is a library for building node-based applications. These can be simple static diagrams or complex editors. You can implement custom node types and edge types and it comes with components like a mini-map and graph controls. The best way to start is to follow the getting started guide or check out the examples.

Key Features

  • Easy to use: Seamless zooming & panning behaviour and single and multi-selections of nodes and edges
  • 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 that are in the viewport are displayed
  • Hooks and Utils: Hooks for handling nodes, edges and the viewport and graph util functions
  • Plugin Components: Background, MiniMap and Controls
  • Reliable: Written in Typescript and tested with cypress

Migrate to v11

If you want to migrate to v11 you can check out the "Migrate to v11 Guide". In case you are on v9, please do the "Migrate to v10 Guide" first.

Legacy Docs

If you are looking for the old docs, you can find them here: