Files
ComfyUI_frontend/src/components/sidebar/tabs/nodeLibrary/NodeHelpPage.vue
2025-11-11 15:46:33 -05:00

351 lines
8.4 KiB
Vue

<template>
<div class="flex h-full flex-col overflow-auto bg-(--p-tree-background)">
<div
class="flex items-center border-b border-(--p-divider-color) px-3 py-2"
>
<Button
v-tooltip.bottom="$t('g.back')"
icon="pi pi-arrow-left"
text
severity="secondary"
@click="$emit('close')"
/>
<span class="ml-2 font-semibold">{{ node.display_name }}</span>
</div>
<div class="node-help-content mx-auto w-full grow p-4">
<ProgressSpinner
v-if="isLoading"
class="m-auto"
:aria-label="$t('g.loading')"
/>
<!-- Markdown fetched successfully -->
<div
v-else-if="!error"
ref="markdownContainer"
class="markdown-content"
v-html="renderedHelpHtml"
/>
<!-- Fallback: markdown not found or fetch error -->
<div v-else class="fallback-content space-y-6 text-sm">
<p v-if="node.description">
<strong>{{ $t('g.description') }}:</strong> {{ node.description }}
</p>
<div v-if="inputList.length">
<p>
<strong>{{ $t('nodeHelpPage.inputs') }}:</strong>
</p>
<!-- Using plain HTML table instead of DataTable for consistent styling with markdown content -->
<table>
<thead>
<tr>
<th>{{ $t('g.name') }}</th>
<th>{{ $t('nodeHelpPage.type') }}</th>
<th>{{ $t('g.description') }}</th>
</tr>
</thead>
<tbody>
<tr v-for="input in inputList" :key="input.name">
<td>
<code>{{ input.name }}</code>
</td>
<td>{{ input.type }}</td>
<td>{{ input.tooltip || '-' }}</td>
</tr>
</tbody>
</table>
</div>
<div v-if="outputList.length">
<p>
<strong>{{ $t('nodeHelpPage.outputs') }}:</strong>
</p>
<table>
<thead>
<tr>
<th>{{ $t('g.name') }}</th>
<th>{{ $t('nodeHelpPage.type') }}</th>
<th>{{ $t('g.description') }}</th>
</tr>
</thead>
<tbody>
<tr v-for="output in outputList" :key="output.name">
<td>
<code>{{ output.name }}</code>
</td>
<td>{{ output.type }}</td>
<td>{{ output.tooltip || '-' }}</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<!-- Image Gallery for markdown images -->
<ResultGallery
v-model:activeIndex="galleryActiveIndex"
:all-gallery-items="galleryItems"
/>
</template>
<script setup lang="ts">
import { storeToRefs } from 'pinia'
import Button from 'primevue/button'
import ProgressSpinner from 'primevue/progressspinner'
import { computed, nextTick, onMounted, ref, watch } from 'vue'
import type { ComfyNodeDefImpl } from '@/stores/nodeDefStore'
import { ResultItemImpl } from '@/stores/queueStore'
import { useNodeHelpStore } from '@/stores/workspace/nodeHelpStore'
import ResultGallery from '../queue/ResultGallery.vue'
// Custom class for external markdown images
class MarkdownImageItem extends ResultItemImpl {
private _externalUrl: string
constructor(externalUrl: string, filename: string, index: number) {
super({
filename,
subfolder: '',
type: 'output',
nodeId: `markdown-${index}`,
mediaType: 'images'
})
this._externalUrl = externalUrl
}
override get url(): string {
return this._externalUrl
}
override get urlWithTimestamp(): string {
return this._externalUrl
}
}
const { node } = defineProps<{ node: ComfyNodeDefImpl }>()
const nodeHelpStore = useNodeHelpStore()
const { renderedHelpHtml, isLoading, error } = storeToRefs(nodeHelpStore)
defineEmits<{
(e: 'close'): void
}>()
// Gallery state for image preview
const markdownContainer = ref<HTMLElement | null>(null)
const galleryItems = ref<MarkdownImageItem[]>([])
const galleryActiveIndex = ref(-1)
const inputList = computed(() =>
Object.values(node.inputs).map((spec) => ({
name: spec.name,
type: spec.type,
tooltip: spec.tooltip || ''
}))
)
const outputList = computed(() =>
node.outputs.map((spec) => ({
name: spec.name,
type: spec.type,
tooltip: spec.tooltip || ''
}))
)
// Track if we've already setup image preview to avoid re-setup
const imagePreviewSetup = ref(false)
// Function to setup image preview functionality
function setupImagePreview() {
if (!markdownContainer.value || imagePreviewSetup.value) return
const imgs = Array.from(markdownContainer.value.querySelectorAll('img'))
// Only setup if there are images
if (imgs.length === 0) return
// Update gallery items - create proper MarkdownImageItem instances
galleryItems.value = imgs.map((img, index) => {
// Extract filename from URL
const url = new URL(img.src, window.location.origin)
const filename = url.pathname.split('/').pop() || `image-${index}.jpg`
return new MarkdownImageItem(img.src, filename, index)
})
// Add click handlers to images
imgs.forEach((img, index) => {
img.style.cursor = 'zoom-in'
img.onclick = (e) => {
e.preventDefault()
galleryActiveIndex.value = index
}
})
imagePreviewSetup.value = true
}
// Reset setup flag when content changes
function resetImagePreviewSetup() {
imagePreviewSetup.value = false
galleryItems.value = []
galleryActiveIndex.value = -1
}
// Watch for changes in rendered HTML and setup image preview
watch(renderedHelpHtml, async () => {
resetImagePreviewSetup()
await nextTick()
setupImagePreview()
})
// Watch for loading state changes
watch([isLoading, error], () => {
resetImagePreviewSetup()
})
onMounted(async () => {
await nextTick()
setupImagePreview()
})
</script>
<style scoped>
@reference './../../../../assets/css/style.css';
.node-help-content :deep(:is(img, video)) {
@apply max-w-full h-auto block mb-4;
}
.markdown-content,
.fallback-content {
@apply text-sm;
}
.markdown-content :deep(h1),
.fallback-content h1 {
@apply text-[22px] font-bold mt-8 mb-4 first:mt-0;
}
.markdown-content :deep(h2),
.fallback-content h2 {
@apply text-[18px] font-bold mt-8 mb-4 first:mt-0;
}
.markdown-content :deep(h3),
.fallback-content h3 {
@apply text-[16px] font-bold mt-8 mb-4 first:mt-0;
}
.markdown-content :deep(h4),
.markdown-content :deep(h5),
.markdown-content :deep(h6),
.fallback-content h4,
.fallback-content h5,
.fallback-content h6 {
@apply mt-8 mb-4 first:mt-0;
}
.markdown-content :deep(td),
.fallback-content td {
color: var(--drag-text);
}
.markdown-content :deep(a),
.fallback-content a {
color: var(--drag-text);
text-decoration: underline;
}
.markdown-content :deep(th),
.fallback-content th {
color: var(--fg-color);
}
.markdown-content :deep(ul),
.markdown-content :deep(ol),
.fallback-content ul,
.fallback-content ol {
@apply pl-8 my-2;
}
.markdown-content :deep(ul ul),
.markdown-content :deep(ol ol),
.markdown-content :deep(ul ol),
.markdown-content :deep(ol ul),
.fallback-content ul ul,
.fallback-content ol ol,
.fallback-content ul ol,
.fallback-content ol ul {
@apply pl-6 my-2;
}
.markdown-content :deep(li),
.fallback-content li {
@apply my-2;
}
.markdown-content :deep(*:first-child),
.fallback-content > *:first-child {
@apply mt-0;
}
.markdown-content :deep(code),
.fallback-content code {
color: var(--code-text-color);
background-color: var(--code-bg-color);
@apply rounded px-1.5 py-0.5;
}
.markdown-content :deep(table),
.fallback-content table {
@apply w-full border-collapse;
}
.markdown-content :deep(th),
.markdown-content :deep(td),
.fallback-content th,
.fallback-content td {
@apply px-2 py-2;
}
.markdown-content :deep(tr),
.fallback-content tr {
border-bottom: 1px solid var(--content-bg);
}
.markdown-content :deep(tr:last-child),
.fallback-content tr:last-child {
border-bottom: none;
}
.markdown-content :deep(thead),
.fallback-content thead {
border-bottom: 1px solid var(--p-text-color);
}
.markdown-content :deep(pre),
.fallback-content pre {
@apply rounded p-4 my-4 overflow-x-auto;
background-color: var(--code-block-bg-color);
code {
@apply bg-transparent p-0;
color: var(--p-text-color);
}
}
/* Add hover effect for clickable images */
.markdown-content :deep(img) {
transition: opacity 0.2s ease;
}
.markdown-content :deep(img:hover) {
opacity: 0.8;
}
</style>