组件

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

addComponentsDir

注册一个要扫描组件并在使用时才导入的目录。请记住，除非您指定 global: true 选项，否则这不会全局注册组件。

类型

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

interface ComponentsDir {
  path: string
  pattern?: string | string[]
  ignore?: string[]
  prefix?: string
  pathPrefix?: boolean
  enabled?: boolean
  prefetch?: boolean
  preload?: boolean
  isAsync?: boolean
  extendComponent?: (component: Component) => Promise<Component | void> | (Component | void)
  global?: boolean
  island?: boolean
  watch?: boolean
  extensions?: string[]
  transpile?: 'auto' | boolean
}

// You can augment this interface (exported from `@nuxt/schema`) if needed
interface ComponentMeta {
  [key: string]: unknown
}

interface Component {
  pascalName: string
  kebabName: string
  export: string
  filePath: string
  shortPath: string
  chunkName: string
  prefetch: boolean
  preload: boolean
  global?: boolean
  island?: boolean
  mode?: 'client' | 'server' | 'all'
  priority?: number
  meta?: ComponentMeta
}

参数

dir

类型: ComponentsDir

必需: true

具有以下属性的对象

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

opts

必需: false

• prepend（可选）
  类型: boolean
  如果设置为 true，则目录将使用 unshift() 而不是 push() 前置到数组中。

addComponent

注册一个要自动导入的组件。

类型

async function addComponent (options: AddComponentOptions): void

interface AddComponentOptions {
  name: string,
  filePath: string,
  pascalName?: string,
  kebabName?: string,
  export?: string,
  shortPath?: string,
  chunkName?: string,
  prefetch?: boolean,
  preload?: boolean,
  global?: boolean,
  island?: boolean,
  mode?: 'client' | 'server' | 'all',
  priority?: number,
}

参数

选项

类型: AddComponentOptions

必需: true

具有以下属性的对象

• name (必需)
  类型: string
  组件名称。
• filePath (必需)
  类型: string
  组件的路径。
• pascalName (可选)
  类型: pascalCase(options.name)
  帕斯卡命名法的组件名称。如果未提供，将从组件名称生成。
• kebabName (可选)
  类型: kebabCase(options.name)
  短横线命名法的组件名称。如果未提供，将从组件名称生成。
• export (可选)
  类型: string
  默认值: 'default'
  指定具名导出或默认导出。如果未提供，将设置为 'default'。
• shortPath (可选)
  类型: string
  组件的短路径。如果未提供，将从组件路径生成。
• chunkName (可选)
  类型: string
  默认值: 'components/' + kebabCase(options.name)
  组件的代码块名称。如果未提供，将从组件名称生成。
• prefetch（可选）
  类型: boolean
  这些属性（prefetch/preload）在生产环境中用于配置 Webpack 如何通过其魔法注释处理具有 Lazy 前缀的组件。请在 Webpack 文档中了解更多信息
• preload（可选）
  类型: boolean
  这些属性（prefetch/preload）在生产环境中用于配置 Webpack 如何通过其魔法注释处理具有 Lazy 前缀的组件。请在 Webpack 文档中了解更多信息
• global（可选）
  类型: boolean
  默认值: false
  如果启用，则将组件注册为全局可用。
• island（可选）
  类型: boolean
  如果启用，则将组件注册为岛屿。你可以在 <NuxtIsland/> 组件描述中阅读有关岛屿的更多信息。
• mode (可选)
  类型: 'client' | 'server' | 'all'
  默认值: 'all'
  此选项指示组件应该在客户端、服务器端还是两者都渲染。默认情况下，它将在客户端和服务器端都渲染。
• priority (可选)
  类型: number
  默认值: 1
  组件的优先级，如果多个组件具有相同的名称，则将使用优先级最高的组件。