Lazy loading routes in Vue

Introduction

Lazy loading routes means loading parts of your app only when needed. This helps your app start faster and saves data.

When your app has many pages and you want faster start time.

When some pages are rarely visited and don't need to load upfront.

When you want to reduce the initial download size for users.

When you want to improve user experience on slow networks.

Syntax

Vue

const routes = [
  {
    path: '/home',
    component: () => import('./components/Home.vue')
  },
  {
    path: '/about',
    component: () => import('./components/About.vue')
  }
];

Use a function that returns import() to load the component only when the route is visited.

This syntax works with Vue Router and modern JavaScript modules.

Examples

Lazy load the Dashboard component only when the user visits '/dashboard'.

Vue

const routes = [
  { path: '/dashboard', component: () => import('./Dashboard.vue') }
];

Add a comment to name the chunk for better debugging and caching.

Vue

const routes = [
  { path: '/profile', component: () => import(/* webpackChunkName: "profile" */ './Profile.vue') }
];

Sample Program

This Vue Router setup lazy loads the Home and About components. They load only when you visit their routes, making the app start faster.

Vue

import { createRouter, createWebHistory } from 'vue-router';

const routes = [
  {
    path: '/',
    component: () => import('./components/Home.vue')
  },
  {
    path: '/about',
    component: () => import('./components/About.vue')
  }
];

const router = createRouter({
  history: createWebHistory(),
  routes
});

export default router;

Important Notes

Lazy loading improves app speed but adds a small delay when loading a new route for the first time.

Use lazy loading for large or rarely used components to save bandwidth.

Check browser DevTools Network tab to see when chunks load.

Summary

Lazy loading routes loads components only when needed.

This reduces initial app size and speeds up start time.

Use component: () => import('...') syntax in Vue Router.

Practice

1. What is the main benefit of using lazy loading for routes in Vue?

easy

A. It automatically caches all components in the browser.

B. It preloads all components at app start for faster navigation.

C. It loads components only when the route is visited, reducing initial load time.

D. It disables routing and shows all components on one page.

Solution

1. Step 1: Understand lazy loading concept

   Lazy loading means loading something only when it is needed, not before.

2. Step 2: Apply to Vue routes

   In Vue, lazy loading routes means components load only when their route is visited, reducing initial app size and speeding start time.

3. Final Answer:

   It loads components only when the route is visited, reducing initial load time. -> Option C

4. Quick Check:

   Lazy loading = load on demand [OK]

Hint: Lazy loading means load components only when needed [OK]

Common Mistakes:

• Thinking lazy loading preloads all components
• Confusing lazy loading with caching
• Believing lazy loading disables routing

2. Which of the following is the correct syntax to lazy load a route component in Vue Router?

easy

A. component: import('./MyComponent.vue')

B. component: './MyComponent.vue'

C. component: () => require('./MyComponent.vue')

D. component: () => import('./MyComponent.vue')

Solution

1. Step 1: Recall Vue Router lazy loading syntax

   Vue Router uses dynamic import with arrow function: () => import('path').

2. Step 2: Check each option

   component: () => import('./MyComponent.vue') matches correct syntax. component: import('./MyComponent.vue') misses arrow function. component: () => require('./MyComponent.vue') uses require which is not standard for lazy loading in Vue 3. component: './MyComponent.vue' is just a string, not a function.

3. Final Answer:

   component: () => import('./MyComponent.vue') -> Option D

4. Quick Check:

   Lazy load syntax = arrow function + import() [OK]

Hint: Lazy load uses arrow function returning import() [OK]

Common Mistakes:

• Omitting arrow function
• Using require() instead of import()
• Assigning component to string path directly

3. Given this Vue Router route config, what will happen when the user visits '/dashboard' for the first time?

const routes = [
  {
    path: '/dashboard',
    component: () => import('./Dashboard.vue')
  }
]

medium

A. The Dashboard component is loaded immediately when the app starts.

B. The Dashboard component is loaded only when the '/dashboard' route is visited.

C. The Dashboard component is never loaded.

D. The Dashboard component is loaded twice.

Solution

1. Step 1: Analyze the route config

   The component is assigned as a function returning import(), which means lazy loading.

2. Step 2: Understand lazy loading behavior

   The component will load only when the route '/dashboard' is visited, not before.

3. Final Answer:

   The Dashboard component is loaded only when the '/dashboard' route is visited. -> Option B

4. Quick Check:

   Lazy load means load on visit [OK]

Hint: Lazy loaded components load on route visit, not app start [OK]

Common Mistakes:

• Assuming component loads at app start
• Thinking component never loads
• Believing component loads multiple times automatically

4. Identify the error in this Vue Router lazy loading route config:

const routes = [
  {
    path: '/profile',
    component: import('./Profile.vue')
  }
]

medium

A. Missing arrow function wrapping the import call.

B. The path should be '/profiles' instead of '/profile'.

C. The import path must be absolute, not relative.

D. Lazy loading is not supported in Vue Router.

Solution

1. Step 1: Check lazy loading syntax

   Lazy loading requires component to be a function returning import(), like () => import('...').

2. Step 2: Identify the error

   Here, import() is called directly without arrow function, causing immediate import and syntax error.

3. Final Answer:

   Missing arrow function wrapping the import call. -> Option A

4. Quick Check:

   Lazy load needs () => import() [OK]

Hint: Lazy load must use arrow function wrapping import() [OK]

Common Mistakes:

• Calling import() directly without arrow function
• Changing path unnecessarily
• Believing lazy loading is unsupported

5. You want to lazy load two nested routes in Vue Router: '/settings' and '/settings/profile'. Which is the correct way to configure lazy loading for both routes?

hard

A. Use component: () => import() for both routes inside children array.

B. Lazy load only the parent route; child routes load immediately.

C. Use static imports for both routes to avoid delays.

D. Define child routes outside the parent route config.

Solution

1. Step 1: Understand nested route lazy loading

   Each route can lazy load its component independently using () => import().

2. Step 2: Apply to nested routes

   Both '/settings' and '/settings/profile' should have component properties with arrow functions returning import() to lazy load separately.

3. Step 3: Check other options

   Lazy load only the parent route; child routes load immediately. is wrong because child routes won't lazy load automatically. Use static imports for both routes to avoid delays. disables lazy loading. Define child routes outside the parent route config. is unrelated to lazy loading.

4. Final Answer:

   Use component: () => import() for both routes inside children array. -> Option A

5. Quick Check:

   Lazy load each nested route with () => import() [OK]

Hint: Lazy load each nested route with arrow function import() [OK]

Common Mistakes:

• Lazy loading only parent route
• Using static imports for lazy loading
• Separating child routes incorrectly