2021-10-11 12:57:54 +00:00
---
icon: IconDirectory
title: 'composables'
head.title: Composables directory
---
# Composables directory
2021-11-21 12:31:44 +00:00
Nuxt 3 supports `composables/` directory to automatically import your Vue composables into your application using auto-imports!
2021-10-20 09:47:18 +00:00
2022-01-18 16:43:41 +00:00
## 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:
```bash
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)
2021-10-20 09:47:18 +00:00
```js [composables/useFoo.ts]
import { useState } from '#app'
2021-10-22 10:17:09 +00:00
export const useFoo = () => {
2021-10-20 09:47:18 +00:00
return useState('foo', () => 'bar')
}
```
2022-01-18 16:43:41 +00:00
## Example: (using default export)
2021-10-20 09:47:18 +00:00
```js [composables/use-foo.ts or composables/useFoo.ts]
import { useState } from '#app'
2022-01-18 16:36:29 +00:00
// It will be available as useFoo() (camelCase of file name without extension)
2021-10-20 09:47:18 +00:00
export default function () {
2021-12-20 10:36:25 +00:00
return useState('foo', () => 'bar')
2021-10-20 09:47:18 +00:00
}
```
2021-11-21 12:31:44 +00:00
You can now auto-import it:
2021-10-20 09:47:18 +00:00
```vue [app.vue]
< template >
< div >
{{ foo }}
< / div >
< / template >
< script setup >
const foo = useFoo()
< / script >
```