DEV Community

Cover image for Improving Performance of Nuxt with Lazy Pattern
Jakub Andrzejewski
Jakub Andrzejewski

Posted on


Improving Performance of Nuxt with Lazy Pattern

One of my all time favorite pattern for improving performance in modern web applications is relatively simple to explain:

Just load what the user actually needs
Enter fullscreen mode Exit fullscreen mode

This sounds really easy right? It should be, but believe me, with modern frameworks and with the pace of development we usually forget about this pattern and we put everything inside our application, and eventually for our users.

This results in huge code bundles, megabytes of data transfer for the users, and bad performance.

And the medicine is in the reach of our hands. When a user don't need it, just defer the loading of it until the time that it will be.

Let's take one of my favourite examples on the table. Imagine that your website (homepage) has a header, a banner and a footer that is right below the fold.

Header contains a company logo, banner contains a product image and in the footer you have X images of company members (or any other section with images basically).

There is no need to fetch the images in the footer that are below the fold as user will not see them. So what is the point of fetching them actually? There isn't. And this is just the first example.

For more, check out next sections ;)

Lazy Loading Images

Lazy loading images allows to improve the performance of your website which also results in better experience for your users. Take a look at the below GIF for a great visual representation with cats :)

This can be achieved by using the native img attribute called loading. To enable lazy loading just set its value to lazy.

You can read more about it here

The result of implementing lazy loading can be observerd here:

Lazy Loading Images


In Nuxt ecosystem, it is best to use the NuxtImage module that comes with the support for lazy loading images as well and you can check it out here

To use the lazy loading just set the prop like following:

<nuxt-img src="/nuxt-icon.png" loading="lazy" />
Enter fullscreen mode Exit fullscreen mode

And with this change, the request for these assets will be delayed until they will be in the viewport.

Important note!

Remember to not use the loading="lazy" attribute on an element that is supposed to be a Largest Contentful Paint.

Components Dynamic Imports

Nuxt allows to very easily utilize the components dynamic imports patter. To dynamically import a component (also known as lazy-loading a component) all you need to do is add the Lazy prefix to the component's name:

    <TheHeader />
    <slot />
    <LazyTheFooter />
Enter fullscreen mode Exit fullscreen mode

This is particularly useful if the component is not always needed. By using the Lazy prefix you can delay loading the component code until the right moment, which can be helpful for optimizing your JavaScript bundle size.

You can read more about it here

Lazy Data Fetching Composables

Both useLazyFetch and useLazyAsyncData work as a wrapper around regular useFetch and useAsyncData that triggers navigation before the handler is resolved by setting the lazy option to true. By default, useFetch and useAsyncData blocks navigation until its async handler is resolved.

The lazy option for these composables works like following:

lazy: whether to resolve the async function after loading the route, instead of blocking client-side navigation (defaults to false)
Enter fullscreen mode Exit fullscreen mode

Take a look at the below code sample to see how these Lazy alternatives work:

    {{ pending ? 'Loading' : count }}

<script setup>
/* Navigation will occur before fetching is complete.
  Handle pending and error states directly within your component's template
const { pending, data: count } = useLazyAsyncData('count', () => $fetch('/api/count'))

watch(count, (newCount) => {
  // Because count starts out null, you won't have access
  // to its contents immediately, but you can watch it.
Enter fullscreen mode Exit fullscreen mode

You can read more about it here and here

Lazy Hydration

This concept allows you to have full control over the process of hydrating the HTML with JavaScript by utilizing concepts such as on-interaction, on-scroll, etc. I wrote about this concept already in my previous article that you can check out here


Nicely done! Now, you know more about the Lazy Pattern and how you can start using it in your applications to improve the performance and deliver better experience to your users. Let me know about other useful patterns for developing modern web applications :)

Top comments (0)