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

docs(website): add documentation of exported interfaces to website docs

Browse Source
This commit is contained in:
Christopher Möller
2020-10-06 17:29:00 +02:00
parent 8bd7d7dcf0
commit 34f85fd662
5 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/src/markdown/docs/api/handle.md
+3 -1
View File
@@ -28,6 +28,8 @@ const targetHandleWithValidation = (
- `style`: css properties
- `className`: additional class name
**Typescript:** The interface of the Handle Prop Types are exported as `HandleProps`.
### Validation
The handle receives the additional class names `connecting` when the connection line is above the handle and `valid` if the connection is valid. You can find an example which uses these classes [here](/examples/validation).
@@ -35,4 +37,4 @@ The handle receives the additional class names `connecting` when the connection
### Multiple Handles
If you need multiple source or target handles you can achieve this by creating a custom node. Normally you just use the id of a node for the `source` or `target` of an edge. If you have multiple source or target handles you need to pass an id to these handles. These ids get then added to the node id, so that you can connect a specific handle. If you have a node with an id = `1` and a handle with an id = `a` you can connect this handle by using the id = `1__a`.
You can find an example of how to implement a custom node with multiple handles in the [custom node example](https://github.com/wbkd/react-flow/blob/main/example/src/CustomNode/ColorSelectorNode.js#L18-L29).
You can find an example of how to implement a custom node with multiple handles in the [custom node example](https://github.com/wbkd/react-flow/blob/main/example/src/CustomNode/ColorSelectorNode.js#L18-L29).