Zengtudor/Nuxt
1
0
Fork 0
mirror of https://github.com/nuxt/nuxt.git synced 2025-03-22 09:15:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: warn about ref unwrapping when providing refs from plugin (#25054)

Browse Source
This commit is contained in:
Michael Brevard 2024-01-05 09:52:49 +02:00 committed by GitHub
parent b95163c7ca
commit a62f2ba3e3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -200,6 +200,11 @@ const { $hello } = useNuxtApp()
Note that we highly recommend using [`composables`](/docs/guide/directory-structure/composables) instead of providing helpers to avoid polluting the global namespace and keep your main bundle entry small.
::
::callout{color="amber" icon="i-ph-warning-duotone"}
**If your plugin provides a `ref` or `computed`, it will not be unwrapped in a component `<template>`.** :br
This is due to how Vue works with refs that aren't top-level to the template. You can read more about it [in the Vue documentation](https://vuejs.org/guide/essentials/reactivity-fundamentals.html#caveat-when-unwrapping-in-templates).
::
## Typing Plugins
If you return your helpers from the plugin, they will be typed automatically; you'll find them typed for the return of `useNuxtApp()` and within your templates.