Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2024-11-11 08:33:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add recommendation for controlling plugin registration order. (#8096)

Browse Source 
Co-authored-by: Sébastien Chopin <seb@nuxtjs.com>
This commit is contained in:
miketromba 2022-10-11 08:14:18 -04:00 committed by GitHub
parent ed1c704835
commit 2aa097310c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/content/2.guide/2.directory-structure/1.plugins.md
View File

@ -40,6 +40,22 @@ export default defineNuxtPlugin(nuxtApp => {
}) })
``` ```
## Plugin Registration Order
You can control the order in which plugins are registered by prefixing a number to the file names.
For example:
```bash
plugins/
| - 1.myPlugin.ts
| - 2.myOtherPlugin.ts
```
In this example, `2.myOtherPlugin.ts` will be able to access anything that was injected by `1.myPlugin.ts`.
This is useful in situations where you have a plugin that depends on another plugin.
## Using Composables Within Plugins ## Using Composables Within Plugins
You can use [composables](/guide/directory-structure/composables) within Nuxt plugins: You can use [composables](/guide/directory-structure/composables) within Nuxt plugins:
@ -54,7 +70,7 @@ However, keep in mind there are some limitations and differences:
**If a composable depends on another plugin registered later, it might not work.** **If a composable depends on another plugin registered later, it might not work.**
**Reason:** Plugins are called in order sequencially and before everything else. You might use a composable that dependants on another plugin which is not called yet. **Reason:** Plugins are called in order sequentially and before everything else. You might use a composable that depends on another plugin which has not been called yet.
**If a composable depends on the Vue.js lifecycle, it won't work.** **If a composable depends on the Vue.js lifecycle, it won't work.**