LCOV - code coverage report
Current view: top level - src/renderer/extensions/propertiesPanel - PropertiesPanel.vue Coverage Total Hit
Test: ComfyUI E2E Coverage Lines: 96.5 % 86 83
Test Date: 2026-11-17 04:17:53

            Line data    Source code
       1              : <script setup lang="ts">
       2              : import { storeToRefs } from 'pinia'
       3              : import { computed, provide, ref, watchEffect } from 'vue'
       4              : import { useI18n } from 'vue-i18n'
       5              : 
       6              : import EditableText from '@comfyorg/design-system/common/EditableText'
       7              : import Tab from '@comfyorg/design-system/tab/Tab'
       8              : import TabList from '@comfyorg/design-system/tab/TabList'
       9              : import Button from '@comfyorg/design-system/button/Button'
      10              : import { useFocusNode } from '@/composables/canvas/useFocusNode'
      11              : import { SubgraphNode } from '@/lib/litegraph/src/litegraph'
      12              : import type { LGraphNode } from '@/lib/litegraph/src/litegraph'
      13              : import { useSettingStore } from '@/platform/settings/settingStore'
      14              : import { useTelemetry } from '@comfyorg/telemetry'
      15              : import { useWorkflowStore } from '@/platform/workflow/management/stores/workflowStore'
      16              : import { useCanvasStore } from '@/renderer/core/canvas/canvasStore'
      17              : import { usePropertiesPanelStore } from '@/renderer/extensions/propertiesPanel/propertiesPanelStore'
      18              : import type { PropertiesPanelTab } from '@/renderer/extensions/propertiesPanel/propertiesPanelStore'
      19              : import { resolveNodeDisplayName } from '@/utils/nodeTitleUtil'
      20              : import { cn } from '@comfyorg/tailwind-utils'
      21              : 
      22              : import TabInfo from './info/TabInfo.vue'
      23              : import TabGlobalParameters from './parameters/TabGlobalParameters.vue'
      24              : import TabNodes from './parameters/TabNodes.vue'
      25              : import TabNormalInputs from './parameters/TabNormalInputs.vue'
      26              : import TabSubgraphInputs from './parameters/TabSubgraphInputs.vue'
      27              : import { trackPropertiesPanelTabOpened } from './propertiesPanelTabTelemetry'
      28              : import TabGlobalSettings from './settings/TabGlobalSettings.vue'
      29              : import TabSettings from './settings/TabSettings.vue'
      30              : import { findParentGroup, GetNodeParentGroupKey } from './parentGroup'
      31              : import { useFlatAndCategorizeSelectedItems } from './selectedItems'
      32              : import { useAskAgentAboutIssues } from '@/workbench/extensions/agent/composables/agent/useAskAgentAboutIssues'
      33              : import SubgraphEditor from './subgraph/SubgraphEditor.vue'
      34              : import TabErrors from '@/platform/workflowErrors/panel/TabErrors.vue'
      35              : import { useErrorsTabIndicator } from '@/platform/workflowErrors/panel/useErrorsTabIndicator'
      36              : import { AskAgentPortKey } from '@/platform/workflowErrors/askAgentPort'
      37              : import { WorkflowErrorManagerKey } from '@/platform/workflowErrors/workflowErrorManager'
      38              : import { createWorkflowErrorManager } from '@/platform/customNodes/manager/composables/workflowErrorManager'
      39              : 
      40         2355 : provide(WorkflowErrorManagerKey, createWorkflowErrorManager())
      41          201 : provide(AskAgentPortKey, useAskAgentAboutIssues())
      42          201 : const canvasStore = useCanvasStore()
      43          201 : const workflowStore = useWorkflowStore()
      44          201 : const propertiesPanelStore = usePropertiesPanelStore()
      45          201 : const settingStore = useSettingStore()
      46          201 : const { t } = useI18n()
      47              : 
      48          201 : const { focusNode } = useFocusNode()
      49              : 
      50          201 : const { selectedItems: directlySelectedItems } = storeToRefs(canvasStore)
      51          201 : const { activeTab, isEditingSubgraph } = storeToRefs(propertiesPanelStore)
      52              : 
      53          201 : const sidebarLocation = computed<'left' | 'right'>(() =>
      54              :   settingStore.get('Comfy.Sidebar.Location')
      55              : )
      56              : 
      57              : // Panel is on the left when sidebar is on the right, and vice versa
      58          201 : const panelIcon = computed(() =>
      59              :   sidebarLocation.value === 'right'
      60              :     ? 'icon-[lucide--panel-left]'
      61              :     : 'icon-[lucide--panel-right]'
      62              : )
      63              : 
      64          201 : const { flattedItems, selectedNodes, selectedGroups, nodeToParentGroup } =
      65              :   useFlatAndCategorizeSelectedItems(directlySelectedItems)
      66              : 
      67          201 : const shouldShowGroupNames = computed(() => {
      68          126 :   return !(
      69              :     directlySelectedItems.value.length === 1 &&
      70              :     (selectedGroups.value.length === 1 || selectedNodes.value.length === 1)
      71              :   )
      72              : })
      73              : 
      74          201 : provide(GetNodeParentGroupKey, (node: LGraphNode) => {
      75          189 :   if (!shouldShowGroupNames.value) return null
      76          189 :   return (
      77              :     nodeToParentGroup.value.get(node) ??
      78              :     findParentGroup(canvasStore.canvas?.graph?.groups ?? [], node)
      79              :   )
      80              : })
      81              : 
      82          201 : const hasSelection = computed(() => flattedItems.value.length > 0)
      83              : 
      84          201 : const selectedSingleNode = computed(() => {
      85          407 :   return selectedNodes.value.length === 1 && flattedItems.value.length === 1
      86              :     ? selectedNodes.value[0]
      87              :     : null
      88              : })
      89              : 
      90          201 : const isSingleSubgraphNode = computed(() => {
      91          333 :   return selectedSingleNode.value instanceof SubgraphNode
      92              : })
      93              : 
      94          201 : const workflowKey = computed(() => workflowStore.activeWorkflow?.path ?? '')
      95              : 
      96          201 : const selectedNodesKey = computed(() => {
      97           96 :   const nodeIds = selectedNodes.value.map((n) => n.id).join(',')
      98           96 :   const groupIds = selectedGroups.value.map((g) => g.id).join(',')
      99           96 :   return `${workflowKey.value}|${nodeIds}|${groupIds}`
     100              : })
     101              : 
     102          201 : const singleSubgraphKey = computed(() =>
     103              :   selectedSingleNode.value
     104              :     ? `${workflowKey.value}:${selectedSingleNode.value.id}`
     105              :     : ''
     106              : )
     107              : 
     108            6 : function closePanel() {
     109            6 :   useTelemetry()?.trackUiButtonClicked({
     110              :     button_id: 'right_side_panel_closed',
     111              :     element_group: 'right_side_panel'
     112              :   })
     113            6 :   propertiesPanelStore.closePanel()
     114              : }
     115              : 
     116           42 : function handleTabChange(newTab: PropertiesPanelTab) {
     117           42 :   trackPropertiesPanelTabOpened(newTab)
     118           42 :   propertiesPanelStore.openPanel(newTab)
     119              : }
     120              : 
     121              : type PropertiesPanelTabList = Array<{
     122              :   label: () => string
     123              :   value: PropertiesPanelTab
     124              :   icon?: {
     125              :     className: string
     126              :     label: () => string
     127              :   }
     128              : }>
     129              : 
     130          201 : const { hasRelevantErrors, hasPendingErrorScanSelected, hasBlockingError } =
     131              :   useErrorsTabIndicator({
     132              :     hasSelection,
     133              :     selectedNodes,
     134              :     currentGraph: () => canvasStore.currentGraph
     135              :   })
     136              : 
     137          201 : const tabs = computed<PropertiesPanelTabList>(() => {
     138          420 :   const list: PropertiesPanelTabList = []
     139              : 
     140          420 :   if (
     141              :     settingStore.get('Comfy.RightSidePanel.ShowErrorsTab') &&
     142              :     (hasRelevantErrors.value ||
     143              :       (activeTab.value === 'errors' && hasPendingErrorScanSelected.value))
     144              :   ) {
     145          115 :     list.push({
     146              :       label: () => t('rightSidePanel.errors'),
     147              :       value: 'errors',
     148              :       icon: hasRelevantErrors.value
     149              :         ? {
     150              :             className: cn(
     151              :               'ml-1',
     152              :               hasBlockingError.value
     153              :                 ? 'icon-[lucide--octagon-alert] bg-destructive'
     154              :                 : 'icon-[lucide--triangle-alert] bg-warning'
     155              :             ),
     156              :             label: () =>
     157              :               t(
     158              :                 hasBlockingError.value
     159              :                   ? 'rightSidePanel.severityErrorLabel'
     160              :                   : 'rightSidePanel.severitySetupLabel'
     161              :               )
     162              :           }
     163              :         : undefined
     164              :     })
     165              :   }
     166              : 
     167          420 :   list.push({
     168              :     label: () =>
     169              :       flattedItems.value.length > 1
     170              :         ? t('rightSidePanel.nodes')
     171              :         : t('rightSidePanel.parameters'),
     172              :     value: 'parameters'
     173              :   })
     174              : 
     175          420 :   if (!hasSelection.value) {
     176          256 :     list.push({
     177              :       label: () => t('rightSidePanel.nodes'),
     178              :       value: 'nodes'
     179              :     })
     180              :   }
     181              : 
     182          420 :   if (hasSelection.value) {
     183          164 :     if (selectedSingleNode.value && !isSingleSubgraphNode.value) {
     184          104 :       list.push({
     185              :         label: () => t('rightSidePanel.info'),
     186              :         value: 'info'
     187              :       })
     188              :     }
     189              :   }
     190              : 
     191          420 :   list.push({
     192              :     label: () =>
     193              :       hasSelection.value
     194              :         ? t('g.settings')
     195              :         : t('rightSidePanel.globalSettings.title'),
     196              :     value: 'settings'
     197              :   })
     198              : 
     199          420 :   return list
     200              : })
     201              : 
     202          443 : function isActiveTabAvailable() {
     203          443 :   return (
     204              :     tabs.value.some((tab) => tab.value === activeTab.value) ||
     205              :     (activeTab.value === 'subgraph' && isSingleSubgraphNode.value)
     206              :   )
     207              : }
     208              : 
     209          201 : watchEffect(() => {
     210          443 :   if (!isActiveTabAvailable()) {
     211           42 :     propertiesPanelStore.openPanel(tabs.value[0].value)
     212              :   }
     213              : })
     214              : 
     215          610 : function resolveTitle() {
     216          610 :   const items = flattedItems.value
     217          610 :   const nodes = selectedNodes.value
     218          610 :   const groups = selectedGroups.value
     219              : 
     220          610 :   if (items.length === 0) {
     221          423 :     return t('rightSidePanel.workflowOverview')
     222              :   }
     223          257 :   if (directlySelectedItems.value.length === 1) {
     224          154 :     if (groups.length === 1) {
     225            0 :       return groups[0].title || t('rightSidePanel.fallbackGroupTitle')
     226              :     }
     227          154 :     if (nodes.length === 1) {
     228          154 :       const fallbackNodeTitle = t('rightSidePanel.fallbackNodeTitle')
     229          154 :       return resolveNodeDisplayName(nodes[0], {
     230              :         emptyLabel: fallbackNodeTitle,
     231              :         untitledLabel: fallbackNodeTitle
     232              :       })
     233              :     }
     234              :   }
     235           33 :   return t('rightSidePanel.title', { count: items.length })
     236              : }
     237              : 
     238          201 : const panelTitle = ref(resolveTitle())
     239          201 : watchEffect(() => (panelTitle.value = resolveTitle()))
     240              : 
     241          201 : const isEditing = ref(false)
     242              : 
     243          201 : const allowTitleEdit = computed(() => {
     244          407 :   return (
     245              :     directlySelectedItems.value.length === 1 &&
     246              :     (selectedGroups.value.length === 1 || selectedNodes.value.length === 1)
     247              :   )
     248              : })
     249              : 
     250            2 : function handleTitleEdit(newTitle: string) {
     251            2 :   isEditing.value = false
     252              : 
     253            2 :   const trimmedTitle = newTitle.trim()
     254            2 :   if (!trimmedTitle) return
     255              : 
     256            2 :   const node = selectedGroups.value[0] || selectedNodes.value[0]
     257            2 :   if (!node) return
     258              : 
     259            2 :   if (trimmedTitle === node.title) return
     260              : 
     261            2 :   node.title = trimmedTitle
     262            2 :   panelTitle.value = trimmedTitle
     263            2 :   canvasStore.canvas?.setDirty(true, true)
     264              : }
     265              : 
     266            0 : function handleTitleCancel() {
     267            0 :   isEditing.value = false
     268              : }
     269          201 : </script>
     270              : 
     271              : <template>
     272          480 :   <div
     273              :     data-testid="properties-panel"
     274              :     class="flex size-full flex-col bg-background"
     275              :   >
     276              :     <!-- Panel Header -->
     277              :     <section class="pt-1">
     278              :       <div class="flex items-center justify-between pr-3 pl-4">
     279              :         <h3 class="my-3.5 line-clamp-2 cursor-default text-sm font-semibold">
     280              :           <template v-if="allowTitleEdit">
     281              :             <EditableText
     282              :               :model-value="panelTitle"
     283              :               :is-editing="isEditing"
     284              :               :input-attrs="{ 'data-testid': 'node-title-input' }"
     285              :               class="cursor-text"
     286              :               @edit="handleTitleEdit"
     287              :               @cancel="handleTitleCancel"
     288              :               @click="isEditing = true"
     289              :             />
     290              :             <Button
     291              :               v-if="!isEditing"
     292              :               variant="link"
     293              :               size="unset"
     294              :               :aria-label="t('rightSidePanel.editTitle')"
     295              :               class="top-[2px] ml-2 shrink-0"
     296              :               @click="isEditing = true"
     297              :             >
     298              :               <i aria-hidden="true" class="icon-[lucide--pencil]" />
     299              :             </Button>
     300              :           </template>
     301              :           <template v-else>
     302              :             {{ panelTitle }}
     303              :           </template>
     304              :         </h3>
     305              : 
     306              :         <div class="flex gap-2">
     307              :           <Button
     308              :             v-if="isSingleSubgraphNode"
     309              :             variant="secondary"
     310              :             size="icon"
     311              :             data-testid="subgraph-editor-toggle"
     312              :             :aria-label="t('rightSidePanel.editSubgraph')"
     313              :             :class="cn(isEditingSubgraph && 'bg-muted')"
     314              :             @click="
     315              :               propertiesPanelStore.openPanel(
     316              :                 isEditingSubgraph ? 'parameters' : 'subgraph'
     317              :               )
     318              :             "
     319              :           >
     320              :             <i class="icon-[lucide--settings-2]" />
     321              :           </Button>
     322              :           <Button
     323              :             variant="secondary"
     324              :             size="icon"
     325              :             :aria-pressed="propertiesPanelStore.isOpen"
     326              :             :aria-label="t('rightSidePanel.togglePanel')"
     327              :             @click="closePanel"
     328              :           >
     329              :             <i :class="panelIcon" />
     330              :           </Button>
     331              :         </div>
     332              :       </div>
     333              :       <nav class="overflow-x-auto px-4 pt-1 pb-2">
     334              :         <TabList :model-value="activeTab" @update:model-value="handleTabChange">
     335         1360 :           <Tab
     336              :             v-for="tab in tabs"
     337              :             :key="tab.value"
     338              :             class="px-2 py-1 font-inter active:scale-95"
     339              :             :value="tab.value"
     340              :             :data-testid="`panel-tab-${tab.value}`"
     341              :           >
     342              :             {{ tab.label() }}
     343              :             <i
     344              :               v-if="tab.icon"
     345              :               role="img"
     346              :               :aria-label="tab.icon.label()"
     347              :               data-testid="panel-tab-icon"
     348              :               :class="tab.icon.className"
     349              :             />
     350              :           </Tab>
     351              :         </TabList>
     352              :       </nav>
     353              :     </section>
     354              : 
     355              :     <!-- Panel Content -->
     356              :     <div class="flex-1 scrollbar-thin overflow-y-auto">
     357              :       <TabErrors
     358              :         v-if="activeTab === 'errors'"
     359              :         :selected-items="directlySelectedItems"
     360              :         @locate-node="focusNode"
     361              :       />
     362              :       <template v-else-if="!hasSelection">
     363              :         <TabGlobalParameters
     364              :           v-if="activeTab === 'parameters'"
     365              :           :key="workflowKey"
     366              :         />
     367              :         <TabNodes v-else-if="activeTab === 'nodes'" :key="workflowKey" />
     368              :         <TabGlobalSettings v-else-if="activeTab === 'settings'" />
     369              :       </template>
     370              :       <SubgraphEditor
     371              :         v-else-if="isSingleSubgraphNode && isEditingSubgraph"
     372              :         :key="singleSubgraphKey"
     373              :         :node="selectedSingleNode"
     374              :       />
     375              :       <template v-else>
     376              :         <TabSubgraphInputs
     377              :           v-if="activeTab === 'parameters' && isSingleSubgraphNode"
     378              :           :key="singleSubgraphKey"
     379              :           :node="selectedSingleNode as SubgraphNode"
     380              :         />
     381              :         <TabNormalInputs
     382              :           v-else-if="activeTab === 'parameters'"
     383              :           :key="selectedNodesKey"
     384              :           :nodes="selectedNodes"
     385              :           :must-show-node-title="selectedGroups.length > 0"
     386              :         />
     387              :         <TabInfo v-else-if="activeTab === 'info'" :nodes="selectedNodes" />
     388              :         <TabSettings
     389              :           v-else-if="activeTab === 'settings'"
     390              :           :nodes="flattedItems"
     391              :         />
     392              :       </template>
     393              :     </div>
     394              :   </div>
     395              : </template>
        

Generated by: LCOV version 2.0-1