microsoft / react-dag-editor

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

Work in progress

react-dag-editor

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

Feature	Description	Demo	Is in default feature set?	Is in read only mode feature set?
GraphFeatures.nodeDraggable	Node drag-and-drop to relocate	(WIP)	Yes	Yes
GraphFeatures.nodeResizable	Double clicking on a node to enable the anchors to resize it	(WIP)	Yes	Yes
GraphFeatures.clickNodeToSelect	Node click-to-select	(WIP)	Yes	Yes
GraphFeatures.panCanvas	Drag-n-drop on canvas to pan	(WIP)	Yes	Yes
GraphFeatures.multipleSelect	Ctrl click multi selection	(WIP)	Yes	Yes
GraphFeatures.lassoSelect	Lasso select	(WIP)	Yes	Yes
GraphFeatures.delete	Use delete key to delete a node	(WIP)	Yes	No
GraphFeatures.addNewNodes	Adding new nodes	(WIP)	Yes	No
GraphFeatures.addNewEdges	Adding new edges	(WIP)	Yes	No
GraphFeatures.addNewPorts	Adding new ports	(WIP)	Yes	No
GraphFeatures.sidePanel,	Built-in side panel	(WIP)	Yes	Yes
GraphFeatures.autoFit	Auto pan/zoom the whole canvas to fit the viewport on every move	(WIP)	No	No
GraphFeatures.editNode	Node inline editing mode	(WIP)	Yes	No
GraphFeatures.autoAlign	Auto aligning hint on node drag-n-drop	(WIP)	Yes	No
GraphFeatures.undoStack	Undo stack to support undo/redo	(WIP)	Yes	No
GraphFeatures.ctrlKeyZoom	Zooming by ctrl clicking + mousewheel	(WIP)	Yes	Yes
GraphFeatures.limitBoundary	Constraint the allowed drag-n-drop area	(WIP)	Yes	Yes

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 [email protected] 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.

react-dag-editor's Issues

Context propagation performance

Context propagation with a large graph consumes a lot of CPU time and may block the browser.
We need to find a way to optimized it

Replace generic "data" field with "properties"

Currently we have too many generic parameters, which result in the difficulty of maintaining and flexibility.
If we replace the generic field with an "token" that contains the type of the value and the engine don't have to be aware of the different types.

Pseudo code:

const myProperty = createProperty<string>("my-property");

const nextNode = node.setProperty(myProperty, "value");

const value = nextNode.getProperty(myProperty); // "value"

This method also resolves #36 that requires a "comment" field in "data".
The result would be like:

// the built-in comment property
const CommentProperty = new Property<string>("comment");

const onChange = e => {
  dispatch({
    type: "CommentChange",
    value: e.target.value
  })
}

// in reducer
switch (action.type) {
  case "CommentChange":
    node.setProperty(CommentProperty, action.value)
}

Unselect other entities when selecting an edge

API docs on the way (July 2021)

Inline edit for built-in node

Previous solution is not type safe and is deleted in #35

Lift state

• Lift configs into state since both components and reducers requires them
• Delete PropsAPI #37
• Remove legacy register components since they are unsafe #51
• Lift state and expose reducers and state #54

First time click does not trigger onClick a <a> inside graph node

Demos and samples on the way (by the end of June 2021)