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 的 Composition 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/**',
    ],
  },
})