0.4.4 • Published 10 months ago

react-dag-editor v0.4.4

Weekly downloads
1
License
MIT
Repository
github
Last release
10 months ago

Work in progress

react-dag-editor

License npm version Downloads

Try it out!

Overview

React component to create graphic user interface with:

  • draggable nodes with ports and edges on a directed graph editor.
  • extensibility to customize the widgets or behaviors.
  • accessbility and testability support

About the name "react-dag-editor"

  • react: it is a react component created from scratch.
  • dag: directed acyclic graph editor. Our a11y solution assumes the graph is a DAG. If you intend to turn off the a11y features, it is fine to draw undirected or cyclic graph with this component.
  • editor: it supports readonly graphic data visualization. However the reason you choose this library is the highlight in the user interaction to create/edit a graph.

Demo

Online sample link: WIP

Local demo

Follow the steps below to run local demo on your machine(MacOS/Linux/Windows):

  1. Clone the repository
  2. Run "yarn" to install all dependencies.
  3. Run "yarn start" and select the "react-dag-editor" in prompt selection.
  4. It won't take long to load the sample page. If not, try to open localhost:5000 on your browser or submit an issue.
  5. Checkout ./packages/ReactDagEditor/stories/components/FeatureDemo.tsx for api usage(Detail API Doc WIP)

Features

FeatureDescriptionDemoIs in default feature set?Is in read only mode feature set?
GraphFeatures.nodeDraggableNode drag-and-drop to relocate(WIP)YesYes
GraphFeatures.nodeResizableDouble clicking on a node to enable the anchors to resize it(WIP)YesYes
GraphFeatures.clickNodeToSelectNode click-to-select(WIP)YesYes
GraphFeatures.panCanvasDrag-n-drop on canvas to pan(WIP)YesYes
GraphFeatures.multipleSelectCtrl click multi selection(WIP)YesYes
GraphFeatures.lassoSelectLasso select(WIP)YesYes
GraphFeatures.deleteUse delete key to delete a node(WIP)YesNo
GraphFeatures.addNewNodesAdding new nodes(WIP)YesNo
GraphFeatures.addNewEdgesAdding new edges(WIP)YesNo
GraphFeatures.addNewPortsAdding new ports(WIP)YesNo
GraphFeatures.sidePanel,Built-in side panel(WIP)YesYes
GraphFeatures.autoFitAuto pan/zoom the whole canvas to fit the viewport on every move(WIP)NoNo
GraphFeatures.editNodeNode inline editing mode(WIP)YesNo
GraphFeatures.autoAlignAuto aligning hint on node drag-n-drop(WIP)YesNo
GraphFeatures.undoStackUndo stack to support undo/redo(WIP)YesNo
GraphFeatures.ctrlKeyZoomZooming by ctrl clicking + mousewheel(WIP)YesYes
GraphFeatures.limitBoundaryConstraint the allowed drag-n-drop area(WIP)YesYes

compatibility

Touch screen/touch pad support

Deceeded rendering on old browsers

Extensibility & customization

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

0.4.4

10 months ago

0.4.4-test.0

10 months ago

0.4.2

1 year ago

0.4.1

1 year ago

0.3.9

2 years ago

0.3.5

2 years ago

0.3.8

2 years ago

0.3.7

2 years ago

0.4.0

2 years ago

0.3.4

2 years ago

0.2.5

2 years ago

0.1.2

3 years ago

0.1.0

3 years ago

0.1.1

3 years ago

0.0.5

5 years ago

0.0.4

5 years ago

0.0.3

5 years ago

0.0.1

5 years ago

0.0.0

5 years ago