Line data Source code
1 : <template>
2 : <div
3 723 : v-if="items.length"
4 : class="image-preview group relative flex size-full min-w-16 flex-col justify-center px-2"
5 : :style="{ minHeight: `${IMAGE_PREVIEW_CONTENT_MIN_HEIGHT}px` }"
6 : @keydown="handleKeyDown"
7 : >
8 : <!-- Grid View -->
9 : <div
10 : v-if="viewMode === 'grid'"
11 : ref="gridEl"
12 : data-testid="image-grid"
13 : class="relative grid w-full flex-1 gap-1 rounded-sm p-1 contain-size"
14 : :style="{ gridTemplateColumns: `repeat(${gridCols}, 1fr)` }"
15 : >
16 1116 : <Button
17 : v-for="(url, index) in gridUrls"
18 : :key="index"
19 : size="unset"
20 : class="overflow-hidden rounded-none p-0 ring-border hover:ring-1 focus-visible:ring-2"
21 : :aria-label="
22 : $t('g.viewImageOfTotal', { index: index + 1, total: items.length })
23 : "
24 : @click="openImageInGallery(index)"
25 : >
26 : <div
27 : v-if="url && !failedHdrPreviews[index]"
28 : class="pointer-events-none relative size-full"
29 : >
30 : <img
31 : :src="url"
32 : :alt="`${$t('g.galleryThumbnail')} ${index + 1}`"
33 : draggable="false"
34 : decoding="async"
35 : class="size-full object-contain"
36 : @load="updateAspectRatio($event, index)"
37 : @error="failedHdrPreviews[index] = isHdrResult(items[index])"
38 : />
39 : </div>
40 : <div
41 : v-else
42 : class="flex size-full flex-col items-center justify-center gap-1 text-foreground"
43 : >
44 : <i class="icon-[lucide--sun] size-6" />
45 : </div>
46 : </Button>
47 : <div
48 : v-if="canExportOutputs"
49 : class="invisible absolute top-2 right-2 group-focus-within:visible group-hover:visible"
50 : >
51 : <Button
52 : variant="inverted"
53 : size="icon"
54 : class="shadow-md"
55 : :title="$t('g.downloadImages')"
56 : :aria-label="$t('g.downloadImages')"
57 : @click="handleExportOutputs"
58 : >
59 : <i class="icon-[lucide--folder-down]" />
60 : </Button>
61 : </div>
62 : </div>
63 :
64 : <!-- Gallery View (Image Wrapper) -->
65 : <div
66 : v-if="viewMode === 'gallery'"
67 : ref="galleryPanelEl"
68 : class="group/panel relative flex min-h-0 w-full flex-1 cursor-pointer overflow-hidden rounded-sm"
69 : tabindex="0"
70 : role="region"
71 : :aria-roledescription="$t('g.imageGallery')"
72 : :aria-label="$t('g.imagePreview')"
73 : :aria-busy="showLoader"
74 : >
75 : <!-- Error State -->
76 : <div
77 : v-if="imageError"
78 : role="alert"
79 : class="flex size-full flex-1 flex-col items-center justify-around self-center py-8 text-center text-foreground"
80 : >
81 : <i class="mb-2 icon-[lucide--image-off] size-12" />
82 : <p class="text-sm">
83 : {{ $t('g.imageFailedToLoad') }}
84 : </p>
85 : <p class="mt-1 text-xs">
86 : {{ items[currentIndex].filename }}
87 : </p>
88 : </div>
89 : <!-- Loading State -->
90 : <div
91 : v-if="
92 : showLoader &&
93 : !imageError &&
94 : displayUrls[currentIndex] &&
95 : !failedHdrPreviews[currentIndex]
96 : "
97 : role="status"
98 : :aria-label="t('g.loading')"
99 : class="size-full"
100 : >
101 : <Skeleton class="size-full rounded-sm" />
102 : </div>
103 : <img
104 : v-if="
105 : !imageError &&
106 : displayUrls[currentIndex] &&
107 : !failedHdrPreviews[currentIndex]
108 : "
109 : :key="imageKeys[currentIndex]"
110 : data-testid="main-image"
111 : :src="mainImageSrc"
112 : :data-file-url="isHdr ? resultItemUrl(items[currentIndex]) : undefined"
113 : :data-full-src="isDownscaled ? currentImageUrl : undefined"
114 : decoding="async"
115 : :alt="
116 : t('g.viewImageOfTotal', {
117 : index: currentIndex + 1,
118 : total: items.length
119 : })
120 : "
121 : draggable="false"
122 : class="pointer-events-none absolute inset-0 block size-full object-contain"
123 : @load="handleImageLoad"
124 : @error="mainImageSrc && handleImageError(displayUrls[currentIndex])"
125 : />
126 : <button
127 : v-else-if="!imageError && isHdr"
128 : type="button"
129 : data-testid="hdr-open-button"
130 : class="absolute inset-0 flex cursor-pointer flex-col items-center justify-center gap-3 border-0 bg-transparent text-foreground"
131 : @click="openHdrViewer(resultItemUrl(items[currentIndex]))"
132 : >
133 : <i class="icon-[lucide--sun] size-12" />
134 : <span class="text-sm">{{ $t('hdrViewer.hdrImage') }}</span>
135 : <span
136 : class="rounded-md bg-foreground px-3 py-1.5 text-sm text-background"
137 : >
138 : {{ $t('hdrViewer.openInHdrViewer') }}
139 : </span>
140 : </button>
141 : <!-- Floating Action Buttons (appear on hover and focus) -->
142 : <div
143 : class="actions invisible absolute top-2 right-2 flex gap-1 group-focus-within/panel:visible group-hover/panel:visible"
144 : >
145 : <!-- Mask/Edit Button -->
146 : <Button
147 : v-if="!hasMultipleImages && !imageError && !isHdr"
148 : variant="inverted"
149 : size="icon"
150 : class="shadow-md"
151 : :title="$t('g.editOrMaskImage')"
152 : :aria-label="$t('g.editOrMaskImage')"
153 : @click="handleEditMask"
154 : >
155 : <i-comfy:mask class="size-4" />
156 : </Button>
157 :
158 : <Button
159 : v-if="!imageError && isHdr"
160 : variant="inverted"
161 : size="icon"
162 : class="shadow-md"
163 : :title="$t('hdrViewer.openInHdrViewer')"
164 : :aria-label="$t('hdrViewer.openInHdrViewer')"
165 : @click="openHdrViewer(resultItemUrl(items[currentIndex]))"
166 : >
167 : <i class="icon-[lucide--sun]" />
168 : </Button>
169 :
170 : <!-- Layer Editor Button -->
171 : <Button
172 : v-if="hasMultipleImages && !imageError"
173 : variant="inverted"
174 : size="icon"
175 : class="shadow-md"
176 : :title="$t('g.openLayerEditor')"
177 : :aria-label="$t('g.openLayerEditor')"
178 : @click="handleOpenLayerEditor"
179 : >
180 : <i class="icon-[lucide--layers]" />
181 : </Button>
182 :
183 : <!-- Download Button -->
184 : <Button
185 : v-if="!imageError"
186 : variant="inverted"
187 : size="icon"
188 : class="shadow-md"
189 : :title="$t('g.downloadImage')"
190 : :aria-label="$t('g.downloadImage')"
191 : @click="handleDownload"
192 : >
193 : <i class="icon-[lucide--download]" />
194 : </Button>
195 :
196 : <!-- Back to Grid Button -->
197 : <Button
198 : v-if="hasMultipleImages"
199 : variant="inverted"
200 : size="icon"
201 : class="shadow-md"
202 : :title="$t('g.viewGrid')"
203 : :aria-label="$t('g.viewGrid')"
204 : @click="viewMode = 'grid'"
205 : >
206 : <i class="icon-[lucide--layout-grid]" />
207 : </Button>
208 : </div>
209 : </div>
210 :
211 : <!-- Image Dimensions (gallery mode only) -->
212 : <div
213 : v-if="
214 : viewMode === 'gallery' &&
215 : (!isHdr ||
216 : (displayUrls[currentIndex] && !failedHdrPreviews[currentIndex]))
217 : "
218 : class="pt-2 text-center text-foreground"
219 : >
220 : <span
221 : v-if="imageError"
222 : class="text-destructive"
223 : data-testid="error-loading-image"
224 : >
225 : {{ $t('g.errorLoadingImage') }}
226 : </span>
227 : <span v-else-if="showLoader"> {{ $t('g.loading') }}... </span>
228 : <span v-else>
229 : {{ actualDimensions || $t('g.calculatingDimensions') }}
230 : </span>
231 : </div>
232 :
233 : <!-- Multiple Images Navigation (gallery mode only) -->
234 : <div
235 : v-if="viewMode === 'gallery' && hasMultipleImages"
236 : class="flex flex-wrap items-center justify-center gap-1 pt-4"
237 : >
238 : <!-- Back to Grid button -->
239 : <button
240 : class="mr-1 flex cursor-pointer items-center justify-center rounded-sm border-0 bg-transparent p-0.5 text-foreground/50 transition-colors hover:text-foreground"
241 : :title="$t('g.viewGrid')"
242 : :aria-label="$t('g.viewGrid')"
243 : @click="viewMode = 'grid'"
244 : >
245 : <i class="icon-[lucide--layout-grid] size-3.5" />
246 : </button>
247 :
248 : <!-- Navigation Dots -->
249 14 : <button
250 : v-for="(_, index) in displayUrls"
251 : :key="index"
252 : :class="getNavigationDotClass(index)"
253 : :aria-current="index === currentIndex ? 'true' : undefined"
254 : :aria-label="
255 : $t('g.viewImageOfTotal', {
256 : index: index + 1,
257 : total: displayUrls.length
258 : })
259 : "
260 : @click="setCurrentIndex(index)"
261 : />
262 : </div>
263 : </div>
264 : </template>
265 :
266 : <script setup lang="ts">
267 : import {
268 : computedAsync,
269 : useElementSize,
270 : useObjectUrl,
271 : useTimeoutFn
272 : } from '@vueuse/core'
273 : import {
274 : computed,
275 : nextTick,
276 : onBeforeUnmount,
277 : ref,
278 : useTemplateRef,
279 : watch
280 : } from 'vue'
281 : import { useI18n } from 'vue-i18n'
282 :
283 : import { downloadFile } from '@/base/common/downloadUtil'
284 : import { useToast } from '@/components/ui/toast/toastStore'
285 : import Button from '@comfyorg/design-system/button/Button'
286 : import Skeleton from '@comfyorg/design-system/skeleton/Skeleton'
287 : import { useMaskEditor } from '@/renderer/extensions/maskEditor/composables/useMaskEditor'
288 : import { useNodeOutputsExport } from '@/platform/assets/composables/useNodeOutputsExport'
289 : import { useSettingStore } from '@/platform/settings/settingStore'
290 : import { useTelemetry } from '@comfyorg/telemetry'
291 : import { describeImageLoadFailure } from '@/platform/telemetry/imageFailureDiagnostics'
292 : import { openHdrViewer } from '@/services/hdrViewerService'
293 : import { useNodeOutputStore } from '@/stores/nodeOutputStore'
294 : import type { NodeId } from '@comfyorg/graph-model/nodeId'
295 : import { getGridThumbnailUrl } from '@/utils/imageUtil'
296 : import { resolveNode } from '@/utils/litegraphUtil'
297 : import { isHdrResult } from '@/utils/resultItem'
298 : import type { AugmentedResultItem } from '@/utils/resultItem'
299 : import { resultItemPreviewUrl, resultItemUrl } from '@/utils/resultItemUrl'
300 : import { cn } from '@comfyorg/tailwind-utils'
301 :
302 : import { useTransformState } from '@/renderer/core/layout/transform/useTransformState'
303 : import { useImagePreviewStore } from '@/renderer/extensions/vueNodes/stores/imagePreviewStore'
304 : import { IMAGE_PREVIEW_CONTENT_MIN_HEIGHT } from './imagePreviewLayout'
305 :
306 2355 : const DISPLAY_MAX_EDGE = 1024
307 2355 : const PRELOAD_MIN_SCALE = 1
308 :
309 : interface ImagePreviewProps {
310 : readonly items: readonly AugmentedResultItem[]
311 : readonly nodeId?: NodeId
312 : readonly fullResolution?: boolean
313 : }
314 :
315 : const {
316 : items,
317 : nodeId,
318 : fullResolution = false
319 : } = defineProps<ImagePreviewProps>()
320 :
321 179 : const { t } = useI18n()
322 179 : const maskEditor = useMaskEditor()
323 179 : const nodeOutputStore = useNodeOutputStore()
324 179 : const { getDisplayImage } = useImagePreviewStore()
325 179 : const settingStore = useSettingStore()
326 179 : const { hasMultipleOutputs, showOutputsExportDialog } = useNodeOutputsExport()
327 179 : const toast = useToast()
328 :
329 : type ViewMode = 'gallery' | 'grid'
330 :
331 424 : function defaultViewMode(items: readonly unknown[]): ViewMode {
332 424 : return items.length > 1 ? 'grid' : 'gallery'
333 : }
334 :
335 179 : const { width: gridWidth, height: gridHeight } = useElementSize(
336 : useTemplateRef('gridEl')
337 : )
338 :
339 179 : const currentIndex = ref(0)
340 179 : const viewMode = ref<ViewMode>(defaultViewMode(items))
341 179 : const galleryPanelEl = ref<HTMLDivElement>()
342 179 : const actualDimensions = ref<string | null>(null)
343 179 : const imageError = ref(false)
344 179 : const showLoader = ref(false)
345 179 : const imageAspectRatio = ref(1)
346 179 : const failedHdrPreviews = ref<boolean[]>([])
347 :
348 179 : const { start: startDelayedLoader, stop: stopDelayedLoader } = useTimeoutFn(
349 : () => {
350 28 : showLoader.value = true
351 : },
352 : 250,
353 : // Make sure it doesnt run on component mount
354 : { immediate: false }
355 : )
356 :
357 179 : const displayUrls = computed(() =>
358 : items.map((item) => resultItemPreviewUrl(item, { fullRes: true }))
359 : )
360 179 : const imageKeys = computed(() =>
361 : items.map(
362 : (item, index) => `${resultItemUrl(item)}\n${displayUrls.value[index]}`
363 : )
364 : )
365 179 : const gridUrls = computed(() =>
366 : items.map((item) => getGridThumbnailUrl(resultItemPreviewUrl(item)))
367 : )
368 179 : const isHdr = computed(
369 : () => items.length > 0 && isHdrResult(items[currentIndex.value])
370 : )
371 179 : const hasMultipleImages = computed(() => items.length > 1)
372 179 : const downscaleEnabled = computed(() =>
373 : settingStore.get('Comfy.Node.DownscaleImagePreviews')
374 : )
375 179 : const showFullResolution = computed(
376 : () => !downscaleEnabled.value || (fullResolution && !hasMultipleImages.value)
377 : )
378 :
379 179 : const currentImageUrl = computed(
380 : () => displayUrls.value[currentIndex.value] ?? ''
381 : )
382 179 : const displayImage = computedAsync(async () => {
383 249 : const source = currentImageUrl.value
384 249 : if (
385 : viewMode.value !== 'gallery' ||
386 : !source ||
387 : isHdr.value ||
388 : showFullResolution.value
389 : )
390 9 : return undefined
391 240 : return getDisplayImage(source, DISPLAY_MAX_EDGE)
392 : })
393 179 : const currentDisplayImage = computed(() =>
394 : displayImage.value?.source === currentImageUrl.value
395 : ? displayImage.value
396 : : undefined
397 : )
398 179 : const displayImageUrl = useObjectUrl(() => currentDisplayImage.value?.blob)
399 179 : const mainImageSrc = computed(() =>
400 : isHdr.value || showFullResolution.value
401 : ? currentImageUrl.value
402 : : currentDisplayImage.value?.blob
403 : ? displayImageUrl.value
404 : : currentDisplayImage.value?.source
405 : )
406 179 : const isDownscaled = computed(
407 : () => !showFullResolution.value && !!currentDisplayImage.value?.blob
408 : )
409 179 : const canExportOutputs = computed(() => {
410 4 : const node = nodeId ? resolveNode(nodeId) : undefined
411 4 : return !!node && hasMultipleOutputs(node)
412 : })
413 179 : const gridCols = computed(() => {
414 22 : const bias = gridWidth.value / gridHeight.value / imageAspectRatio.value
415 22 : return Math.max(Math.round(Math.sqrt(items.length * bias)), 1)
416 : })
417 :
418 179 : const { camera } = useTransformState()
419 179 : const isZoomedIn = computed(() => camera.z >= PRELOAD_MIN_SCALE)
420 179 : const preloadUrls = computed(() => {
421 182 : if (!downscaleEnabled.value || !hasMultipleImages.value || !isZoomedIn.value)
422 176 : return []
423 6 : const count = items.length
424 : const candidates =
425 : viewMode.value === 'grid'
426 : ? items
427 : : [
428 : items[(currentIndex.value + 1) % count],
429 : items[(currentIndex.value - 1 + count) % count]
430 : ]
431 182 : return candidates
432 : .filter((item) => !isHdrResult(item))
433 : .map((item) => resultItemPreviewUrl(item, { fullRes: true }))
434 : })
435 179 : watch(
436 : preloadUrls,
437 : (urls) => {
438 274 : for (const url of urls) void getDisplayImage(url, DISPLAY_MAX_EDGE)
439 : },
440 : { immediate: true }
441 : )
442 :
443 179 : watch(
444 : imageKeys,
445 : (newUrls, oldUrls) => {
446 : const urlsChanged =
447 : !oldUrls ||
448 : newUrls.length !== oldUrls.length ||
449 : newUrls.some((url, i) => url !== oldUrls[i])
450 260 : if (!urlsChanged) return
451 :
452 260 : if (currentIndex.value >= newUrls.length) currentIndex.value = 0
453 245 : actualDimensions.value = null
454 245 : viewMode.value = defaultViewMode(newUrls)
455 245 : imageError.value = false
456 245 : failedHdrPreviews.value = []
457 245 : if (newUrls.length > 0) startDelayedLoader()
458 : },
459 : { immediate: true }
460 : )
461 :
462 179 : watch(
463 : [showFullResolution, mainImageSrc],
464 : ([fullRes, src], [previousFullRes, previousSrc]) => {
465 264 : if (fullRes === previousFullRes) return
466 3 : imageError.value = false
467 3 : if (src !== previousSrc) startDelayedLoader()
468 : }
469 : )
470 :
471 179 : let isUnmounted = false
472 179 : onBeforeUnmount(() => {
473 16 : isUnmounted = true
474 : })
475 :
476 196 : function handleImageLoad(event: Event) {
477 196 : if (!event.target || !(event.target instanceof HTMLImageElement)) return
478 196 : const img = event.target
479 196 : stopDelayedLoader()
480 196 : showLoader.value = false
481 196 : imageError.value = false
482 196 : const { width, height } = currentDisplayImage.value?.originalSize ?? {
483 : width: img.naturalWidth,
484 : height: img.naturalHeight
485 : }
486 196 : if (width && height) actualDimensions.value = `${width} x ${height}`
487 :
488 196 : if (nodeId && !isUnmounted) {
489 196 : nodeOutputStore.syncLegacyNodeImgs(nodeId, img, currentIndex.value)
490 : }
491 : }
492 :
493 104 : function updateAspectRatio(event: Event, index: number) {
494 104 : if (!(event.target instanceof HTMLImageElement) || index !== 0) return
495 3 : const { naturalWidth, naturalHeight } = event.target
496 104 : if (naturalWidth && naturalHeight) {
497 3 : imageAspectRatio.value = naturalWidth / naturalHeight
498 : }
499 : }
500 :
501 16 : async function handleImageError(failedUrl: string) {
502 16 : stopDelayedLoader()
503 16 : showLoader.value = false
504 16 : if (isHdr.value) {
505 0 : failedHdrPreviews.value[currentIndex.value] = true
506 0 : return
507 : }
508 16 : imageError.value = true
509 16 : actualDimensions.value = null
510 :
511 16 : const metadata = await describeImageLoadFailure(failedUrl)
512 16 : useTelemetry()?.trackImageLoadFailed(metadata)
513 : }
514 :
515 30 : function handleEditMask() {
516 30 : if (!nodeId) return
517 30 : const node = resolveNode(nodeId)
518 30 : if (!node) return
519 30 : maskEditor.openMaskEditor(node)
520 : }
521 :
522 2 : async function handleOpenLayerEditor() {
523 2 : if (!nodeId) return
524 2 : const node = resolveNode(nodeId)
525 2 : if (!node) return
526 2 : const { useLayerEditor } =
527 : await import('@/renderer/extensions/layerEditor/composables/useLayerEditor')
528 2 : useLayerEditor().openLayerEditor(node)
529 : }
530 :
531 0 : function handleDownload() {
532 0 : try {
533 0 : downloadFile(resultItemUrl(items[currentIndex.value]))
534 : } catch {
535 0 : toast.error(t('g.error'), {
536 : description: t('g.failedToDownloadImage')
537 : })
538 : }
539 : }
540 :
541 0 : function handleExportOutputs() {
542 0 : if (!nodeId) return
543 0 : const node = resolveNode(nodeId)
544 0 : if (!node) return
545 0 : showOutputsExportDialog(node)
546 : }
547 :
548 2 : function setCurrentIndex(index: number) {
549 2 : if (currentIndex.value === index) return
550 2 : if (index >= 0 && index < items.length) {
551 0 : const oldUrl = displayUrls.value[currentIndex.value]
552 0 : currentIndex.value = index
553 0 : imageError.value = false
554 0 : if (displayUrls.value[index] !== oldUrl) startDelayedLoader()
555 : }
556 : }
557 :
558 2 : async function openImageInGallery(index: number) {
559 2 : setCurrentIndex(index)
560 2 : viewMode.value = 'gallery'
561 2 : await nextTick()
562 2 : galleryPanelEl.value?.focus()
563 : }
564 :
565 14 : function getNavigationDotClass(index: number) {
566 14 : return cn(
567 : 'size-2 cursor-pointer rounded-full border-0 p-0 transition-all duration-200',
568 : index === currentIndex.value
569 : ? 'bg-foreground'
570 : : 'bg-foreground/50 hover:bg-foreground/80'
571 : )
572 : }
573 :
574 0 : function handleKeyDown(event: KeyboardEvent) {
575 0 : if (
576 : event.key === 'Escape' &&
577 : viewMode.value === 'gallery' &&
578 : hasMultipleImages.value
579 : ) {
580 0 : event.preventDefault()
581 0 : viewMode.value = 'grid'
582 0 : return
583 : }
584 :
585 0 : if (items.length <= 1 || viewMode.value === 'grid') return
586 :
587 0 : switch (event.key) {
588 : case 'ArrowLeft':
589 0 : event.preventDefault()
590 0 : setCurrentIndex(
591 : currentIndex.value > 0 ? currentIndex.value - 1 : items.length - 1
592 : )
593 0 : break
594 : case 'ArrowRight':
595 0 : event.preventDefault()
596 0 : setCurrentIndex(
597 : currentIndex.value < items.length - 1 ? currentIndex.value + 1 : 0
598 : )
599 0 : break
600 : case 'Home':
601 0 : event.preventDefault()
602 0 : setCurrentIndex(0)
603 0 : break
604 : case 'End':
605 0 : event.preventDefault()
606 0 : setCurrentIndex(items.length - 1)
607 : break
608 : }
609 : }
610 : </script>
|