alighasami/vue-flow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(docs,deps): update deps (#1598)

Browse Source 
* chore(docs,deps): update deps

Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>

* chore(docs,plugins): update web vitals plugin

Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>

* chore(docs): update links

Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>

---------

Signed-off-by: braks <78412429+bcakmakoglu@users.noreply.github.com>
This commit is contained in:
Braks
2024-08-26 09:26:16 +02:00
committed by GitHub
parent f24230a010
commit 564d5931a5
17 changed files with 1196 additions and 896 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/src/guide/node.md
+8 -8
View File
@@ -423,7 +423,7 @@ function onSomeEvent(nodeId) {
:::
## [Predefined Node-Types](/typedocs/types/DefaultNodeTypes)
## [Predefined Node-Types](/typedocs/type-aliases/DefaultNodeTypes)
Vue Flow provides several built-in node types that you can leverage immediately.
The included node types are `default`, `input`, and `output`.
@@ -749,23 +749,23 @@ But you may wish to expand on these features or implement your business logic in
| id | Unique node id | string | <Close class="text-red-500" /> |
| type | Node Type | string | <Close class="text-red-500" /> |
| selected | Is node selected | boolean | <Close class="text-red-500" /> |
| connectable | Can node handles be connected | [HandleConnectable](/typedocs/types/HandleConnectable) | <Close class="text-red-500" /> |
| connectable | Can node handles be connected | [HandleConnectable](/typedocs/type-aliases/HandleConnectable) | <Close class="text-red-500" /> |
| position | Node's x, y (relative) position on the graph | [XYPosition](/typedocs/interfaces/XYPosition) | <Close class="text-red-500" /> |
| dimensions | Dom element dimensions (width, height) | [Dimensions](/typedocs/interfaces/Dimensions) | <Close class="text-red-500" /> |
| label | Node label, either a string or a VNode. `h('div', props, children)` | string \| VNode \| Component \| Object | <Check class="text-[var(--vp-c-brand)]" /> |
| isValidTargetPos <Badge type="warning" text="deprecated" /> | Called when used as target for new connection | [ValidConnectionFunc](/typedocs/types/ValidConnectionFunc) | <Check class="text-[var(--vp-c-brand)]" /> |
| isValidSourcePos <Badge type="warning" text="deprecated" /> | Called when used as the source for a new connection | [ValidConnectionFunc](/typedocs/types/ValidConnectionFunc) | <Check class="text-[var(--vp-c-brand)]" /> |
| isValidTargetPos <Badge type="warning" text="deprecated" /> | Called when used as target for new connection | [ValidConnectionFunc](/typedocs/type-aliases/ValidConnectionFunc) | <Check class="text-[var(--vp-c-brand)]" /> |
| isValidSourcePos <Badge type="warning" text="deprecated" /> | Called when used as the source for a new connection | [ValidConnectionFunc](/typedocs/type-aliases/ValidConnectionFunc) | <Check class="text-[var(--vp-c-brand)]" /> |
| parent | Parent node id | string | <Check class="text-[var(--vp-c-brand)]" /> |
| dragging | Is node currently dragging | boolean | <Close class="text-red-500" /> |
| resizing | Is node currently resizing | boolean | <Close class="text-red-500" /> |
| zIndex | Node z-index | number | <Close class="text-red-500" /> |
| targetPosition | Handle position | [Position](/typedocs/enums/Position) | <Check class="text-[var(--vp-c-brand)]" /> |
| sourcePosition | Handle position | [Position](/typedocs/enums/Position) | <Check class="text-[var(--vp-c-brand)]" /> |
| targetPosition | Handle position | [Position](/typedocs/enumerations/Position) | <Check class="text-[var(--vp-c-brand)]" /> |
| sourcePosition | Handle position | [Position](/typedocs/enumerations/Position) | <Check class="text-[var(--vp-c-brand)]" /> |
| dragHandle | Drag handle query selector | string | <Check class="text-[var(--vp-c-brand)]" /> |
| data | Additional data of node | any object | <Close class="text-red-500" /> |
| events | Contextual and custom events of node | [NodeEventsOn](/typedocs/types/NodeEventsOn) | <Close class="text-red-500" /> |
| events | Contextual and custom events of node | [NodeEventsOn](/typedocs/type-aliases/NodeEventsOn) | <Close class="text-red-500" /> |
## [Node Events](/typedocs/types/NodeEventsHandler)
## [Node Events](/typedocs/type-aliases/NodeEventsHandler)
Vue Flow provides two main ways of listening to node events,
either by using `useVueFlow` to bind listeners to the event handlers or by binding them to the `<VueFlow>` component.