Vue.js Responsive Image Lazy Loading

In today’s article, we take a closer look at how we can build our own custom lazy loading image component with Vue.js. We use the fast and lightweight Lozad.js package for handling the lazy loading logic for us, and we’ll enhance it with the ability to display the dominant color of the image as a fallback color, which is shown while the original image is loading. Additionally, the lazy loading component handles maintaining the correct aspect ratio while a placeholder rectangle is shown.

If you want to take a look at the result of our work, you can look at a demo hosted on Netlify and you can check out the code on GitHub.

Vue-Lazyload

Before we get started: there already is a perfectly fine solution for lazy loading images with Vue.js: Vue-Lazyload. The reason why I’m still writing this article is, that I wanted a more lightweight solution. In the tests that I’ve done, Vue-Lazyload adds about 19 kB to the final bundle size (overall bundle size: 106 kB). The custom solution only adds about 5 kb (overall bundle size: 92 kB).

If a few kilobytes are not a great concern for you and if you’re not interested in how to actually build a lazy loading component, you can stop reading and just use Vue-Lazyload, it’s a great plugin. For those of you who’re constantly searching for ways of how to shave off a few kilobytes of your application or who’re interested in how to build stuff themselves, read on.

Building a custom lazy loading component

Because we don’t want to implement the logic for detecting if an image is in the viewport, and therefore should be loaded, ourselves, we use Lozad.js to handle this for us. Lozad.js has a very small footprint of only 1.8 kB and it’s very fast because it uses the Intersection Observer API. Keep in mind, though, that not every browser (most notably Safari) supports the Intersection Observer API yet, but Lozad.js degrades very gracefully by simply loading all images immediately if the browser does not support the Intersection Observer API. In my opinion, this is a good enough fallback, but you can also use a polyfill if you want.

npm install lozad --save

After installing the lozad package, we can start building our custom Vue.js lazy loading image component.

The lazy loading image component

There are multiple ways of how to solve this problem in Vue.js. One possible approach would be to use custom directives to handle lazy loading on regular <img> tags. However, I’m a huge fan of components because they’re very flexible and they enable us to easily add further functionality in the future, if we want to.

<template>
  <img
    :data-src="lazySrc"
    :data-srcset="lazySrcset"
    :style="style"
    class="AppImage"
  />
</template>

<script>
import lozad from "lozad";

export default {
  name: "AppImage",
  props: {
    backgroundColor: {
      type: String,
      default: "#efefef",
    },
    height: {
      type: Number,
      default: null,
    },
    lazySrc: {
      type: String,
      default: null,
    },
    lazySrcset: {
      type: String,
      default: null,
    },
    width: {
      type: Number,
      default: null,
    },
  },
  data() {
    return {
      loading: true,
    };
  },
  computed: {
    aspectRatio() {
      // Calculate the aspect ratio of the image
      // if the width and the height are given.
      if (!this.width || !this.height) return null;

      return (this.height / this.width) * 100;
    },
    style() {
      // The background color is used as a
      // placeholder while loading the image.
      // You can use the dominant color of the
      // image to improve perceived performance.
      // See: https://manu.ninja/dominant-colors-for-lazy-loading-images/
      const style = { backgroundColor: this.backgroundColor };

      if (this.width) style.width = `${this.width}px`;

      // If the image is still loading and an
      // aspect ratio could be calculated, we
      // apply the calculated aspect ratio by
      // using padding top.
      const applyAspectRatio = this.loading && this.aspectRatio;
      if (applyAspectRatio) {
        // Prevent flash of unstyled image
        // after the image is loaded.
        style.height = 0;
        // Scale the image container according
        // to the aspect ratio.
        style.paddingTop = `${this.aspectRatio}%`;
      }

      return style;
    },
  },
  mounted() {
    // As soon as the <img> element triggers
    // the `load` event, the loading state is
    // set to `false`, which removes the apsect
    // ratio we've applied earlier.
    const setLoadingState = () => {
      this.loading = false;
    };
    this.$el.addEventListener("load", setLoadingState);
    // We remove the event listener as soon as
    // the component is destroyed to prevent
    // potential memory leaks.
    this.$once("hook:destroyed", () => {
      this.$el.removeEventListener("load", setLoadingState);
    });

    // We initialize Lozad.js on the root
    // element of our component.
    const observer = lozad(this.$el);
    observer.observe();
  },
};
</script>

<style lang="scss">
// Responsive image styles.
.AppImage {
  max-width: 100%;
  max-height: 100%;
  width: auto;
  height: auto;
  vertical-align: middle;
}
</style>

Above you can see the code of the AppImage component. I’ve added comments to explain what’s going on.

Using the component

There are multiple ways of how to use the component. If you’re ok with the image popping up as soon as it’s loaded, you can use the component almost the same way as a regular <img> tag. The only difference is that you have to prefix the src and srcset properties with the lazy- keyword, if you want to make use of lazy loading that is, otherwise you can use the regular src and srcset properties.

<app-image lazy-src="/my/image.jpg" lazy-srcset="/my/image-2x.jpg 2x" />

You can optimize this a little bit, by adding the dimensions of the image. By providing a width and a height, the component can calculate the aspect ratio and reserve the space that the image will take up.

<app-image
  :width="300"
  :height="200"
  lazy-src="/my/image.jpg"
  lazy-srcset="/my/image-2x.jpg 2x"
/>

Dominant color

To further improve the perceived performance, you can extract the most dominant color of the image as the background color of the placeholder rectangle.

<app-image
  :width="300"
  :height="200"
  :background-color="#b0897e"
  lazy-src="/my/image.jpg"
  lazy-srcset="/my/image-2x.jpg 2x"
/>

Low fi blurry image

Another route you can go, is to use a low fi blurry version of the image as a placeholder while the high-resolution version is loading. Keep in mind, though, that by using this technique you have to load two images instead of one, you should absolutely test if this has a beneficial effect overall.

<app-image
  :width="300"
  :height="200"
  src="/my/image-blurry.jpg"
  lazy-src="/my/image.jpg"
  lazy-srcset="/my/image-2x.jpg 2x"
/>

Wrapping it up

Using lazy loading techniques can have a huge positive effect on the loading performance of a website, especially on pages featuring a lot of large scale, high quality images.

But keep in mind, that using this techniques can also have downsides. Always test the implications of optimizations like that on a broad range of real devices, starting from low end smartphones up to the latest and greatest flagships.