Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 2.06 KB

README.md

File metadata and controls

55 lines (32 loc) · 2.06 KB

Three Flow

NPM Package

Three Flow is a native Three.js graphing library for adding to a scene. Nodes and edges are rendered using Three.js objects and materials. This allows visuals to have volume, shadows, reflections and dynamic material effects.

image

This library is still under active development. Updates and improvements may have breaking changes.

Live Demo

Inspiration

Inspiration for Working Examples

Future Inspiration Imagery

Documentation

Overview - understand the big picture

Examples - review examples and what features they're using

Getting Start - just the basics

How To - learn to use specific parameters and methods

Customizing - customize the appearance of three-flow classes to make your diagrams stand out

Reference - detailed documentation on parameters, classes and events

Roadmap - changes and features being planned

Comparison to React-Flow - compare working examples

Installation

To add three-flow to your existing three project

npm install three-flow-js

Local Development

This repo uses Angular to host the examples and manage three-flow library. three-flow does not depend on Angular.

Download or clone repo.

npm install
ng serve -o