Skip to content

Commit d96e944

Browse files
committed
fix(types): use correct edge event types
# What's changed? * instead of `MouseEvent`, emit `EdgeMouseEvent` type * fix examples
1 parent 3537e6b commit d96e944

File tree

13 files changed

+56
-43
lines changed

13 files changed

+56
-43
lines changed

examples/vite/src/Basic/BasicOptionsAPI.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export default defineComponent({
4343
},
4444
onPaneReady(instance: FlowEvents['paneReady']) {
4545
instance.fitView()
46-
this.instance = instance
46+
this.instance = instance as any
4747
},
4848
onConnect(params: FlowEvents['connect']) {
4949
addEdge(params, this.elements)

examples/vite/src/CustomConnectionLine/ConnectionLine.vue

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ interface CustomConnectionLineProps {
55
targetX: number
66
targetY: number
77
}
8+
89
const props = defineProps<CustomConnectionLineProps>()
910
</script>
1011

examples/vite/src/DragNDrop/DnD.vue

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import Sidebar from './Sidebar.vue'
66
let id = 0
77
const getId = () => `dndnode_${id++}`
88
9-
const { instance, onConnect, nodes, edges, addEdges, addNodes } = useVueFlow({
9+
const { onConnect, nodes, edges, addEdges, addNodes, project } = useVueFlow({
1010
nodes: [
1111
{
1212
id: '1',
@@ -26,17 +26,15 @@ const onDragOver = (event: DragEvent) => {
2626
onConnect((params) => addEdges([params]))
2727
2828
const onDrop = (event: DragEvent) => {
29-
if (instance.value) {
30-
const type = event.dataTransfer?.getData('application/vueflow')
31-
const position = instance.value.project({ x: event.clientX, y: event.clientY - 40 })
32-
const newNode = {
33-
id: getId(),
34-
type,
35-
position,
36-
label: `${type} node`,
37-
} as Node
38-
addNodes([newNode])
39-
}
29+
const type = event.dataTransfer?.getData('application/vueflow')
30+
const position = project({ x: event.clientX, y: event.clientY - 40 })
31+
const newNode = {
32+
id: getId(),
33+
type,
34+
position,
35+
label: `${type} node`,
36+
} as Node
37+
addNodes([newNode])
4038
}
4139
</script>
4240

examples/vite/src/EdgeTypes/EdgeTypesExample.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { getElements } from './utils'
55
66
const onLoad = (flowInstance: VueFlowStore) => {
77
flowInstance.fitView()
8-
console.log(flowInstance.getElements())
8+
console.log(flowInstance.getElements.value)
99
}
1010
1111
const elements = getElements()

examples/vite/src/FloatingEdges/FloatingEdges.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<script lang="ts" setup>
2-
import { Background, Controls, MarkerType, MiniMap, VueFlow, useVueFlow } from '@braks/vue-flow'
2+
import { Background, BackgroundVariant, Controls, MarkerType, MiniMap, VueFlow, useVueFlow } from '@braks/vue-flow'
33
import FloatingEdge from './FloatingEdge.vue'
44
import FloatingConnectionLine from './FloatingConnectionLine.vue'
55
import { createElements } from './floating-edge-utils'
@@ -14,7 +14,7 @@ onConnect((params) => addEdges([{ ...params, type: 'floating', markerEnd: Marker
1414
<template>
1515
<div class="floatingedges">
1616
<VueFlow>
17-
<Background variant="lines" :gap="24" />
17+
<Background :variant="BackgroundVariant.Lines" :gap="24" />
1818
<MiniMap />
1919
<Controls />
2020

examples/vite/src/Overview/Overview.vue

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
<script lang="ts" setup>
2-
import type { Connection, Edge, Elements, FlowEvents, VueFlowStore, FlowTransform, Node, SnapGrid } from '@braks/vue-flow'
2+
import type {
3+
Connection,
4+
Edge,
5+
Elements,
6+
FlowEvents,
7+
Node,
8+
SnapGrid,
9+
Styles,
10+
ViewpaneTransform,
11+
VueFlowStore,
12+
} from '@braks/vue-flow'
313
import { Background, Controls, MarkerType, MiniMap, VueFlow, addEdge } from '@braks/vue-flow'
414
515
const onNodeDragStart = (e: FlowEvents['nodeDragStart']) => console.log('drag start', e)
@@ -18,7 +28,7 @@ const onLoad = (flowInstance: VueFlowStore) => {
1828
flowInstance.fitView()
1929
}
2030
21-
const onMoveEnd = (transform?: FlowTransform) => console.log('zoom/move end', transform)
31+
const onMoveEnd = (e: FlowEvents['moveEnd']) => console.log('zoom/move end', e.flowTransform)
2232
const onEdgeContextMenu = (e: FlowEvents['edgeContextMenu']) => console.log('edge context menu', e)
2333
const onEdgeMouseEnter = (e: FlowEvents['edgeMouseEnter']) => console.log('edge mouse enter', e)
2434
const onEdgeMouseMove = (e: FlowEvents['edgeMouseMove']) => console.log('edge mouse move', e)
@@ -83,7 +93,7 @@ const initialElements: Elements = [
8393
const snapGrid: SnapGrid = [16, 16]
8494
8595
const nodeStrokeColor = (n: Node): string => {
86-
if (n.style?.background) return n.style.background as string
96+
if ((n.style as Styles)?.background) return (n.style as Styles).background as string
8797
if (n.type === 'input') return '#0041d0'
8898
if (n.type === 'output') return '#ff0072'
8999
if (n.type === 'default') return '#1a192b'
@@ -92,7 +102,7 @@ const nodeStrokeColor = (n: Node): string => {
92102
}
93103
94104
const nodeColor = (n: Node): string => {
95-
if (n.style?.background) return n.style.background as string
105+
if ((n.style as Styles)?.background) return (n.style as Styles).background as string
96106
97107
return '#fff'
98108
}
@@ -121,7 +131,6 @@ const onConnect = (params: Connection | Edge) => (elements.value = addEdge(param
121131
@selection-drag-stop="onSelectionDragStop"
122132
@selection-context-menu="onSelectionContextMenu"
123133
@move-end="onMoveEnd"
124-
@edge-update="onEdgeMouseMove"
125134
@edge-context-menu="onEdgeContextMenu"
126135
@edge-mouse-enter="onEdgeMouseEnter"
127136
@edge-mouse-move="onEdgeMouseMove"

examples/vite/src/SaveRestore/Controls.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ const state = useStorage<FlowExportObject>(flowKey, {
1313
const getNodeId = () => `randomnode_${+new Date()}`
1414
1515
const { setTransform } = useZoomPanHelper()
16-
const { nodes, edges, addNodes, setNodes, setEdges, instance, dimensions } = useVueFlow()
16+
const { nodes, edges, addNodes, setNodes, setEdges, toObject, dimensions } = useVueFlow()
1717
1818
const onSave = () => {
19-
state.value = instance.value?.toObject()
19+
state.value = toObject()
2020
}
2121
2222
const onRestore = () => {

examples/vite/src/Stress/StressExample.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ onPaneReady((i) => {
1313
i.fitView({
1414
padding: 0.2,
1515
})
16-
console.log(i.getElements())
16+
console.log(i.getElements.value)
1717
})
1818
</script>
1919

examples/vite/src/UpdatableEdge/UpdatableEdgeExample.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ const initialElements: Elements = [
2525
2626
const elements = ref(initialElements)
2727
const onLoad = (flowInstance: VueFlowStore) => flowInstance.fitView()
28-
const onEdgeUpdateStart = (edge: Edge) => console.log('start update', edge)
29-
const onEdgeUpdateEnd = (edge: Edge) => console.log('end update', edge)
28+
const onEdgeUpdateStart = ({ edge }: FlowEvents['edgeUpdateStart']) => console.log('start update', edge)
29+
const onEdgeUpdateEnd = ({ edge }: FlowEvents['edgeUpdateEnd']) => console.log('end update', edge)
3030
const onEdgeUpdate = ({ edge, connection }: FlowEvents['edgeUpdate']) => {
3131
elements.value = updateEdge(edge, connection, elements.value)
3232
}

packages/vue-flow/src/container/VueFlow/VueFlow.vue

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import { Slots } from '../../context'
88
import type {
99
Connection,
1010
EdgeChange,
11+
EdgeUpdateEvent,
1112
GraphEdge,
1213
GraphNode,
1314
NodeChange,
@@ -79,13 +80,13 @@ const emit = defineEmits<{
7980
(event: 'paneContextMenu', paneEvent: MouseEvent): void
8081
(event: 'edgeContextMenu', edgeMouseEvent: EdgeMouseEvent): void
8182
(event: 'edgeMouseEnter', edgeMouseEvent: EdgeMouseEvent): void
82-
(event: 'edgeMouseMove', edgeMouseEvent: MouseEvent): void
83-
(event: 'edgeMouseLeave', edgeMouseEvent: MouseEvent): void
84-
(event: 'edgeDoubleClick', edgeMouseEvent: MouseEvent): void
85-
(event: 'edgeClick', edgeMouseEvent: MouseEvent): void
86-
(event: 'edgeUpdateStart', edgeMouseEvent: MouseEvent): void
87-
(event: 'edgeUpdate', edgeMouseEvent: MouseEvent): void
88-
(event: 'edgeUpdateEnd', edgeMouseEvent: MouseEvent): void
83+
(event: 'edgeMouseMove', edgeMouseEvent: EdgeMouseEvent): void
84+
(event: 'edgeMouseLeave', edgeMouseEvent: EdgeMouseEvent): void
85+
(event: 'edgeDoubleClick', edgeMouseEvent: EdgeMouseEvent): void
86+
(event: 'edgeClick', edgeMouseEvent: EdgeMouseEvent): void
87+
(event: 'edgeUpdateStart', edgeMouseEvent: EdgeMouseEvent): void
88+
(event: 'edgeUpdate', edgeMouseEvent: EdgeUpdateEvent): void
89+
(event: 'edgeUpdateEnd', edgeMouseEvent: EdgeMouseEvent): void
8990
(event: 'updateNodeInternals', id: string): void
9091
9192
/** v-model event definitions */

0 commit comments

Comments
 (0)