组件

Nuxt Kit 提供了一组工具来帮助你处理组件。你可以全局或局部注册组件，也可以添加需要扫描组件的目录。

组件是 Nuxt 应用的基础构建块。它们是可重用的 Vue 实例，可用于创建用户界面。在 Nuxt 中，默认会自动导入 components 目录中的组件。然而，如果你需要从其他目录导入组件或希望按需选择性地导入组件，@nuxt/kit 提供了 addComponentsDir 和 addComponent 方法。这些工具允许你自定义组件配置，以更好地满足你的需求。

观看 Vue School 关于注入组件的视频。

`addComponentsDir`

注册一个目录以扫描组件，并仅在使用时导入。请注意，除非你指定 global: true 选项，否则此方法不会全局注册组件。

使用方法

export default defineNuxtModule({
  meta: {
    name: '@nuxt/ui',
    configKey: 'ui',
  },
  setup() {
    addComponentsDir({
      path: resolve('./runtime/components'),
      prefix: 'U',
      pathPrefix: false
    })
  }
})

类型

function addComponentsDir (dir: ComponentsDir, opts: { prepend?: boolean } = {}): void

参数

dir 一个具有以下属性的对象：

属性	类型	是否必需	描述
`path`	`string`	`true`	包含组件的目录的路径（绝对或相对）。你可以使用 Nuxt 别名（~ 或 @）来引用项目内的目录，或直接使用类似 require 的 npm 包路径。
`pattern`	`string \| string[]`	`false`	对指定路径运行的接受模式。
`ignore`	`string[]`	`false`	对指定路径运行的忽略模式。
`prefix`	`string`	`false`	为所有匹配的组件添加此前缀字符串。
`pathPrefix`	`boolean`	`false`	按组件路径为组件名称添加前缀。
`enabled`	`boolean`	`false`	如果设置为 `true`，忽略扫描此目录。
`prefetch`	`boolean`	`false`	这些属性（prefetch/preload）在生产环境中用于通过 Webpack 的魔法注释配置带有 Lazy 前缀的组件处理方式。了解更多请查看 Webpack 文档。
`preload`	`boolean`	`false`	这些属性（prefetch/preload）在生产环境中用于通过 Webpack 的魔法注释配置带有 Lazy 前缀的组件处理方式。了解更多请查看 Webpack 文档。
`isAsync`	`boolean`	`false`	此标志表示组件应异步加载（带有单独的 chunk），无论是否使用 Lazy 前缀。
`extendComponent`	`(component: Component) => Promise<Component \| void> \| (Component \| void)`	`false`	一个函数，对目录中找到的每个组件调用。它接受一个组件对象，并应返回一个组件对象或解析为组件对象的 Promise。
`global`	`boolean`	`false`	如果启用，注册组件以全局可用。
`island`	`boolean`	`false`	如果启用，注册组件为岛屿组件。了解更多请查看 `<NuxtIsland/>` 组件描述。
`watch`	`boolean`	`false`	监视指定路径的变化，包括文件添加和删除。
`extensions`	`string[]`	`false`	Nuxt 构建器支持的扩展名。
`transpile`	`'auto' \| boolean`	`false`	使用 build.transpile 转译指定路径。如果设置为 `'auto'`，当路径中包含 `node_modules/` 时，将设置 `transpile: true`。

opts

属性	类型	是否必需	描述
`prepend`	`boolean`	`false`	如果设置为 `true`，目录将通过 `unshift()` 插入数组开头，而不是通过 `push()` 追加。

`addComponent`

注册一个组件以自动导入。

使用方法

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

export default defineNuxtModule({
  meta: {
    name: '@nuxt/image',
    configKey: 'image',
  },
  async setup() {
    const resolver = createResolver(import.meta.url)

    addComponent({
      name: 'NuxtImg',
      filePath: resolver.resolve('./runtime/components/NuxtImg.vue'),
    })

    addComponent({
      name: 'NuxtPicture',
      filePath: resolver.resolve('./runtime/components/NuxtPicture.vue'),
    })
  },
})

类型

function addComponent (options: AddComponentOptions): void

参数

options：一个具有以下属性的对象：

属性	类型	是否必需	描述
`name`	`string`	`true`	组件名称。
`filePath`	`string`	`true`	组件的路径。
`pascalName`	`string`	`false`	帕斯卡命名法的组件名称。如果未提供，将根据组件名称生成。
`kebabName`	`string`	`false`	短横线命名法的组件名称。如果未提供，将根据组件名称生成。
`export`	`string`	`false`	指定命名导出或默认导出。如果未提供，将设置为 `'default'`。
`shortPath`	`string`	`false`	组件的短路径。如果未提供，将根据组件路径生成。
`chunkName`	`string`	`false`	组件的 chunk 名称。如果未提供，将根据组件名称生成。
`prefetch`	`boolean`	`false`	这些属性（prefetch/preload）在生产环境中用于通过 Webpack 的魔法注释配置带有 Lazy 前缀的组件处理方式。了解更多请查看 Webpack 文档。
`preload`	`boolean`	`false`	这些属性（prefetch/preload）在生产环境中用于通过 Webpack 的魔法注释配置带有 Lazy 前缀的组件处理方式。了解更多请查看 Webpack 文档。
`global`	`boolean`	`false`	如果启用，注册组件以全局可用。
`island`	`boolean`	`false`	如果启用，注册组件为岛屿组件。了解更多请查看 `<NuxtIsland/>` 组件描述。
`mode`	`'client' \| 'server' \| 'all'`	`false`	此选项指示组件应在客户端、服务器还是两者上渲染。默认情况下，它将在客户端和服务器上渲染。
`priority`	`number`	`false`	组件的优先级，如果多个组件具有相同名称，将使用优先级最高的组件。

Report an issue or Edit this page on GitHub

自动导入

Nuxt Kit 提供了一组工具来帮助你处理自动导入。这些函数允许你注册自己的工具函数、组合式函数和 Vue API。

上下文

Nuxt Kit 提供了一组实用工具，帮助你处理上下文。