alighasami/xyflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): add new mini map prop, nodrag and getConnectedEdges

Browse Source
This commit is contained in:
moklick
2020-08-28 20:11:29 +02:00
parent 3cbba37da0
commit e30d309f5d
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10
View File
@@ -233,6 +233,10 @@ Your custom nodes are wrapped so that the basic functions like dragging or selec
- `sourcePosition`: string - `sourcePosition`: string
- `targetPosition`: string - `targetPosition`: string
### Prevent dragging
If you have controls inside your custom node that should not drag the node you can add the class name `nodrag`.
## Handle Component ## Handle Component
We export a `Handle` component as a helper for your custom nodes: We export a `Handle` component as a helper for your custom nodes:
@@ -425,6 +429,7 @@ const FlowWithMiniMap = () => (
- `nodeColor`: string or function - If you pass a color as a string all nodes will get that color. If you pass a function you can return a color depending on the passed node. - `nodeColor`: string or function - If you pass a color as a string all nodes will get that color. If you pass a function you can return a color depending on the passed node.
- `nodeBorderRadius`: number - `nodeBorderRadius`: number
- `nodeClassName`: string or function for adding an additional class to the nodes inside the mini map
- `maskColor`: string - `maskColor`: string
- `style`: css properties - `style`: css properties
- `className`: additional class name - `className`: additional class name
@@ -571,6 +576,11 @@ Returns all direct child nodes of the passed node
`getOutgoers = (node: Node, elements: Elements): Node[]` `getOutgoers = (node: Node, elements: Elements): Node[]`
### getConnectedEdges
Returns all edges that are connected to the passed nodes
`getConnectedEdges = (nodes: Node[], edges: Edge[]): Edge[]`
You can use these function as seen in [this example](/example/src/Overview/index.js#L40-L41) or use your own ones. You can use these function as seen in [this example](/example/src/Overview/index.js#L40-L41) or use your own ones.