自动导入

源码
Nuxt Kit 提供一组实用工具，帮助你使用自动导入。这些函数允许你注册你自己的工具、composables 和 Vue API。

Nuxt 会自动导入辅助函数、composables 和 Vue API，以便在应用中使用而无需显式导入。基于目录结构，每个 Nuxt 应用也可以为其自身的 composables 和插件使用自动导入。

使用 Nuxt Kit 你也可以添加自定义的自动导入。addImports 和 addImportsDir 允许你向 Nuxt 应用添加导入。addImportsSources 允许你将第三方包中列出的导入添加到 Nuxt 应用中。

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

这些函数用于注册你自己的工具、composables 和 Vue API。对于页面、组件和插件，请参考相应章节：Pages, Components, Plugins。
观看 Vue School 关于 Nuxt Kit 自动导入实用工具的视频。

addImports

向 Nuxt 应用添加导入。它使你的导入在 Nuxt 应用中可用，而无需手动导入。

用法

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导入的元数据。
typebooleanfalse此导入是否为纯类型导入。
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({
      from: 'h3',
      imports: [
        'defineEventHandler',
        'getQuery',
        'getRouterParams',
        'readBody',
        'sendRedirect',
      ],
    })
  },
})

类型

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

参数

importSources：一个对象或对象数组，具有以下属性：

属性类型必需描述
fromstringtrue要从中导入的模块说明符。
importsPresetImport | ImportSource[]true一个对象或对象数组，可以是导入名称、导入对象或导入源。