mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-30 01:17:16 +00:00
1.2 KiB
1.2 KiB
icon | title | head.title |
---|---|---|
IconDirectory | composables | Composables directory |
Composables directory
Nuxt 3 supports composables/
directory to automatically import your Vue composables into your application using auto-imports!
How files are scanned
Only files at the top level of the composables/
directory (or index files within any subdirectories) will be scanned for composables.
For example:
composables
| - useFoo.ts
| - useBar
| --- supportingFile.ts
| --- index.ts
Only useFoo.ts
and useBar/index.ts
would be searched for imports - and if the latter is a default export, it would be registered as useBar
rather than index
.
Example: (using named export)
import { useState } from '#app'
export const useFoo = () => {
return useState('foo', () => 'bar')
}
Example: (using default export)
import { useState } from '#app'
// It will be available as useFoo() (camelCase of file name without extension)
export default function () {
return useState('foo', () => 'bar')
}
You can now auto-import it:
<template>
<div>
{{ foo }}
</div>
</template>
<script setup>
const foo = useFoo()
</script>