mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-09 17:40:09 +00:00
## Summary Change Vue node tooltips to align with [design](https://www.figma.com/design/31uH3r4x3xbIctuRWYW6NM/V3---Nodes?node-id=6267-16837&m=dev) ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-5717-style-update-Vue-node-tooltip-style-2766d73d365081bdb095faef17f6aeb6) by [Unito](https://www.unito.io)
121 lines
3.6 KiB
TypeScript
121 lines
3.6 KiB
TypeScript
import { type MaybeRef, type Ref, computed, unref } from 'vue'
|
|
|
|
import type { SafeWidgetData } from '@/composables/graph/useGraphNodeManager'
|
|
import { st } from '@/i18n'
|
|
import { useSettingStore } from '@/platform/settings/settingStore'
|
|
import { useNodeDefStore } from '@/stores/nodeDefStore'
|
|
import { normalizeI18nKey } from '@/utils/formatUtil'
|
|
|
|
/**
|
|
* Composable for managing Vue node tooltips
|
|
* Provides tooltip text for node headers, slots, and widgets
|
|
*/
|
|
export function useNodeTooltips(
|
|
nodeType: MaybeRef<string>,
|
|
containerRef?: Ref<HTMLElement | undefined>
|
|
) {
|
|
const nodeDefStore = useNodeDefStore()
|
|
const settingsStore = useSettingStore()
|
|
|
|
// Check if tooltips are globally enabled
|
|
const tooltipsEnabled = computed(() =>
|
|
settingsStore.get('Comfy.EnableTooltips')
|
|
)
|
|
|
|
// Get node definition for tooltip data
|
|
const nodeDef = computed(() => nodeDefStore.nodeDefsByName[unref(nodeType)])
|
|
|
|
/**
|
|
* Get tooltip text for node description (header hover)
|
|
*/
|
|
const getNodeDescription = computed(() => {
|
|
if (!tooltipsEnabled.value || !nodeDef.value) return ''
|
|
|
|
const key = `nodeDefs.${normalizeI18nKey(unref(nodeType))}.description`
|
|
return st(key, nodeDef.value.description || '')
|
|
})
|
|
|
|
/**
|
|
* Get tooltip text for input slots
|
|
*/
|
|
const getInputSlotTooltip = (slotName: string) => {
|
|
if (!tooltipsEnabled.value || !nodeDef.value) return ''
|
|
|
|
const key = `nodeDefs.${normalizeI18nKey(unref(nodeType))}.inputs.${normalizeI18nKey(slotName)}.tooltip`
|
|
const inputTooltip = nodeDef.value.inputs?.[slotName]?.tooltip ?? ''
|
|
return st(key, inputTooltip)
|
|
}
|
|
|
|
/**
|
|
* Get tooltip text for output slots
|
|
*/
|
|
const getOutputSlotTooltip = (slotIndex: number) => {
|
|
if (!tooltipsEnabled.value || !nodeDef.value) return ''
|
|
|
|
const key = `nodeDefs.${normalizeI18nKey(unref(nodeType))}.outputs.${slotIndex}.tooltip`
|
|
const outputTooltip = nodeDef.value.outputs?.[slotIndex]?.tooltip ?? ''
|
|
return st(key, outputTooltip)
|
|
}
|
|
|
|
/**
|
|
* Get tooltip text for widgets
|
|
*/
|
|
const getWidgetTooltip = (widget: SafeWidgetData) => {
|
|
if (!tooltipsEnabled.value || !nodeDef.value) return ''
|
|
|
|
// First try widget-specific tooltip
|
|
const widgetTooltip = (widget as { tooltip?: string }).tooltip
|
|
if (widgetTooltip) return widgetTooltip
|
|
|
|
// Then try input-based tooltip lookup
|
|
const key = `nodeDefs.${normalizeI18nKey(unref(nodeType))}.inputs.${normalizeI18nKey(widget.name)}.tooltip`
|
|
const inputTooltip = nodeDef.value.inputs?.[widget.name]?.tooltip ?? ''
|
|
return st(key, inputTooltip)
|
|
}
|
|
|
|
/**
|
|
* Create tooltip configuration object for v-tooltip directive
|
|
*/
|
|
const createTooltipConfig = (text: string) => {
|
|
const tooltipDelay = settingsStore.get('LiteGraph.Node.TooltipDelay')
|
|
const tooltipText = text || ''
|
|
|
|
const config: {
|
|
value: string
|
|
showDelay: number
|
|
disabled: boolean
|
|
appendTo?: HTMLElement
|
|
pt?: any
|
|
} = {
|
|
value: tooltipText,
|
|
showDelay: tooltipDelay as number,
|
|
disabled: !tooltipsEnabled.value || !tooltipText,
|
|
pt: {
|
|
text: {
|
|
class:
|
|
'bg-charcoal-800 border border-slate-300 rounded-md px-4 py-2 text-white text-sm font-normal leading-tight max-w-75 shadow-none'
|
|
},
|
|
arrow: {
|
|
class: 'before:border-slate-300'
|
|
}
|
|
}
|
|
}
|
|
|
|
// If we have a container reference, append tooltips to it
|
|
if (containerRef?.value) {
|
|
config.appendTo = containerRef.value
|
|
}
|
|
|
|
return config
|
|
}
|
|
|
|
return {
|
|
tooltipsEnabled,
|
|
getNodeDescription,
|
|
getInputSlotTooltip,
|
|
getOutputSlotTooltip,
|
|
getWidgetTooltip,
|
|
createTooltipConfig
|
|
}
|
|
}
|