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

docs(readme): add data and classname options to edge

Browse Source
This commit is contained in:
moklick
2020-07-27 12:46:52 +02:00
parent b3391860da
commit 05786fcee6
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2
View File
@@ -272,6 +272,7 @@ If you wanted to display this edge, you would need a node with id = 1 (source no
- `type`: 'input', 'output', 'default' or a custom one you implemented - `type`: 'input', 'output', 'default' or a custom one you implemented
- `animated`: boolean - `animated`: boolean
- `style`: css properties for the edge line path - `style`: css properties for the edge line path
- `className`: additional class name
- `label`: string - `label`: string
- `labelStyle`: css properties for the text - `labelStyle`: css properties for the text
- `labelShowBg`: boolean - default: `true` - `labelShowBg`: boolean - default: `true`
@@ -279,6 +280,7 @@ If you wanted to display this edge, you would need a node with id = 1 (source no
- `arrowHeadType`: 'arrow' or 'arrowclosed' - defines the arrowhead of the edge - `arrowHeadType`: 'arrow' or 'arrowclosed' - defines the arrowhead of the edge
- `markerEndId`: custom marker end url - if this is used `arrowHeadType` gets ignored - `markerEndId`: custom marker end url - if this is used `arrowHeadType` gets ignored
- `isHidden`: if `true`, the edge will not be rendered - `isHidden`: if `true`, the edge will not be rendered
- `data`: {} you can use this to pass data to your custom edges.
You can find an example with different edges in the [edges example](https://reactflow.dev/edges). You can find an example with different edges in the [edges example](https://reactflow.dev/edges).