|
| 1 | +<template> |
| 2 | + <div |
| 3 | + v-if="tooltipText" |
| 4 | + ref="tooltipRef" |
| 5 | + class="node-tooltip" |
| 6 | + :style="{ left, top }" |
| 7 | + > |
| 8 | + {{ tooltipText }} |
| 9 | + </div> |
| 10 | +</template> |
| 11 | + |
| 12 | +<script setup lang="ts"> |
| 13 | +import { nextTick, ref, onBeforeUnmount, watch } from 'vue' |
| 14 | +import { LiteGraph } from '@comfyorg/litegraph' |
| 15 | +import { app as comfyApp } from '@/scripts/app' |
| 16 | +import { useNodeDefStore } from '@/stores/nodeDefStore' |
| 17 | +import { useSettingStore } from '@/stores/settingStore' |
| 18 | +
|
| 19 | +let idleTimeout: number |
| 20 | +const nodeDefStore = useNodeDefStore() |
| 21 | +const settingStore = useSettingStore() |
| 22 | +const tooltipRef = ref<HTMLDivElement>() |
| 23 | +const tooltipText = ref('') |
| 24 | +const left = ref<string>() |
| 25 | +const top = ref<string>() |
| 26 | +
|
| 27 | +const getHoveredWidget = () => { |
| 28 | + const node = comfyApp.canvas.node_over |
| 29 | + if (!node.widgets) return |
| 30 | +
|
| 31 | + const graphPos = comfyApp.canvas.graph_mouse |
| 32 | + const x = graphPos[0] - node.pos[0] |
| 33 | + const y = graphPos[1] - node.pos[1] |
| 34 | +
|
| 35 | + for (const w of node.widgets) { |
| 36 | + let widgetWidth: number, widgetHeight: number |
| 37 | + if (w.computeSize) { |
| 38 | + ;[widgetWidth, widgetHeight] = w.computeSize(node.size[0]) |
| 39 | + } else { |
| 40 | + widgetWidth = (w as { width?: number }).width || node.size[0] |
| 41 | + widgetHeight = LiteGraph.NODE_WIDGET_HEIGHT |
| 42 | + } |
| 43 | +
|
| 44 | + if ( |
| 45 | + w.last_y !== undefined && |
| 46 | + x >= 6 && |
| 47 | + x <= widgetWidth - 12 && |
| 48 | + y >= w.last_y && |
| 49 | + y <= w.last_y + widgetHeight |
| 50 | + ) { |
| 51 | + return w |
| 52 | + } |
| 53 | + } |
| 54 | +} |
| 55 | +
|
| 56 | +const hideTooltip = () => (tooltipText.value = null) |
| 57 | +
|
| 58 | +const showTooltip = async (tooltip: string | null | undefined) => { |
| 59 | + if (!tooltip) return |
| 60 | +
|
| 61 | + left.value = comfyApp.canvas.mouse[0] + 'px' |
| 62 | + top.value = comfyApp.canvas.mouse[1] + 'px' |
| 63 | + tooltipText.value = tooltip |
| 64 | +
|
| 65 | + await nextTick() |
| 66 | +
|
| 67 | + const rect = tooltipRef.value.getBoundingClientRect() |
| 68 | + if (rect.right > window.innerWidth) { |
| 69 | + left.value = comfyApp.canvas.mouse[0] - rect.width + 'px' |
| 70 | + } |
| 71 | +
|
| 72 | + if (rect.top < 0) { |
| 73 | + top.value = comfyApp.canvas.mouse[1] + rect.height + 'px' |
| 74 | + } |
| 75 | +} |
| 76 | +
|
| 77 | +const onIdle = () => { |
| 78 | + const { canvas } = comfyApp |
| 79 | + const node = canvas.node_over |
| 80 | + if (!node) return |
| 81 | +
|
| 82 | + const ctor = node.constructor as { title_mode?: 0 | 1 | 2 | 3 } |
| 83 | + const nodeDef = nodeDefStore.nodeDefsByName[node.type] |
| 84 | +
|
| 85 | + if ( |
| 86 | + ctor.title_mode !== LiteGraph.NO_TITLE && |
| 87 | + canvas.graph_mouse[1] < node.pos[1] // If we are over a node, but not within the node then we are on its title |
| 88 | + ) { |
| 89 | + return showTooltip(nodeDef.description) |
| 90 | + } |
| 91 | +
|
| 92 | + if (node.flags?.collapsed) return |
| 93 | +
|
| 94 | + const inputSlot = canvas.isOverNodeInput( |
| 95 | + node, |
| 96 | + canvas.graph_mouse[0], |
| 97 | + canvas.graph_mouse[1], |
| 98 | + [0, 0] |
| 99 | + ) |
| 100 | + if (inputSlot !== -1) { |
| 101 | + const inputName = node.inputs[inputSlot].name |
| 102 | + return showTooltip(nodeDef.input.getInput(inputName)?.tooltip) |
| 103 | + } |
| 104 | +
|
| 105 | + const outputSlot = canvas.isOverNodeOutput( |
| 106 | + node, |
| 107 | + canvas.graph_mouse[0], |
| 108 | + canvas.graph_mouse[1], |
| 109 | + [0, 0] |
| 110 | + ) |
| 111 | + if (outputSlot !== -1) { |
| 112 | + return showTooltip(nodeDef.output.all?.[outputSlot].tooltip) |
| 113 | + } |
| 114 | +
|
| 115 | + const widget = getHoveredWidget() |
| 116 | + // Dont show for DOM widgets, these use native browser tooltips as we dont get proper mouse events on these |
| 117 | + if (widget && !widget.element) { |
| 118 | + return showTooltip( |
| 119 | + widget.tooltip ?? nodeDef.input.getInput(widget.name)?.tooltip |
| 120 | + ) |
| 121 | + } |
| 122 | +} |
| 123 | +
|
| 124 | +const onMouseMove = (e: MouseEvent) => { |
| 125 | + hideTooltip() |
| 126 | + clearTimeout(idleTimeout) |
| 127 | +
|
| 128 | + if ((e.target as Node).nodeName !== 'CANVAS') return |
| 129 | + idleTimeout = window.setTimeout(onIdle, 500) |
| 130 | +} |
| 131 | +
|
| 132 | +watch( |
| 133 | + () => settingStore.get<boolean>('Comfy.EnableTooltips'), |
| 134 | + (enabled) => { |
| 135 | + if (enabled) { |
| 136 | + window.addEventListener('mousemove', onMouseMove) |
| 137 | + window.addEventListener('click', hideTooltip) |
| 138 | + } else { |
| 139 | + window.removeEventListener('mousemove', onMouseMove) |
| 140 | + window.removeEventListener('click', hideTooltip) |
| 141 | + } |
| 142 | + }, |
| 143 | + { immediate: true } |
| 144 | +) |
| 145 | +
|
| 146 | +onBeforeUnmount(() => { |
| 147 | + window.removeEventListener('mousemove', onMouseMove) |
| 148 | + window.removeEventListener('click', hideTooltip) |
| 149 | +}) |
| 150 | +</script> |
| 151 | + |
| 152 | +<style lang="css" scoped> |
| 153 | +.node-tooltip { |
| 154 | + background: var(--comfy-input-bg); |
| 155 | + border-radius: 5px; |
| 156 | + box-shadow: 0 0 5px rgba(0, 0, 0, 0.4); |
| 157 | + color: var(--input-text); |
| 158 | + font-family: sans-serif; |
| 159 | + left: 0; |
| 160 | + max-width: 30vw; |
| 161 | + padding: 4px 8px; |
| 162 | + position: absolute; |
| 163 | + top: 0; |
| 164 | + transform: translate(5px, calc(-100% - 5px)); |
| 165 | + white-space: pre-wrap; |
| 166 | + z-index: 99999; |
| 167 | +} |
| 168 | +</style> |
0 commit comments