mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-24 14:45:15 +00:00
3ec108493d
* docs: simplify docs to only markdown * Create nuxt-config.md * chore: update * chore: add readme
1.4 KiB
1.4 KiB
title | description |
---|---|
NuxtApp | In Nuxt 3, you can access runtime app context within composables, components and plugins. |
NuxtApp
In Nuxt 3, you can access runtime app context within composables, components and plugins. In Nuxt 2, this was referred to as Nuxt context.
Accessing NuxtApp
Within composables, plugins and components you can access nuxtApp
with useNuxtApp
:
function useMyComposable () {
const nuxtApp = useNuxtApp()
// access runtime nuxt app instance
}
Plugins also receive nuxtApp
as the first argument for convenience. Read more about plugins.
::alert{icon=👉}
useNuxtApp
(on the server) only works during setup
, inside Nuxt plugins or Lifecycle Hooks
.
::
Providing Helpers
You can provide helpers to be usable across all composables and application. This usually happens within a Nuxt plugin.
const nuxtApp = useNuxtApp()
nuxtApp.provide('hello', (name) => `Hello ${name}!`)
console.log(nuxtApp.$hello('name')) // Prints "Hello name!"
In Nuxt 2 plugins, this was referred to as inject function.
::alert{icon=👉}
It is possible to inject helpers by returning an object with a provide
key. See the plugins documentation for more information.
::