composables
使用composables/目录将你的Vue组合式函数自动导入到你的应用程序中。
使用方法
方法1： 使用命名导出
composables/useFoo.ts
export const useFoo = () => {
return useState('foo', () => 'bar')
}
方法2： 使用默认导出
composables/use-foo.ts 或 composables/useFoo.ts
// 它将作为 useFoo() 可用（文件名的驼峰形式，不包括扩展名）
export default function () {
return useState('foo', () => 'bar')
}
使用方法： 现在你可以在 .js、.ts 和 .vue 文件中使用自动导入的组合函数
app.vue
<script setup lang="ts">
const foo = useFoo()
</script>
<template>
<div>
{{ foo }}
</div>
</template>
Read and edit a live example in Docs > Examples > Features > Auto Imports.
类型
在内部，Nuxt 会自动生成文件 .nuxt/imports.d.ts 来声明类型。
请注意，你必须运行 nuxi prepare、nuxi dev 或 nuxi build，以便让 Nuxt 生成类型。
如果你在没有运行开发服务器的情况下创建一个组合函数，TypeScript 将会抛出一个错误，如
Cannot find name 'useBar'.示例
嵌套组合函数
你可以在另一个组合函数中使用自动导入的组合函数：
composables/test.ts
export const useFoo = () => {
const nuxtApp = useNuxtApp()
const bar = useBar()
}
访问插件注入
你可以在组合函数中访问插件注入：
composables/test.ts
export const useHello = () => {
const nuxtApp = useNuxtApp()
return nuxtApp.$hello
}
文件扫描方式
Nuxt 仅扫描位于 composables/ 目录的顶级文件，例如：
目录结构
| composables/
---| index.ts // 被扫描
---| useFoo.ts // 被扫描
-----| nested/
-------| utils.ts // 不被扫描
只有 composables/index.ts 和 composables/useFoo.ts 会被搜索导入。
要使嵌套模块的自动导入工作，你可以重新导出它们（推荐）或配置扫描器以包括嵌套目录：
示例： 从 composables/index.ts 文件中重新导出你需要的组合函数：
composables/index.ts
// 启用对此导出的自动导入
export { utils } from './nested/utils.ts'
示例： 扫描 composables/ 文件夹中的嵌套目录：
nuxt.config.ts
export default defineNuxtConfig({
imports: {
dirs: [
// 扫描顶级模块
'composables',
// ... 或扫描带有特定名称和文件扩展名的一级嵌套模块
'composables/*/index.{ts,js,mjs,mts}',
// ... 或扫描给定目录中的所有模块
'composables/**'
]
}
})