Dynamic Imports in Vue.js for better performance
Today we have here Paul Melero, a great web developer and friend who also loves teaching other devs.
Did you know that he’s the author of the Testing Vue.js Components with Jest Spanish translation? Don’t expect too little from him!
Let’s jump into Paul’s tip!
Lazy, or “on demand”, loading is a great way to optimize your site or application. This practice essentially involves splitting your code at logical breakpoints, and then loading it once the user has done something that requires, or will require, a new block of code. This speeds up the initial load of the application and lightens its overall weight as some blocks may never even be loaded.
Whenever it’s possible, I’d recommend to use dynamic imports to import components. They will be lazily loaded (by Webpack) when needed.
// Instead of a usual import import MyComponent from "~/components/MyComponent.js"; // do this const MyComponent = () => import("~/components/MyComponent.js");
When using Webpack to bundle your application, you may use different ways to work with modules (ES Modules, CJS, AMD…). If you choose the ESM way (which is the recommended), you will have this kind of syntax:
import MyComponent from "~/components/MyComponent.js";
Notice that there are several use cases where we would like to use asyncronous components. As explained by Alex Jover in this article:
- In component importing
- In Vue Router, for components mapping
- In Vuex modules
Let’s take a look at the syntax and focus on the
If you are using Webpack (or Parcel!), that syntax is going to be transformed on compilation time and these tools are going to use
Promises to load asynchronously your assets/modules/components.
Why the need of an arrow function, you might be wondering: As Alex explained, we need to wrap the
import with an arrow function to be resolved (remember, promises…) only when executed.
To demonstrate that they are fully lazy loaded I’ve prepared a repository (using Nuxt.js). It has 2 pages, each of them use different techniques (With and Without dynamic imports) to import 2 components (component “A” and component “B”).
We will see how, when loading the page with dynamic imports, webpack loads 2 separate files after the navigation. But, the page component itself (
/without) using regular
imports, is heavier because it loads everything at once.
Image showing network waterfall when navigating to both pages. And the differences between both techniques (with and without dynamic imports)
Yes, by using this technique, Webpack will create separate files (“chunks”) to load them when needed (lazily). Custom chunk naming can be done with Magic comments but that will be the subject of another article 😉.
Image showing the result of nuxt build. See how different chunks are created for components A and B when dynamic imports are used!
For a deeper exploration of code splitting techniques check:
- De facto linked article by Anthony Gore: https://vuejsdevelopers.com/2017/07/03/vue-js-code-splitting-webpack/
- Webpack docs: https://webpack.js.org/guides/code-splitting/
PS: For this example repo I have used firstname.lastname@example.org and Nuxt@2.4.0 which uses Vue@2.5.22.
Do you want to sponsor a VueDose tip? Send an email to email@example.com and have more info!
Start saving time and get a tip about the Vue ecosystem every week, right in your inbox.