* chore(netlify): add redirects

* chore(readme): add props section
This commit is contained in:
Moritz
2019-10-22 14:22:24 +02:00
committed by GitHub
parent dcc38b23d8
commit d84de2954b

View File

@@ -1,3 +1,31 @@
# :ocean: React Flow
React library for rendering interactive flow diagrams.
React library for rendering an interactive node-based flow editor
# Installation
```
npm install github:wbkd/react-flow
```
# Props
- `elements`: array with nodes and edges
- `onElementClick`: element click handler
- `onElementsRemove`: element remove handler
- `onNodeDragStop`: node drag stop handler
- `onConnect`: connect handler
- `onLoad`: editor load handler
- `onMove`: move handler
- `nodeTypes`: object with node types
- `edgeTypes`: object with node types
- `connectionLineType`: connection line type = `straight` or `bezier`
- `connectionLineStyle`: connection style as svg attributes
- `deleteKeyCode`: delete key code
- `selectionKeyCode`: selection key code
- `showBackground`: boolean
- `backgroundGap`: gap size
- `backgroundColor`: color of dots or lines
- `backgroundType`: background type = `dots` or `lines`
- `snapToGrid`: boolean
- `snapGrid`: [x, y] array