mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-02-09 17:40:09 +00:00
## Summary - add a watcher to sync the node help panel with the currently selected node - add unit coverage for help auto-switching and guard cases ## Testing - pnpm typecheck - pnpm lint:fix - pnpm exec vitest tests-ui/tests/composables/graph/useSelectionState.test.ts ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-7105-Sync-node-help-with-selection-and-add-watcher-tests-2bd6d73d36508140b5acd3f3c65c5680) by [Unito](https://www.unito.io)
143 lines
4.6 KiB
TypeScript
143 lines
4.6 KiB
TypeScript
import { storeToRefs } from 'pinia'
|
|
import { computed } from 'vue'
|
|
|
|
import { useNodeLibrarySidebarTab } from '@/composables/sidebarTabs/useNodeLibrarySidebarTab'
|
|
import type { LGraphNode } from '@/lib/litegraph/src/litegraph'
|
|
import { LGraphEventMode, SubgraphNode } from '@/lib/litegraph/src/litegraph'
|
|
import { useSettingStore } from '@/platform/settings/settingStore'
|
|
import { useCanvasStore } from '@/renderer/core/canvas/canvasStore'
|
|
import { useNodeDefStore } from '@/stores/nodeDefStore'
|
|
import { useNodeHelpStore } from '@/stores/workspace/nodeHelpStore'
|
|
import { useSidebarTabStore } from '@/stores/workspace/sidebarTabStore'
|
|
import { isImageNode, isLGraphNode, isLoad3dNode } from '@/utils/litegraphUtil'
|
|
import { filterOutputNodes } from '@/utils/nodeFilterUtil'
|
|
|
|
export interface NodeSelectionState {
|
|
collapsed: boolean
|
|
pinned: boolean
|
|
bypassed: boolean
|
|
}
|
|
|
|
/**
|
|
* Centralized computed selection state + shared helper actions to avoid duplication
|
|
* between selection toolbox, context menus, and other UI affordances.
|
|
*/
|
|
export function useSelectionState() {
|
|
const canvasStore = useCanvasStore()
|
|
const nodeDefStore = useNodeDefStore()
|
|
const sidebarTabStore = useSidebarTabStore()
|
|
const nodeHelpStore = useNodeHelpStore()
|
|
const { id: nodeLibraryTabId } = useNodeLibrarySidebarTab()
|
|
|
|
const { selectedItems } = storeToRefs(canvasStore)
|
|
|
|
const selectedNodes = computed(() => {
|
|
return selectedItems.value.filter((i: unknown) =>
|
|
isLGraphNode(i)
|
|
) as LGraphNode[]
|
|
})
|
|
|
|
const nodeDef = computed(() => {
|
|
if (selectedNodes.value.length !== 1) return null
|
|
return nodeDefStore.fromLGraphNode(selectedNodes.value[0])
|
|
})
|
|
|
|
const hasAnySelection = computed(() => selectedItems.value.length > 0)
|
|
const hasSingleSelection = computed(() => selectedItems.value.length === 1)
|
|
const hasMultipleSelection = computed(() => selectedItems.value.length > 1)
|
|
|
|
const isSingleNode = computed(
|
|
() => hasSingleSelection.value && isLGraphNode(selectedItems.value[0])
|
|
)
|
|
const isSingleSubgraph = computed(
|
|
() =>
|
|
isSingleNode.value &&
|
|
(selectedItems.value[0] as LGraphNode)?.isSubgraphNode?.()
|
|
)
|
|
const isSingleImageNode = computed(
|
|
() =>
|
|
isSingleNode.value && isImageNode(selectedItems.value[0] as LGraphNode)
|
|
)
|
|
|
|
const hasSubgraphs = computed(() =>
|
|
selectedItems.value.some((i: unknown) => i instanceof SubgraphNode)
|
|
)
|
|
|
|
const hasAny3DNodeSelected = computed(() => {
|
|
const enable3DViewer = useSettingStore().get('Comfy.Load3D.3DViewerEnable')
|
|
return (
|
|
selectedNodes.value.length === 1 &&
|
|
selectedNodes.value.some(isLoad3dNode) &&
|
|
enable3DViewer
|
|
)
|
|
})
|
|
|
|
const hasImageNode = computed(() => isSingleImageNode.value)
|
|
const hasOutputNodesSelected = computed(
|
|
() => filterOutputNodes(selectedNodes.value).length > 0
|
|
)
|
|
|
|
// Helper function to compute selection flags (reused by both computed and function)
|
|
const computeSelectionStatesFromNodes = (
|
|
nodes: LGraphNode[]
|
|
): NodeSelectionState => {
|
|
if (!nodes.length)
|
|
return { collapsed: false, pinned: false, bypassed: false }
|
|
return {
|
|
collapsed: nodes.some((n) => n.flags?.collapsed),
|
|
pinned: nodes.some((n) => n.pinned),
|
|
bypassed: nodes.some((n) => n.mode === LGraphEventMode.BYPASS)
|
|
}
|
|
}
|
|
|
|
const selectedNodesStates = computed<NodeSelectionState>(() =>
|
|
computeSelectionStatesFromNodes(selectedNodes.value)
|
|
)
|
|
|
|
// On-demand computation (non-reactive) so callers can fetch fresh flags
|
|
const computeSelectionFlags = (): NodeSelectionState =>
|
|
computeSelectionStatesFromNodes(selectedNodes.value)
|
|
|
|
/** Toggle node help sidebar/panel for the single selected node (if any). */
|
|
const showNodeHelp = () => {
|
|
const def = nodeDef.value
|
|
if (!def) return
|
|
|
|
const isSidebarActive =
|
|
sidebarTabStore.activeSidebarTabId === nodeLibraryTabId
|
|
const currentHelpNode = nodeHelpStore.currentHelpNode
|
|
const isSameNodeHelpOpen =
|
|
isSidebarActive &&
|
|
nodeHelpStore.isHelpOpen &&
|
|
currentHelpNode?.nodePath === def.nodePath
|
|
|
|
if (isSameNodeHelpOpen) {
|
|
nodeHelpStore.closeHelp()
|
|
sidebarTabStore.toggleSidebarTab(nodeLibraryTabId)
|
|
return
|
|
}
|
|
|
|
if (!isSidebarActive) sidebarTabStore.toggleSidebarTab(nodeLibraryTabId)
|
|
nodeHelpStore.openHelp(def)
|
|
}
|
|
|
|
return {
|
|
selectedItems,
|
|
selectedNodes,
|
|
nodeDef,
|
|
showNodeHelp,
|
|
hasAny3DNodeSelected,
|
|
hasAnySelection,
|
|
hasSingleSelection,
|
|
hasMultipleSelection,
|
|
isSingleNode,
|
|
isSingleSubgraph,
|
|
isSingleImageNode,
|
|
hasSubgraphs,
|
|
hasImageNode,
|
|
hasOutputNodesSelected,
|
|
selectedNodesStates,
|
|
computeSelectionFlags
|
|
}
|
|
}
|