nuxt / nuxt/image

Lazy Loading Fails with NuxtImg Custom Slot

Open
#1,909 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.5k
Forks
331
Avg merge
19h 52m
Merged PRs (30d)
9

Description

Description of the Issue

When the "custom" prop or a placeholder is set, const img = new Image() is immediately triggered to check when the image is ready. This causes immediate loading, preventing lazy loading from working. This behavior is understandable, as NuxtImg in this scenario primarily serves as a provider for optimizations.

The core question is: should we implement lazy loading functionality for this case directly within NuxtImg, or is this a more appropriate scenario for using useImage?


Possible Solution Using useImage
<template>
  <span
    v-if="!isVisible"
    ref="trackerRef"
  />

  <slot
    v-else-if="!isLoaded"
    name="placeholder"
  />

  <Transition
    appear
    v-bind="ThemeTransitions.fade"
  >
    <img
      v-if="isLoaded"
      :src="imageUrl"
      :srcset="imageSrcset"
      :alt="props.alt"
      v-bind="$attrs"
    >
  </Transition>
</template>

<script setup lang="ts">
defineOptions({ inheritAttrs: false })

const trackerRef = ref<HTMLSpanElement | null>(null)

const isLoaded = ref(false)
const isVisible = ref(false)

const props = defineProps<{ src: string, alt?: string, preload?: boolean }>()
const $img = useImage()
const imageUrl = $img(props.src, {})
const imageSrcset = $img.getSizes(props.src, {}).srcset

let observer: IntersectionObserver | null = null

onMounted(() => {
  if (trackerRef.value && !isLoaded.value) {
    observer = new IntersectionObserver(([entry]) => {
      if (entry.isIntersecting) {
        isVisible.value = true
        observer?.disconnect()

        const img = new window.Image()
        img.src = imageUrl
        img.onload = () => {
          isLoaded.value = true
        }
      }
    })
    observer.observe(trackerRef.value)
  }
})

onUnmounted(() => {
  observer?.disconnect()
})
</script>

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the NuxtImg custom-slot behavior described in the issue and compare it with the proposed useImage approach. Investigate how the custom prop, placeholder, and immediate Image loading interact with lazy loading. Done means there is a decided implementation direction and verified lazy-loading behavior for this case.

Written by the indexing model from the issue text.

Assessment

Tech stack
nuxt, typescript
Domain
frontend, performance
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.