composables

使用 composables/ 目录将你的 Vue 组合式函数自动导入到应用中。

使用

方法 1：使用命名导出

app/composables/useFoo.ts
export const useFoo = () => {
  return useState('foo', () => 'bar')
}

方法 2：使用默认导出

app/composables/use-foo.ts 或 composables/useFoo.ts
// It will be available as useFoo() (camelCase of file name without extension)
export default function () {
  return useState('foo', () => 'bar')
}

用法：你现在可以在 .js、.ts 和 .vue 文件中使用自动导入的组合式函数了

app/app.vue
<script setup lang="ts">
const foo = useFoo()
</script>

<template>
  <div>
    {{ foo }}
  </div>
</template>
Nuxt 中的 app/composables/ 目录并未为你的代码提供任何额外的响应式能力。相反，组合式函数内的任何响应式特性都是通过 Vue 的组合式 API 机制（如 ref 和 reactive）来实现的。请注意，响应式代码也不仅限于 app/composables/ 目录的边界。你可以在应用中任何需要的地方自由使用响应式特性。
在文档 > 4 X > 指南 > 概念 > 自动导入中了解更多信息。
在 文档 > 4.X > 示例 > 功能 > 自动导入 中阅读并编辑实时示例。

类型

在底层，Nuxt 会自动生成 .nuxt/imports.d.ts 文件来声明类型。

请注意，你必须运行 nuxt prepare、nuxt dev 或 nuxt build 才能让 Nuxt 生成这些类型。

如果你在未运行开发服务器的情况下创建组合式函数，TypeScript 将会抛出错误，例如 Cannot find name 'useBar'.

示例

嵌套组合式函数

你可以在另一个组合式函数中通过自动导入使用某个组合式函数

app/composables/test.ts
export const useFoo = () => {
  const nuxtApp = useNuxtApp()
  const bar = useBar()
}

访问插件注入

你可以从组合式函数中访问 插件注入

app/composables/test.ts
export const useHello = () => {
  const nuxtApp = useNuxtApp()
  return nuxtApp.$hello
}

文件是如何被扫描的

Nuxt 仅扫描 app/composables/ 目录顶级的文件，例如：

目录结构
-| composables/
---| index.ts     // scanned
---| useFoo.ts    // scanned
---| nested/
-----| utils.ts   // not scanned

只有 app/composables/index.ts 和 app/composables/useFoo.ts 会被搜索以进行导入。

为了使嵌套模块的自动导入生效，你要么重新导出它们（推荐），要么配置扫描器以包含嵌套目录

示例：从 app/composables/index.ts 文件中重新导出你需要的组合式函数

app/composables/index.ts
// Enables auto import for this export
export { utils } from './nested/utils.ts'

示例：扫描 app/composables/ 文件夹内的嵌套目录

nuxt.config.ts
export default defineNuxtConfig({
  imports: {
    dirs: [
      // Scan top-level composables
      '~/composables',
      // ... or scan composables nested one level deep with a specific name and file extension
      '~/composables/*/index.{ts,js,mjs,mts}',
      // ... or scan all composables within given directory
      '~/composables/**',
    ],
  },
})