refactor(nodes,edges): Pass type component as prop

# What's changed?

* Pass component as prop
* Reduce watcher and computed
* Add reactivity transform macros to examples
This commit is contained in:
Braks
2022-04-24 13:34:22 +02:00
parent 2918b689fe
commit b6848e37c8
5 changed files with 139 additions and 140 deletions
+4 -2
View File
@@ -13,11 +13,13 @@ export default defineConfig({
}, },
}, },
plugins: [ plugins: [
vue(), vue({
reactivityTransform: true,
}),
vueTypes(), vueTypes(),
svgLoader(), svgLoader(),
AutoImport({ AutoImport({
imports: ['vue', '@vueuse/core'], imports: ['vue', '@vueuse/core', 'vue/macros'],
dts: resolve('src/auto-imports.d.ts'), dts: resolve('src/auto-imports.d.ts'),
}), }),
], ],
+33 -80
View File
@@ -3,7 +3,6 @@ import { CSSProperties } from 'vue'
import { useHandle, useVueFlow } from '../../composables' import { useHandle, useVueFlow } from '../../composables'
import { ConnectionMode, EdgeComponent, GraphEdge, GraphNode, Position } from '../../types' import { ConnectionMode, EdgeComponent, GraphEdge, GraphNode, Position } from '../../types'
import { getEdgePositions, getHandle, getMarkerId } from '../../utils' import { getEdgePositions, getHandle, getMarkerId } from '../../utils'
import { Slots } from '../../context'
import EdgeAnchor from './EdgeAnchor' import EdgeAnchor from './EdgeAnchor'
interface EdgeWrapper { interface EdgeWrapper {
@@ -13,21 +12,13 @@ interface EdgeWrapper {
targetNode: GraphNode targetNode: GraphNode
selectable?: boolean selectable?: boolean
updatable?: boolean updatable?: boolean
type: EdgeComponent | Function | Object | false
name: string
} }
const { id, edge, sourceNode, targetNode, selectable, updatable } = defineProps<EdgeWrapper>() const { id, edge, name, sourceNode, targetNode, selectable, updatable, type } = defineProps<EdgeWrapper>()
const slots = inject(Slots) const { hooks, connectionMode, edgeUpdaterRadius, noPanClassName, setState, getEdge, addSelectedEdges } = $(useVueFlow())
const { hooks, connectionMode, edgeUpdaterRadius, noPanClassName, setState, getEdge, addSelectedEdges, getEdgeTypes } = $(
useVueFlow(),
)
let name = $ref(edge.type ?? 'default')
watch(
() => edge.type,
(v) => v && (name = v),
)
let updating = $ref(false) let updating = $ref(false)
@@ -81,31 +72,28 @@ const handleEdgeUpdater = (event: MouseEvent, isSourceHandle: boolean) => {
) )
} }
// when connection type is loose we can define all handles as sources const sourceHandle = $computed(() => {
const targetNodeHandles = $computed(() => { let sourceNodeHandles
if (connectionMode === ConnectionMode.Strict) { if (connectionMode === ConnectionMode.Strict) {
return targetNode.handleBounds.target sourceNodeHandles = sourceNode.handleBounds.source
} else {
sourceNodeHandles = sourceNode.handleBounds.source ?? sourceNode.handleBounds.target
} }
const targetBounds = targetNode.handleBounds.target return getHandle(sourceNodeHandles, edge.sourceHandle)
const sourceBounds = targetNode.handleBounds.source
return targetBounds ?? sourceBounds
}) })
const sourceNodeHandles = $computed(() => { const targetHandle = $computed(() => {
let targetNodeHandles
if (connectionMode === ConnectionMode.Strict) { if (connectionMode === ConnectionMode.Strict) {
return sourceNode.handleBounds.source targetNodeHandles = targetNode.handleBounds.target
} else {
targetNodeHandles = targetNode.handleBounds.target ?? targetNode.handleBounds.source
} }
const targetBounds = sourceNode.handleBounds.target return getHandle(targetNodeHandles, edge.targetHandle)
const sourceBounds = sourceNode.handleBounds.source
return sourceBounds ?? targetBounds
}) })
const sourceHandle = $computed(() => getHandle(sourceNodeHandles, edge.sourceHandle))
const targetHandle = $computed(() => getHandle(targetNodeHandles, edge.targetHandle))
const sourcePosition = $(controlledComputed($$(sourceHandle), () => (sourceHandle ? sourceHandle.position : Position.Bottom))) const sourcePosition = $(controlledComputed($$(sourceHandle), () => (sourceHandle ? sourceHandle.position : Position.Bottom)))
const targetPosition = $(controlledComputed($$(targetHandle), () => (targetHandle ? targetHandle.position : Position.Top))) const targetPosition = $(controlledComputed($$(targetHandle), () => (targetHandle ? targetHandle.position : Position.Top)))
@@ -115,8 +103,6 @@ onMounted(() => {
[ [
$$(sourcePosition), $$(sourcePosition),
$$(targetPosition), $$(targetPosition),
() => sourceNode.position,
() => targetNode.position,
() => sourceNode.computedPosition, () => sourceNode.computedPosition,
() => targetNode.computedPosition, () => targetNode.computedPosition,
() => sourceNode.dimensions, () => sourceNode.dimensions,
@@ -132,42 +118,17 @@ onMounted(() => {
targetPosition, targetPosition,
) )
const edge = getEdge(id)! const storedEdge = getEdge(id)!
if (edge.sourceX !== sourceX) storedEdge.sourceX = sourceX
if (edge.sourceX !== sourceX) edge.sourceX = sourceX if (edge.sourceY !== sourceY) storedEdge.sourceY = sourceY
if (edge.sourceY !== sourceY) edge.sourceY = sourceY if (edge.targetX !== targetX) storedEdge.targetX = targetX
if (edge.targetX !== targetX) edge.targetX = targetX if (edge.targetY !== targetY) storedEdge.targetY = targetY
if (edge.targetY !== targetY) edge.targetY = targetY
}, },
{ immediate: true }, { immediate: true, flush: 'post' },
) )
}) })
const type = computed(() => { const getClass = () => {
let edgeType = edge.template ?? getEdgeTypes[name]
const instance = getCurrentInstance()
if (typeof edgeType === 'string') {
if (instance) {
const components = Object.keys(instance.appContext.components)
if (components && components.includes(name)) {
edgeType = resolveComponent(name, false) as EdgeComponent
}
}
}
if (typeof edgeType !== 'string') return edgeType
const slot = slots?.[`edge-${name}`]
if (!slot?.({})) {
console.warn(`[vueflow]: Edge type "${edge.type}" not found and no edge-slot detected. Using fallback type "default".`)
name = 'default'
return getEdgeTypes.default
}
return slot
})
const getClass = computed(() => {
const extraClass = edge.class instanceof Function ? edge.class(edge) : edge.class const extraClass = edge.class instanceof Function ? edge.class(edge) : edge.class
return [ return [
'vue-flow__edge', 'vue-flow__edge',
@@ -181,7 +142,7 @@ const getClass = computed(() => {
}, },
extraClass, extraClass,
] ]
}) }
const getStyle = () => (edge.style instanceof Function ? edge.style(edge) : edge.style) as CSSProperties const getStyle = () => (edge.style instanceof Function ? edge.style(edge) : edge.style) as CSSProperties
</script> </script>
@@ -193,7 +154,7 @@ export default {
</script> </script>
<template> <template>
<g <g
:class="getClass" :class="getClass()"
@click="onEdgeClick" @click="onEdgeClick"
@dblClick="onDoubleClick" @dblClick="onDoubleClick"
@contextmenu="onEdgeContextMenu" @contextmenu="onEdgeContextMenu"
@@ -230,21 +191,13 @@ export default {
:source-handle-id="edge.sourceHandle" :source-handle-id="edge.sourceHandle"
:target-handle-id="edge.targetHandle" :target-handle-id="edge.targetHandle"
/> />
<g <template v-if="updatable">
v-if="updatable" <g @mousedown="onEdgeUpdaterSourceMouseDown" @mouseenter="onEdgeUpdaterMouseEnter" @mouseout="onEdgeUpdaterMouseOut">
@mousedown="onEdgeUpdaterSourceMouseDown" <EdgeAnchor :position="sourcePosition" :center-x="edge.sourceX" :center-y="edge.sourceY" :radius="edgeUpdaterRadius" />
@mouseenter="onEdgeUpdaterMouseEnter" </g>
@mouseout="onEdgeUpdaterMouseOut" <g @mousedown="onEdgeUpdaterTargetMouseDown" @mouseenter="onEdgeUpdaterMouseEnter" @mouseout="onEdgeUpdaterMouseOut">
> <EdgeAnchor :position="targetPosition" :center-x="edge.targetX" :center-y="edge.targetY" :radius="edgeUpdaterRadius" />
<EdgeAnchor :position="sourcePosition" :center-x="edge.sourceX" :center-y="edge.sourceY" :radius="edgeUpdaterRadius" /> </g>
</g> </template>
<g
v-if="updatable"
@mousedown="onEdgeUpdaterTargetMouseDown"
@mouseenter="onEdgeUpdaterMouseEnter"
@mouseout="onEdgeUpdaterMouseOut"
>
<EdgeAnchor :position="targetPosition" :center-x="edge.targetX" :center-y="edge.targetY" :radius="edgeUpdaterRadius" />
</g>
</g> </g>
</template> </template>
+27 -56
View File
@@ -3,24 +3,25 @@ import { useDraggableCore } from '@braks/revue-draggable'
import { CSSProperties } from 'vue' import { CSSProperties } from 'vue'
import { useVueFlow } from '../../composables' import { useVueFlow } from '../../composables'
import { GraphNode, NodeComponent, SnapGrid } from '../../types' import { GraphNode, NodeComponent, SnapGrid } from '../../types'
import { NodeId, Slots } from '../../context' import { NodeId } from '../../context'
import { getHandleBounds, getXYZPos } from '../../utils' import { getHandleBounds, getXYZPos } from '../../utils'
interface NodeWrapperProps { interface NodeWrapperProps {
id: string id: string
node: GraphNode node: GraphNode
parentNode?: GraphNode
draggable: boolean draggable: boolean
selectable: boolean selectable: boolean
connectable: boolean connectable: boolean
snapGrid?: SnapGrid snapGrid?: SnapGrid
type: NodeComponent | Function | Object | false
name: string
} }
const { id, node, draggable, selectable, connectable, snapGrid } = defineProps<NodeWrapperProps>() const { id, type, name, node, parentNode, draggable, selectable, connectable, snapGrid } = defineProps<NodeWrapperProps>()
provide(NodeId, id) provide(NodeId, id)
const slots = inject(Slots)
const { const {
viewport, viewport,
noDragClassName, noDragClassName,
@@ -35,12 +36,6 @@ const {
addSelectedNodes, addSelectedNodes,
} = $(useVueFlow()) } = $(useVueFlow())
let name = $ref(node.type ?? 'default')
watch(
() => node.type,
(v) => v && (name = v),
)
const nodeElement = ref() const nodeElement = ref()
const { scale, disabled, handle, cancel, grid, onDrag, onDragStart, onDragStop } = useDraggableCore(nodeElement, { const { scale, disabled, handle, cancel, grid, onDrag, onDragStart, onDragStop } = useDraggableCore(nodeElement, {
@@ -91,6 +86,8 @@ onMounted(() => {
) )
}) })
const parent = $computed(() => (node.parentNode ? getNode(node.parentNode) : undefined))
onMounted(() => { onMounted(() => {
const observer = useResizeObserver(nodeElement, () => const observer = useResizeObserver(nodeElement, () =>
updateNodeDimensions([{ id: node.id, nodeElement: nodeElement.value, forceUpdate: true }]), updateNodeDimensions([{ id: node.id, nodeElement: nodeElement.value, forceUpdate: true }]),
@@ -109,29 +106,27 @@ onMounted(() => {
updateNodeDimensions([{ id: node.id, nodeElement: nodeElement.value, forceUpdate: true }]) updateNodeDimensions([{ id: node.id, nodeElement: nodeElement.value, forceUpdate: true }])
}) })
watch( onMounted(() => {
[ watch(
() => node.position, [() => node.position, () => parent?.computedPosition, () => node.selected, () => parent?.selected],
() => getNode(node.parentNode!)?.computedPosition, ([pos, parent]) => {
() => node.selected, const xyzPos = {
() => getNode(node.parentNode!)?.selected, ...pos,
], z: node.dragging || node.selected ? 1000 : 0,
([pos, parent]) => { }
const xyzPos = { const graphNode = getNode(id)!
...pos,
z: node.dragging || node.selected ? 1000 : 0,
}
if (parent) { if (parent) {
getNode(id)!.computedPosition = getXYZPos(parent, xyzPos) graphNode.computedPosition = getXYZPos(parent, xyzPos)
} else { } else {
getNode(id)!.computedPosition = xyzPos graphNode.computedPosition = xyzPos
} }
getNode(id)!.handleBounds = getHandleBounds(nodeElement.value, scale.value) graphNode.handleBounds = getHandleBounds(nodeElement.value, scale.value)
}, },
{ deep: true, flush: 'post' }, { deep: true, flush: 'post' },
) )
})
onUnmounted(() => { onUnmounted(() => {
nodeElement.value = undefined nodeElement.value = undefined
@@ -177,30 +172,6 @@ const onSelectNode = (event: MouseEvent) => {
} }
} }
const type = computed(() => {
let nodeType = node.template ?? getNodeTypes[name]
const instance = getCurrentInstance()
if (typeof nodeType === 'string') {
if (instance) {
const components = Object.keys(instance.appContext.components)
if (components && components.includes(name)) {
nodeType = resolveComponent(name, false) as NodeComponent
}
}
}
if (typeof nodeType !== 'string') return nodeType
const slot = slots?.[`node-${name}`]
if (!slot?.({})) {
console.warn(`[vueflow]: Node type "${node.type}" not found and no node-slot detected. Using fallback type "default".`)
name = 'default'
return getNodeTypes.default
}
return slot
})
onDragStart(({ event }) => { onDragStart(({ event }) => {
addSelectedNodes([]) addSelectedNodes([])
hooks.nodeDragStart.trigger({ event, node }) hooks.nodeDragStart.trigger({ event, node })
@@ -280,7 +251,7 @@ export default {
ref="nodeElement" ref="nodeElement"
:class="getClass" :class="getClass"
:style="getStyle" :style="getStyle"
:data-id="node.id" :data-id="id"
@mouseenter="onMouseEnter" @mouseenter="onMouseEnter"
@mousemove="onMouseMove" @mousemove="onMouseMove"
@mouseleave="onMouseLeave" @mouseleave="onMouseLeave"
@@ -3,8 +3,12 @@ import EdgeWrapper from '../../components/Edges/EdgeWrapper.vue'
import ConnectionLine from '../../components/ConnectionLine/ConnectionLine.vue' import ConnectionLine from '../../components/ConnectionLine/ConnectionLine.vue'
import { useVueFlow } from '../../composables' import { useVueFlow } from '../../composables'
import { groupEdgesByZLevel } from '../../utils' import { groupEdgesByZLevel } from '../../utils'
import { EdgeComponent, GraphEdge } from '../../types'
import { Slots } from '../../context'
import MarkerDefinitions from './MarkerDefinitions.vue' import MarkerDefinitions from './MarkerDefinitions.vue'
const slots = inject(Slots)
const { const {
connectionNodeId, connectionNodeId,
nodesConnectable, nodesConnectable,
@@ -14,6 +18,7 @@ const {
elementsSelectable, elementsSelectable,
getNode, getNode,
getEdges, getEdges,
getEdgeTypes,
} = $(useVueFlow()) } = $(useVueFlow())
const sourceNode = $( const sourceNode = $(
@@ -42,6 +47,30 @@ const connectionLineVisible = $(
const getNodeWrapped = (node: string) => getNode(node)! const getNodeWrapped = (node: string) => getNode(node)!
const groups = computed(() => groupEdgesByZLevel(getEdges, getNodeWrapped)) const groups = computed(() => groupEdgesByZLevel(getEdges, getNodeWrapped))
const getType = $computed(() => (edge: GraphEdge) => {
const name = edge.type || 'default'
let edgeType = edge.template ?? getEdgeTypes[name]
const instance = getCurrentInstance()
if (typeof edgeType === 'string') {
if (instance) {
const components = Object.keys(instance.appContext.components)
if (components && components.includes(name)) {
edgeType = resolveComponent(name, false) as EdgeComponent
}
}
}
if (typeof edgeType !== 'string') return edgeType
const slot = slots?.[`edge-${name}`]
if (!slot?.({})) {
console.warn(`[vueflow]: Edge type "${edge.type}" not found and no edge-slot detected. Using fallback type "default".`)
return false
}
return slot
})
</script> </script>
<script lang="ts"> <script lang="ts">
export default { export default {
@@ -57,6 +86,8 @@ export default {
:id="edge.id" :id="edge.id"
:key="edge.id" :key="edge.id"
:edge="edge" :edge="edge"
:name="getType(edge) ? edge.type ?? 'default' : 'default'"
:type="getType(edge)"
:source-node="getNodeWrapped(edge.source)" :source-node="getNodeWrapped(edge.source)"
:target-node="getNodeWrapped(edge.target)" :target-node="getNodeWrapped(edge.target)"
:selectable="typeof edge.selectable === 'undefined' ? elementsSelectable : edge.selectable" :selectable="typeof edge.selectable === 'undefined' ? elementsSelectable : edge.selectable"
@@ -1,14 +1,53 @@
<script lang="ts" setup> <script lang="ts" setup>
import NodeWrapper from '../../components/Nodes/NodeWrapper.vue' import NodeWrapper from '../../components/Nodes/NodeWrapper.vue'
import { SnapGrid } from '../../types' import { GraphNode, NodeComponent, SnapGrid } from '../../types'
import { useVueFlow } from '../../composables' import { useVueFlow } from '../../composables'
import { Slots } from '../../context'
const { nodesDraggable, elementsSelectable, nodesConnectable, snapToGrid, snapGrid, getNodes } = $(useVueFlow()) const slots = inject(Slots)
const {
nodesDraggable,
elementsSelectable,
nodesConnectable,
noPanClassName,
snapToGrid,
snapGrid,
getNode,
getNodes,
getNodeTypes,
} = $(useVueFlow())
const draggable = (d?: boolean) => (typeof d === 'undefined' ? nodesDraggable : d) const draggable = (d?: boolean) => (typeof d === 'undefined' ? nodesDraggable : d)
const selectable = (s?: boolean) => (typeof s === 'undefined' ? elementsSelectable : s) const selectable = (s?: boolean) => (typeof s === 'undefined' ? elementsSelectable : s)
const connectable = (c?: boolean) => (typeof c === 'undefined' ? nodesConnectable : c) const connectable = (c?: boolean) => (typeof c === 'undefined' ? nodesConnectable : c)
const hasSnapGrid = (sg?: SnapGrid) => (sg ?? snapToGrid ? snapGrid : undefined) const hasSnapGrid = (sg?: SnapGrid) => (sg ?? snapToGrid ? snapGrid : undefined)
const getType = $computed(() => {
return (node: GraphNode) => {
const name = node.type || 'default'
let nodeType = node.template ?? getNodeTypes[name]
const instance = getCurrentInstance()
if (typeof nodeType === 'string') {
if (instance) {
const components = Object.keys(instance.appContext.components)
if (components && components.includes(name)) {
nodeType = resolveComponent(name, false) as NodeComponent
}
}
}
if (typeof nodeType !== 'string') return nodeType
const slot = slots?.[`node-${name}`]
if (!slot?.({})) {
console.warn(`[vueflow]: Node type "${node.type}" not found and no node-slot detected. Using fallback type "default".`)
return false
}
return slot
}
})
</script> </script>
<script lang="ts"> <script lang="ts">
export default { export default {
@@ -21,7 +60,10 @@ export default {
v-for="node of getNodes" v-for="node of getNodes"
:id="node.id" :id="node.id"
:key="node.id" :key="node.id"
:type="getType(node)"
:name="getType(node) ? node.type ?? 'default' : 'default'"
:node="node" :node="node"
:parent-node="node.parentNode ? getNode(node.parentNode) : undefined"
:draggable="draggable(node.draggable)" :draggable="draggable(node.draggable)"
:selectable="selectable(node.selectable)" :selectable="selectable(node.selectable)"
:connectable="connectable(node.connectable)" :connectable="connectable(node.connectable)"