Dependency injection patterns in Vue

Introduction

Dependency injection helps you share data or functions between components without passing them through many layers. It makes your code cleaner and easier to manage.

You want to share a service or data across many components without passing props repeatedly.

You have a theme or configuration that many parts of your app need to access.

You want to provide a function or object once and let child components use it directly.

You want to avoid tightly coupling components by passing dependencies explicitly.

You want to make testing easier by swapping dependencies.

Syntax

Vue

import { provide, inject } from 'vue'

// In a parent or ancestor component
provide('keyName', value)

// In a child or descendant component
const value = inject('keyName')

provide sets a value that descendants can access.

inject lets a component receive that value by the same key.

Examples

This parent component shares the string 'blue' with its descendants under the key 'color'.

Vue

import { provide } from 'vue'

export default {
  setup() {
    provide('color', 'blue')
  }
}

This child component receives the 'color' value provided by an ancestor.

Vue

import { inject } from 'vue'

export default {
  setup() {
    const color = inject('color')
    return { color }
  }
}

Sharing an object like a user info between components.

Vue

import { provide, inject } from 'vue'

// Parent
export default {
  setup() {
    const user = { name: 'Alice' }
    provide('user', user)
  }
}

// Child
export default {
  setup() {
    const user = inject('user')
    return { user }
  }
}

Sample Program

The parent component provides a theme object with color and font size. The child component injects this theme and uses it to style its text.

Vue

<template>
  <div>
    <h2>Parent Component</h2>
    <ChildComponent />
  </div>
</template>

<script setup>
import { provide } from 'vue'
import ChildComponent from './ChildComponent.vue'

const theme = { color: 'teal', fontSize: '1.2rem' }
provide('theme', theme)
</script>

<!-- ChildComponent.vue -->
<template>
  <div :style="{ color: theme.color, fontSize: theme.fontSize }">
    This text uses the injected theme.
  </div>
</template>

<script setup>
import { inject } from 'vue'
const theme = inject('theme')
</script>

Important Notes

If the injected key is not found, inject returns undefined unless you provide a default value.

You can provide default values like inject('key', defaultValue) to avoid errors.

Dependency injection works only between ancestor and descendant components, not siblings.

Summary

Dependency injection shares data or functions between components without prop drilling.

Use provide in an ancestor and inject in descendants.

This pattern keeps your code clean and easier to maintain.

Practice

1. What is the main purpose of using provide and inject in Vue?

easy

A. To define routes in a Vue application

B. To share data or functions between components without passing props manually

C. To handle component lifecycle hooks

D. To create global CSS styles for components

Solution

1. Step 1: Understand the role of provide/inject

   They allow sharing data or functions from a parent component to its descendants without passing props through every intermediate component.

2. Step 2: Compare with other options

   The other options relate to defining routes, creating global CSS styles, and handling component lifecycle hooks, which are unrelated to provide/inject.

3. Final Answer:

   To share data or functions between components without passing props manually -> Option B

4. Quick Check:

   Dependency injection = share data without props [OK]

Hint: Remember provide/inject shares data without prop drilling [OK]

Common Mistakes:

• Confusing provide/inject with props or events
• Thinking provide/inject manages styles or routing
• Assuming provide/inject replaces Vuex or global state

2. Which of the following is the correct syntax to provide a value in a Vue 3 component using the Composition API?

easy

A. const value = inject('key')

B. this.provide('key', value)

C. provide('key', value)

D. inject('key', value)

Solution

1. Step 1: Identify provide syntax in Composition API

   In Vue 3 Composition API, you call provide('key', value) inside setup() to share data.

2. Step 2: Check other options

   const value = inject('key') is for injection, not providing. this.provide('key', value) uses this which is not used in setup(). inject('key', value) is incorrect because inject does not provide values.

3. Final Answer:

   provide('key', value) -> Option C

4. Quick Check:

   Provide = provide('key', value) [OK]

Hint: Provide uses provide('key', value) inside setup() [OK]

Common Mistakes:

• Using inject instead of provide to share data
• Trying to call provide on this inside setup()
• Confusing provide syntax with options API methods

3. Given the following Vue 3 setup, what will be logged in the child component?

import { provide, inject } from 'vue';
const Parent = {
  setup() {
    provide('message', 'Hello from parent')
  }
}

const Child = {
  setup() {
    const msg = inject('message')
    console.log(msg)
  }
}

medium

A. null

B. undefined

C. An error because provide is missing a return

D. 'Hello from parent'

Solution

1. Step 1: Understand provide/inject behavior

   The parent provides the string 'Hello from parent' with key 'message'. The child injects this key and receives the value.

2. Step 2: Predict console output

   Since the child injects the provided key correctly, it logs 'Hello from parent'.

3. Final Answer:

   'Hello from parent' -> Option D

4. Quick Check:

   Inject returns provided value = 'Hello from parent' [OK]

Hint: Inject returns what provide shares by key [OK]

Common Mistakes:

• Expecting undefined if no return in setup
• Confusing provide with returning values
• Assuming inject returns null if key exists

4. What is wrong with this Vue 3 code snippet?

import { provide, inject } from 'vue';
const Parent = {
  setup() {
    provide('data', 123)
  }
}

const Child = {
  setup() {
    const data = inject('data')
    console.log(data)
  }
}

medium

A. inject is missing a default value, may cause undefined

B. provide is called outside setup()

C. provide must return an object

D. inject cannot be used in setup()

Solution

1. Step 1: Check provide usage

   Provide is correctly called inside setup() with key 'data' and value 123.

2. Step 2: Check inject usage

   Inject is called correctly but without a default value. If the key is missing, it returns undefined, which might cause issues.

3. Final Answer:

   inject is missing a default value, may cause undefined -> Option A

4. Quick Check:

   Inject without default can be undefined [OK]

Hint: Always provide default value to inject to avoid undefined [OK]

Common Mistakes:

• Thinking provide must return an object
• Believing inject can't be used in setup
• Assuming provide is outside setup here

5. You want to share a reactive object between a grandparent and a grandchild component using provide/inject in Vue 3. Which approach correctly ensures the grandchild reacts to changes in the shared object?

hard

A. Provide a reactive object using provide('state', reactiveObj) and inject it normally in the grandchild

B. Provide a plain object and inject it with a default value in the grandchild

C. Provide a reactive object but inject it inside onMounted hook in the grandchild

D. Provide a reactive object but convert it to a ref before injecting

Solution

1. Step 1: Understand reactive sharing with provide/inject

   Providing a reactive object directly shares its reactivity, so descendants see updates.

2. Step 2: Evaluate options for reactivity

   Provide a reactive object using provide('state', reactiveObj) and inject it normally in the grandchild correctly provides a reactive object and injects it normally, preserving reactivity. Provide a plain object and inject it with a default value in the grandchild uses a plain object, losing reactivity. Provide a reactive object but inject it inside onMounted hook in the grandchild delays injection unnecessarily. Provide a reactive object but convert it to a ref before injecting converts reactive to ref, which is unnecessary and may cause confusion.

3. Final Answer:

   Provide a reactive object using provide('state', reactiveObj) and inject it normally in the grandchild -> Option A

4. Quick Check:

   Reactive object provided and injected keeps reactivity [OK]

Hint: Provide reactive object directly to keep reactivity in inject [OK]

Common Mistakes:

• Providing plain objects losing reactivity
• Injecting inside lifecycle hooks unnecessarily
• Converting reactive to ref before injecting