自动导入

源文件
Nuxt Kit 提供了一组实用工具，帮助你处理自动导入。这些函数允许你注册自己的工具函数、组合式函数（composables）和 Vue API。

Nuxt 会自动导入辅助函数、组合式函数和 Vue API，以便在整个应用程序中使用，而无需显式导入它们。根据目录结构，每个 Nuxt 应用程序还可以为其自身的组合式函数和插件使用自动导入。

使用 Nuxt Kit，你还可以添加自己的自动导入。addImports 和 addImportsDir 允许你向 Nuxt 应用程序添加导入。addImportsSources 允许你向 Nuxt 应用程序添加来自第三方包的列出的导入。

这些实用工具由 unimport 提供支持，它提供了 Nuxt 中使用的底层自动导入机制。

这些函数旨在用于注册你自己的工具函数、组合式函数和 Vue API。对于页面、组件和插件，请参阅具体章节：页面、组件、插件。
观看关于自动导入 Nuxt Kit 实用工具的 Vue School 视频。

addImports

向 Nuxt 应用程序添加导入。它使你的导入在 Nuxt 应用上下文中可用，而无需手动导入它们。

要为 Nitro 服务端上下文添加导入，请参考 addServerImports 函数。

使用

import { addImports, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options, nuxt) {
    const names = [
      'useStoryblok',
      'useStoryblokApi',
      'useStoryblokBridge',
      'renderRichText',
      'RichTextSchema',
    ]

    names.forEach(name =>
      addImports({ name, as: name, from: '@storyblok/vue' }),
    )
  },
})

类型

function addImports (imports: Import | Import[]): void

参数

imports：具有以下属性的对象或对象数组

属性类型必需描述
namestringtrue要检测的导入名称。
fromstringtrue要导入的模块说明符。
prioritynumberfalse导入的优先级；如果多个导入具有相同的名称，将使用优先级最高的一个。
disabledbooleanfalse是否禁用此导入。
metaRecord<string, any>false导入的元数据。
类型booleanfalse此导入是否为纯类型导入。
typeFromstringfalse在生成类型声明时，将此值用作 from 值。
asstringfalse作为此名称导入。

addImportsDir

从目录向 Nuxt 应用程序添加导入。它将自动导入该目录中的所有文件，并在 Nuxt 应用程序中使它们可用，而无需手动导入。

使用

import { addImportsDir, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: '@vueuse/motion',
    configKey: 'motion',
  },
  setup (options, nuxt) {
    const resolver = createResolver(import.meta.url)
    addImportsDir(resolver.resolve('./runtime/composables'))
  },
})

类型

function addImportsDir (dirs: string | string[], options?: { prepend?: boolean }): void

参数

属性类型必需描述
dirsstring | string[]true一个字符串或字符串数组，包含要导入的目录的路径。
options{ prepend?: boolean }false传递给导入的选项。如果将 prepend 设置为 true，则导入将置于导入列表的开头。

addImportsSources

将列出的导入添加到 Nuxt 应用程序中。

使用

import { addImportsSources, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup () {
    addImportsSources([
      { package: '@vueuse/core' },
      {
        from: 'h3',
        imports: [
          'defineEventHandler',
          'getQuery',
          'getRouterParams',
          'readBody',
          'sendRedirect',
        ],
      },
    ])
  },
})

类型

function addImportsSources (importSources: Preset | Preset[]): void

参数

importSources：具有以下属性的对象或对象数组

  • InlinePreset
属性类型必需描述
fromstringtrue要导入的模块说明符。
imports (导入)PresetImport | ImportSource[]true对象或对象数组，可以是导入名称、导入对象或导入源。
  • PackagePreset
属性类型必需描述
packagestringtrue包的名称。