自动导入

Nuxt 自动导入帮助函数、组合件和 Vue API，以便在整个应用程序中使用，而无需显式导入它们。根据目录结构，每个 Nuxt 应用程序也可以为其自己的组合件和插件使用自动导入。使用 Nuxt Kit，您还可以添加自己的自动导入。addImports 和 addImportsDir 允许您向 Nuxt 应用程序添加导入。addImportsSources 允许您将列出的导入从第三方包添加到 Nuxt 应用程序。

这些函数旨在注册您自己的工具、组合件和 Vue API。对于页面、组件和插件，请参考特定部分：Pages、Components、Plugins。

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

观看 Vue School 关于 Nuxt Kit 自动导入工具的视频。

`addImports`

将导入添加到 Nuxt 应用程序。它使您的导入在 Nuxt 应用程序中可用，无需手动导入。

类型

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

interface Import {
  from: string
  priority?: number
  disabled?: boolean
  meta?: {
    description?: string
    docsUrl?: string
    [key: string]: any
  }
  type?: boolean
  typeFrom?: string
  name: string
  as?: string
}

参数

`imports`

类型: Import | Import[]

必填: true

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

from（必需）
类型: string
要从中导入的模块规范器。
priority（可选）
类型: number
默认: 1
导入的优先级，如果多个导入具有相同的名称，则优先级最高的一个将被使用。
disabled（可选）
类型: boolean
如果此导入被禁用。
meta（可选）
类型: object
导入的元数据。
meta.description（可选）
类型: string
导入的简短描述。
meta.docsUrl（可选）
类型: string
文档的 URL。
meta[key]（可选）
类型: any
附加元数据。
type（可选）
类型: boolean
如果此导入是一个纯粹的类型导入。
typeFrom（可选）
类型: string
生成类型声明时使用这个作为 from。
name（必需）
类型: string
要检测的导入名称。
as（可选）
类型: string
以这个名称导入。

示例

// https://github.com/pi0/storyblok-nuxt
import { defineNuxtModule, addImports, createResolver } 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" })
    );
  }
})

`addImportsDir`

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

类型

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

参数

`dirs`

类型: string | string[]

必填: true

指向要从中导入的目录的字符串或字符串数组。

`options`

类型: { prepend?: boolean }

默认: {}

传递给导入的选项。如果 prepend 被设置为 true，导入将插入到导入列表的开头。

示例

// https://github.com/vueuse/motion/tree/main/src/nuxt
import { defineNuxtModule, addImportsDir, createResolver } 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'))
  },
})

`addImportsSources`

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

类型

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

interface Import {
  from: string
  priority?: number
  disabled?: boolean
  meta?: {
    description?: string
    docsUrl?: string
    [key: string]: any
  }
  type?: boolean
  typeFrom?: string
  name: string
  as?: string
}

interface ImportSource extends Import {
  imports: (PresetImport | ImportSource)[]
}

type PresetImport = Omit<Import, 'from'> | string | [name: string, as?: string, from?: string]

参数

`importSources`

类型: ImportSource | ImportSource[]

必填: true

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

imports（必需）
类型: PresetImport | ImportSource[]
必填: true
一个对象或对象数组，可以是导入名称、导入对象或导入源。
from（必需）
类型: string
要从中导入的模块规范器。
priority（可选）
类型: number
默认: 1
导入的优先级，如果多个导入具有相同的名称，则优先级最高的一个将被使用。
disabled（可选）
类型: boolean
如果此导入被禁用。
meta（可选）
类型: object
导入的元数据。
meta.description（可选）
类型: string
导入的简短描述。
meta.docsUrl（可选）
类型: string
文档的 URL。
meta[key]（可选）
类型: any
附加元数据。
type（可选）
类型: boolean
如果此导入是一个纯粹的类型导入。
typeFrom（可选）
类型: string
生成类型声明时使用这个作为 from。
name（必需）
类型: string
要检测的导入名称。
as（可选）
类型: string
以这个名称导入。

示例

// https://github.com/elk-zone/elk
import { defineNuxtModule, addImportsSources } from '@nuxt/kit'

export default defineNuxtModule({
  setup() {
    // 添加 h3 的导入以使它们自动导入
    addImportsSources({
      from: 'h3',
      imports: ['defineEventHandler', 'getQuery', 'getRouterParams', 'readBody', 'sendRedirect'] as Array<keyof typeof import('h3')>,
    })
  }
})

兼容性

Nuxt Kit 提供了一组工具，帮助您检查模块与不同 Nuxt 版本的兼容性。

组件

Nuxt Kit 提供了一系列工具来帮助您使用组件。您可以在全局或局部注册组件，还可以添加目录以扫描组件。