Keep-alive for expensive components in Vue

Introduction

Keep-alive helps Vue remember a component's state and avoid reloading it every time you switch views. This saves time and makes your app feel faster.

When you have a component that takes a long time to load or fetch data.

When you want to keep user input or scroll position inside a component while switching between pages.

When switching tabs or views and you want to keep the previous tab's content ready instantly.

When you want to reduce unnecessary re-rendering of complex components.

When you want to improve user experience by keeping component state intact.

Syntax

Vue

<keep-alive>
  <component-to-cache />
</keep-alive>

Wrap the component you want to cache inside the tags.

Only works with dynamic or conditional components, not static ones.

Examples

This caches MyExpensiveComponent so it won't reload when toggled.

Vue

<keep-alive>
  <MyExpensiveComponent />
</keep-alive>

Only caches components named CompA and CompB when used dynamically.

Vue

<keep-alive include="CompA,CompB">
  <component :is="currentComp" />
</keep-alive>

Caches all components except CompC.

Vue

<keep-alive exclude="CompC">
  <component :is="currentComp" />
</keep-alive>

Sample Program

This example shows two components, A and B, each displaying the time they loaded. Using <keep-alive> keeps the component state, so switching back to a component shows the original load time instead of updating it.

Vue

<template>
  <div>
    <button @click="current = 'CompA'">Show A</button>
    <button @click="current = 'CompB'">Show B</button>

    <keep-alive>
      <component :is="current" />
    </keep-alive>
  </div>
</template>

<script setup>
import { ref, defineComponent } from 'vue'

const current = ref('CompA')

const CompA = defineComponent({
  name: 'CompA',
  data() {
    return { time: new Date().toLocaleTimeString() }
  },
  template: `<div>Component A - Loaded at: {{ time }}</div>`
})

const CompB = defineComponent({
  name: 'CompB',
  data() {
    return { time: new Date().toLocaleTimeString() }
  },
  template: `<div>Component B - Loaded at: {{ time }}</div>`
})
</script>

Important Notes

Keep-alive only caches components that are dynamically rendered using <component :is="..." /> or conditional rendering.

Cached components keep their state, including data and DOM, but you can control cache size with max prop.

Use include and exclude props to control which components to cache by name.

Summary

Keep-alive caches components to avoid reloading and improve speed.

Wrap dynamic components inside <keep-alive> to keep their state.

Use include and exclude to control caching behavior.

Practice

1. What is the main purpose of using <keep-alive> in Vue?

easy

A. To cache components and preserve their state when toggled

B. To permanently remove components from the DOM

C. To force components to reload every time they are shown

D. To style components with CSS animations

Solution

1. Step 1: Understand what <keep-alive> does

   <keep-alive> caches components so they don't reload when toggled.

2. Step 2: Compare options to this behavior

   Only 'To cache components and preserve their state when toggled' describes caching and preserving state, which is the main purpose.

3. Final Answer:

   To cache components and preserve their state when toggled -> Option A

4. Quick Check:

   Keep-alive caches components [OK]

Hint: Remember: keep-alive means keep component state alive [OK]

Common Mistakes:

• Thinking keep-alive removes components
• Confusing keep-alive with styling or animations
• Assuming keep-alive forces reloads

2. Which of the following is the correct syntax to wrap a dynamic component with keep-alive in Vue 3?

easy

A.

B.

C.

D.

Solution

1. Step 1: Recall Vue 3 syntax for keep-alive

   The <keep-alive> tag wraps the dynamic <component> with :is binding.

2. Step 2: Check each option's correctness

   <keep-alive><component :is="currentView" /></keep-alive> correctly wraps <component :is="currentView" /> inside <keep-alive>. Others misuse attributes or tags.

3. Final Answer:

   <keep-alive><component :is="currentView" /></keep-alive> -> Option A

4. Quick Check:

   Wrap dynamic component inside keep-alive tags [OK]

Hint: Wrap inside tags [OK]

Common Mistakes:

• Using keep-alive as a self-closing tag with :is
• Adding keep-alive as a prop on component
• Nesting currentView as a tag inside component

3. Given this Vue template:

<keep-alive include="CompA,CompB">
  <component :is="currentComp" />
</keep-alive>

If currentComp changes from 'CompA' to 'CompC' and back to 'CompA', what happens to the state of 'CompA'?

medium

A. State is preserved only if 'CompC' is also included

B. State is lost because 'CompA' is not included in keep-alive

C. State is preserved because 'CompA' is included in keep-alive

D. State is always reset on component switch

Solution

1. Step 1: Understand include prop effect

   The include attribute caches only components named 'CompA' and 'CompB'.

2. Step 2: Analyze component switching

   Switching to 'CompC' unloads it (not cached). Returning to 'CompA' restores cached state.

3. Final Answer:

   State is preserved because 'CompA' is included in keep-alive -> Option C

4. Quick Check:

   Include caches listed components [OK]

Hint: Only included components keep state cached [OK]

Common Mistakes:

• Assuming all components are cached regardless of include
• Thinking state resets on every switch
• Confusing include with exclude

4. Consider this Vue code snippet:

<keep-alive exclude="CompB">
  <component :is="currentComp" />
</keep-alive>

When switching from 'CompA' to 'CompB', the state of 'CompA' is lost. Why?

medium

A. Because 'CompB' is excluded, switching to it destroys cached components including 'CompA'

B. Because 'CompB' is excluded, only 'CompB' is not cached; 'CompA' should keep state

C. Because 'CompB' is excluded, keep-alive disables caching for all components

D. Because exclude disables keep-alive entirely

Solution

1. Step 1: Understand exclude behavior

   The exclude attribute prevents caching only for 'CompB'. Other components like 'CompA' remain cached.

2. Step 2: Analyze why 'CompA' state is lost

   If 'CompA' state is lost, likely the component is unmounted or recreated outside keep-alive scope, not due to exclude.

3. Final Answer:

   Because 'CompB' is excluded, only 'CompB' is not cached; 'CompA' should keep state -> Option B

4. Quick Check:

   Exclude only skips caching excluded components [OK]

Hint: Exclude skips caching only for listed components [OK]

Common Mistakes:

• Thinking exclude disables caching for all components
• Assuming exclude destroys other cached components
• Confusing exclude with disabling keep-alive

5. You have two expensive components, CompX and CompY. You want to cache CompX but not CompY. Which is the best way to use <keep-alive> to achieve this?

hard

A.

B.

C.

D.

Solution

1. Step 1: Identify caching goal

   You want to cache only CompX, not CompY.

2. Step 2: Use include to cache specific components

   Setting include="CompX" caches only CompX. CompY won't be cached.

3. Step 3: Check other options

   Exclude CompX caches everything except CompX (wrong). Include CompY caches only CompY (wrong). No filters caches all (wrong).

4. Final Answer:

   <keep-alive include="CompX"><component :is="currentComp" /></keep-alive> -> Option D

5. Quick Check:

   Include caches only listed components [OK]

Hint: Use include to cache only desired components [OK]

Common Mistakes:

• Using exclude to cache only one component
• Including the wrong component name
• Not using include or exclude and caching all