<div align="center"> <img width="650" src="docs/assets/logo-light.png"> <br /> Node-based Visualizations for React <br /><br /> <a href="https://github.com/reaviz/reaflow/workflows/build/"> <img src="https://github.com/reaviz/reaflow/workflows/build/badge.svg?branch=master" /> </a> <a href="https://npm.im/reaflow"> <img src="https://img.shields.io/npm/v/reaflow.svg" /> </a> <a href="https://npm.im/reaflow"> <img src="https://badgen.net/npm/dw/reaflow" /> </a> <a href="https://github.com/reaviz/reaflow/blob/master/LICENSE"> <img src="https://badgen.now.sh/badge/license/apache2" /> </a> <a href="https://discord.gg/tt8wGExq35"> <img src="https://img.shields.io/discord/773948315037073409?label=discord"> </a> <a href="https://opencollective.com/reaviz"> <img alt="Open Collective backers and sponsors" src="https://img.shields.io/opencollective/all/reaviz?label=backers"> </a> </div>

REAFLOW is a modular diagram engine for building static or interactive editors. The library is feature-rich and modular allowing for displaying complex visualizations with total customizability.

🚀 Quick Links

Checkout the docs and demos
Learn about updates from the Changelog

💎 Other Projects

Reagraph - Open-source library for large webgl based network graphs.
Reablocks - Open-source component library for React based on Tailwind.
Reaviz - Open-source library for data visulizations for React.
Reachat - Open-source library for building LLM/Chat UIs for React.

✨ Features

Complex automatic layout leveraging ELKJS
Easy Node/Edge/Port customizations
Zooming / Panning / Centering controls
Drag and drop Node/Port connecting and rearranging
Nesting of Nodes/Edges
Proximity based Node linking helper
Node/Edge selection helper
Undo/Redo helper

📦 Usage

Install the package via NPM:

npm i reaflow --save

Install the package via Yarn:

yarn add reaflow

Import the component into your app and add some nodes and edges:

import React from 'react';
import { Canvas } from 'reaflow';

export default () => (
  <Canvas
    maxWidth={800}
    maxHeight={600}
    nodes={[
      {
        id: '1',
        text: '1'
      },
      {
        id: '2',
        text: '2'
      }
    ]}
    edges={[
      {
        id: '1-2',
        from: '1',
        to: '2'
      }
    ]}
  />
);

🔭 Development

If you want to run reaflow locally, its super easy!

Clone the repo
npm i
npm start
Browser opens to Storybook page

❤️ Contributors

Thanks to all our contributors!

Reaflow

Install / Use

README