Line data Source code
1 : import { computed, unref } from 'vue'
2 : import type { MaybeRef } from 'vue'
3 :
4 : import { resolveNodeDefSlotText, resolveNodeDefText, t } from '@/i18n'
5 : import type { INodeSlot } from '@/lib/litegraph/src/litegraph'
6 : import { RenderShape } from '@comfyorg/graph-model/globalEnums'
7 : import { useSettingStore } from '@/platform/settings/settingStore'
8 : import type { ComfyNodeDefImpl } from '@/core/graph/nodeDef/ComfyNodeDefImpl'
9 : import { useNodeDefStore } from '@/stores/nodeDefStore'
10 :
11 : /**
12 : * Composable for managing Vue node tooltips
13 : * Provides tooltip text for node headers, slots, and widgets
14 : */
15 58637 : export function useNodeTooltips(nodeType: MaybeRef<string>) {
16 58637 : const nodeDefStore = useNodeDefStore()
17 58637 : const settingsStore = useSettingStore()
18 :
19 58637 : const tooltipsEnabled = computed(() =>
20 : settingsStore.get('Comfy.EnableTooltips')
21 : )
22 :
23 58637 : const findNodeDef = (type: string): ComfyNodeDefImpl | undefined =>
24 : nodeDefStore.nodeDefsByName[type]
25 58637 : const nodeDef = computed(() => findNodeDef(unref(nodeType)))
26 :
27 58637 : const getNodeDescription = computed(() => {
28 8033 : if (!tooltipsEnabled.value || !nodeDef.value) return ''
29 :
30 8033 : return resolveNodeDefText(
31 : 'description',
32 : unref(nodeType),
33 : nodeDef.value.description || undefined
34 : )
35 : })
36 :
37 58637 : const describeInput = (inputName: string) =>
38 : nodeDef.value
39 : ? resolveNodeDefSlotText(
40 : 'tooltip',
41 : unref(nodeType),
42 : inputName,
43 : nodeDef.value.inputs[inputName]?.tooltip
44 : )
45 : : ''
46 :
47 58637 : const getInputSlotTooltip = (
48 : slot: Pick<INodeSlot, 'localized_name' | 'name'>
49 : ) => {
50 52972 : if (!tooltipsEnabled.value) return ''
51 :
52 52972 : const inputName = slot.name || ''
53 52972 : return (
54 : describeInput(inputName) ||
55 : t('g.inputTooltip', { name: slot.localized_name || inputName })
56 : )
57 : }
58 :
59 58637 : const getOutputSlotTooltip = (
60 : slot: Pick<INodeSlot, 'name' | 'shape'>,
61 : slotIndex: number
62 : ) => {
63 10409 : if (!tooltipsEnabled.value) return ''
64 :
65 : const description = nodeDef.value
66 : ? resolveNodeDefSlotText(
67 : 'tooltip',
68 : unref(nodeType),
69 : slotIndex,
70 : nodeDef.value.outputs[slotIndex]?.tooltip
71 : )
72 : : ''
73 10409 : const text = description || `Output: ${slot.name || ''}`
74 10409 : return slot.shape === RenderShape.GRID
75 : ? `${text} ${t('vueNodesSlot.iterative')}`
76 : : text
77 : }
78 :
79 58637 : const getWidgetTooltip = (
80 : widget: { name: string; tooltip?: string },
81 : fullValue = ''
82 : ) => {
83 46558 : if (!tooltipsEnabled.value) return ''
84 :
85 : const description = nodeDef.value
86 : ? widget.tooltip || describeInput(widget.name)
87 : : ''
88 46558 : return [description, fullValue].join('\n\n').trim()
89 : }
90 :
91 58637 : return {
92 : getNodeDescription,
93 : getInputSlotTooltip,
94 : getOutputSlotTooltip,
95 : getWidgetTooltip
96 : }
97 : }
|