Compare commits

...

11 Commits

Author SHA1 Message Date
Matt
8692857ae3
Merge 7b69dc9463 into cf8142b734 2024-11-19 15:12:44 -05:00
Matt Clegg
7b69dc9463 docs: more clarity on auto imports 2024-11-08 10:17:38 +00:00
Matt Clegg
bbf481fb26 fix: removed nuxt domain from link 2024-11-08 08:39:49 +00:00
Matt Clegg
6666197364 fix: removed previous version of text 2024-11-08 08:33:54 +00:00
Matt Clegg
dc229914c7 docs: added link to opting in to nuxt 4 page 2024-11-08 08:22:08 +00:00
Matt Clegg
d2540e45d0 fix: fixed typo 2024-11-08 08:20:03 +00:00
Matt
9bb36478ff
Merge branch 'nuxt:main' into docs/shared-folder 2024-11-07 10:52:53 +00:00
Matt Clegg
519df56854 docs: added clarity to shared folder auto imports 2024-11-06 12:02:58 +00:00
Matt Clegg
dad9d00008 Merge remote-tracking branch 'origin/docs/shared-folder' into docs/shared-folder
# Conflicts:
#	docs/2.guide/2.directory-structure/1.shared.md
2024-11-06 10:50:52 +00:00
Matt Clegg
cb9a4ec847 docs: first pass at the shared directory documentation 2024-11-06 10:50:01 +00:00
Matt Clegg
bcef9571dd docs: first pass at the shared directory documentation 2024-11-06 10:46:54 +00:00

View File

@ -0,0 +1,98 @@
---
title: 'shared'
head.title: 'shared/'
description: 'Use the shared/ directory to share functionality between the Vue app and the Nitro server.'
navigation.icon: 'i-ph-folder'
---
The `shared/` directory allows you to share code that can be used in both the Vue app and the Nitro server.
::tip
The `shared/` directory is available in Nuxt v3.14+.
::
::important
Code in the `shared/` directory cannot import any Vue or Nitro code.
::
## Usage
**Method 1:** Using named export
```ts twoslash [shared/utils/capitalize.ts]
export const capitalize = (input: string) => {
return input[0].toUpperCase() + input.slice(1)
}
```
**Method 2:** Using default export
```ts twoslash [shared/utils/capitalize.ts]
export default function capitalize (input: string) {
return input[0].toUpperCase() + input.slice(1)
}
```
**Usage:** You can now use auto-imported utility functions in `.js`, `.ts` and `.vue` files within your Vue app and the `server/` directory.
If you have [set `compatibilityVersion: 4` in your `nuxt.config.ts`](/docs/getting-started/upgrade#opting-in-to-nuxt-4), you can use the auto-imported functions in the `app/` directory. This is part of Nuxt's progressive compatibility features preparing for version 4.
```vue [app.vue]
<script setup lang="ts">
const hello = capitalize('hello')
</script>
<template>
<div>
{{ hello }}
</div>
</template>
```
```ts [server/api/hello.get.ts]
export default defineEventHandler((event) => {
return {
hello: capitalize('hello')
}
})
```
## Auto Imports
Only files in the `shared/utils/` and `shared/types/` directories will be auto-imported. Files nested within subdirectories of these directories will not be auto-imported.
::tip
The way `shared/utils` and `shared/types` auto-imports work and are scanned is identical to the [`composables/`](/docs/guide/directory-structure/composables) and [`utils/`](/docs/guide/directory-structure/utils) directories.
::
:read-more{to="/docs/guide/directory-structure/composables#how-files-are-scanned"}
```bash [Directory Structure]
-| shared/
---| capitalize.ts # Not auto-imported
---| formatters
-----| lower.ts # Not auto-imported
---| utils/
-----| lower.ts # Auto-imported
-----| formatters
-------| upper.ts # Not auto-imported
---| types/
-----| bar.d.ts # Auto-imported
```
Any other files you create in the `shared/` folder must be manually imported using the `#shared` alias (automatically configured by Nuxt):
```ts
// For files directly in the shared directory
import capitalize from '#shared/capitalize'
// For files in nested directories
import lower from '#shared/formatters/lower'
// For files nested in a folder within utils
import upper from '#shared/utils/formatters/upper'
```
This alias ensures consistent imports across your application, regardless of the importing file's location.
:read-more{to="/docs/guide/concepts/auto-imports"}