Global properties and methods in Vue

Introduction

Global properties and methods let you share values or functions across all Vue components easily. This helps avoid repeating code and keeps your app organized.

You want to use the same helper function in many components without importing it each time.

You need to share a global configuration value, like an API base URL, across your app.

You want to add a global method for formatting dates or numbers used everywhere.

You want to add a global property for theme colors or user settings accessible in all components.

Syntax

Vue

import { createApp } from 'vue'
const app = createApp(App)

app.config.globalProperties.$myMethod = () => {
  // your code here
}

app.mount('#app')

Global properties are added to app.config.globalProperties and accessed in components with this.$myMethod.

Use a $ prefix to avoid name conflicts with component data or methods.

Examples

This adds a global method $formatDate to format dates in all components.

Vue

app.config.globalProperties.$formatDate = (date) => {
  return new Date(date).toLocaleDateString()
}

This adds a global property $appName that holds the app name string.

Vue

app.config.globalProperties.$appName = 'My Vue App'

This adds a global method $log to print messages with a prefix.

Vue

app.config.globalProperties.$log = (msg) => console.log('Log:', msg)

Sample Program

This example shows how to add global properties and methods to a Vue app. The app displays the app name and formatted date using global properties. The button uses a global method to log a message when clicked.

Vue

import { createApp } from 'vue'

const App = {
  template: `<div>
    <h1>{{ $appName }}</h1>
    <p>Today is: {{ $formatDate(new Date()) }}</p>
    <button @click="$log('Button clicked!')">Click me</button>
  </div>`
}

const app = createApp(App)

app.config.globalProperties.$appName = 'My Vue App'
app.config.globalProperties.$formatDate = (date) => {
  return new Date(date).toLocaleDateString()
}
app.config.globalProperties.$log = (msg) => console.log('Log:', msg)

app.mount('#app')

Important Notes

Global properties are accessible inside component templates and methods via this.$propertyName.

Use global properties sparingly to avoid making components too dependent on global state.

For better type safety and IDE support, consider using provide/inject or composables for shared logic in larger apps.

Summary

Global properties and methods let you share code across all Vue components easily.

Add them using app.config.globalProperties with a $ prefix.

Use them in templates and scripts with this.$propertyName.

Practice

1. What is the main purpose of app.config.globalProperties in Vue?

easy

A. To add properties or methods accessible in all components

B. To register new components globally

C. To configure routing paths

D. To define component-specific data

Solution

1. Step 1: Understand the role of app.config.globalProperties

   This object allows adding properties or methods that every Vue component can access easily.

2. Step 2: Differentiate from other Vue features

   Registering components, routing, and component data are handled differently, not via globalProperties.

3. Final Answer:

   To add properties or methods accessible in all components -> Option A

4. Quick Check:

   Global properties = shared access across components [OK]

Hint: Global properties share code across all components [OK]

Common Mistakes:

• Confusing globalProperties with component registration
• Thinking it configures routing
• Assuming it stores component local data

2. Which of the following is the correct way to add a global method named logMessage in Vue 3?

easy

A. app.globalProperties.logMessage = () => console.log('Hi')

B. app.config.globalProperties.logMessage = function logMessage() { console.log('Hi') }

C. app.config.globalProperties.logMessage = () => console.log('Hi')

D. app.config.globalProperties.$logMessage = () => console.log('Hi')

Solution

1. Step 1: Recall the correct syntax for global properties

   Global properties must be added to app.config.globalProperties with a $ prefix on the property name.

2. Step 2: Check the options for correct prefix and assignment

   app.config.globalProperties.$logMessage = () => console.log('Hi') correctly uses app.config.globalProperties.$logMessage with an arrow function.

3. Final Answer:

   app.config.globalProperties.$logMessage = () => console.log('Hi') -> Option D

4. Quick Check:

   Use app.config.globalProperties.$name for globals [OK]

Hint: Global properties need $ prefix and app.config [OK]

Common Mistakes:

• Omitting the $ prefix
• Using app.globalProperties instead of app.config.globalProperties
• Assigning without a function

3. Given this setup in main.js:

app.config.globalProperties.$greet = (name) => `Hello, ${name}!`

What will be the output of this code inside a component method?

console.log(this.$greet('Alice'))

medium

A. undefined

B. Hello, Alice!

C. Error: $greet is not a function

D. Hello, ${name}!

Solution

1. Step 1: Understand the global method definition

   The method $greet is defined globally to return a greeting string with the passed name.

2. Step 2: Analyze the component call

   Calling this.$greet('Alice') invokes the global method, returning Hello, Alice!.

3. Final Answer:

   Hello, Alice! -> Option B

4. Quick Check:

   Global method call returns expected string [OK]

Hint: Global methods run with this.$name inside components [OK]

Common Mistakes:

• Expecting template literal without interpolation
• Forgetting to use this.$ prefix
• Assuming method is undefined

4. Identify the error in this Vue 3 global property setup:

app.config.globalProperties.log = function(message) {
  console.log(message)
}

// Usage in component:
this.$log('Test')

medium

A. Missing $ prefix in global property name

B. Function syntax is incorrect

C. Cannot use global properties inside components

D. Should use arrow function instead of regular function

Solution

1. Step 1: Check the global property name

   The property is named log but used as $log in the component, causing mismatch.

2. Step 2: Understand Vue global property naming convention

   Global properties must be defined with a $ prefix to match usage in components.

3. Final Answer:

   Missing $ prefix in global property name -> Option A

4. Quick Check:

   Global properties need $ prefix to match usage [OK]

Hint: Global property name and usage must both have $ prefix [OK]

Common Mistakes:

• Defining without $ but using with $
• Thinking function syntax is wrong
• Believing global properties can't be used in components

5. You want to create a global property $formatDate that formats a Date object to YYYY-MM-DD. Which is the best way to define and use it in Vue 3?

hard

A. Add a global variable formatDate in main.js and use formatDate(date) in components

B. Create a component method named formatDate and call this.formatDate(date)

C. Define in app.config.globalProperties.$formatDate as a function returning formatted string; call with this.$formatDate(date) in components

D. Use a computed property in each component to format dates

Solution

1. Step 1: Understand global property usage

   Global properties are added to app.config.globalProperties with a $ prefix and accessed via this.$name in components.

2. Step 2: Evaluate options for best practice

   Define in app.config.globalProperties.$formatDate as a function returning formatted string; call with this.$formatDate(date) in components correctly defines the formatter globally and uses it properly in components, promoting code reuse.

3. Final Answer:

   Define in app.config.globalProperties.$formatDate as a function returning formatted string; call with this.$formatDate(date) in components -> Option C

4. Quick Check:

   Global reusable methods use $ prefix and app.config [OK]

Hint: Use app.config.globalProperties with $ prefix for reusable methods [OK]

Common Mistakes:

• Defining methods only inside components losing reuse
• Using global variables without Vue context
• Not using $ prefix for global properties