Plugins

插件是自包含的代码，通常用于向 Vue 添加应用级功能。在 Nuxt 中，插件会自动从 plugins 目录中导入。然而，如果你需要将插件与你的模块一起发布，Nuxt Kit 提供了 addPlugin 和 addPluginTemplate 方法。这些工具允许你自定义插件配置，以更好地适应你的需求。

addPlugin

注册一个 Nuxt 插件到插件数组中。

类型

function addPlugin (plugin: NuxtPlugin | string, options: AddPluginOptions): NuxtPlugin

interface NuxtPlugin {
  src: string
  mode?: 'all' | 'server' | 'client'
  order?: number
}

interface AddPluginOptions { append?: boolean }

参数

plugin

类型: NuxtPlugin | string

必填: true

一个插件对象或一个包含插件路径的字符串。如果提供了一个字符串，它将被转换为一个插件对象，其中 src 属性设置为字符串值。如果提供了一个插件对象，它必须具有以下属性:

• src (必填)
  类型: string
  插件的路径。
• mode (可选)
  类型: 'all' | 'server' | 'client'
  默认值: 'all'
  如果设置为 'all'，插件将包含在客户端和服务器端的捆绑包中。如果设置为 'server'，插件将仅包含在服务器端的捆绑包中。如果设置为 'client'，插件将仅包含在客户端的捆绑包中。你还可以在指定 src 选项时使用 .client 和 .server 修饰符，以仅在客户端或服务器端使用插件。
• order (可选)
  类型: number
  默认值: 0
  插件的顺序。这允许更细粒度地控制插件的顺序，应仅由高级用户使用。较低的数字先运行，用户插件默认为 0。建议将 order 设置为 -20 到 20 之间的数字，用于 pre-plugins（在 Nuxt 插件之前运行的插件）和 post-plugins（在 Nuxt 插件之后运行的插件）。

options

类型: AddPluginOptions

默认值: {}

传递给插件的选项。如果 append 设置为 true，插件将被追加到插件数组的末尾，而不是插入到开头。

示例

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

export default defineNuxtModule({
  setup() {
    const resolver = createResolver(import.meta.url)

    addPlugin({
      src: resolver.resolve('runtime/plugin.js'),
      mode: 'client'
    })
  }
})

addPluginTemplate

添加一个模板并注册为 Nuxt 插件。这对于需要在构建时生成代码的插件非常有用。

类型

function addPluginTemplate (pluginOptions: NuxtPluginTemplate, options: AddPluginOptions): NuxtPlugin

interface NuxtPluginTemplate<Options = Record<string, any>> {
  src?: string,
  filename?: string,
  dst?: string,
  mode?: 'all' | 'server' | 'client',
  options?: Options,
  getContents?: (data: Options) => string | Promise<string>,
  write?: boolean,
  order?: number
}

interface AddPluginOptions { append?: boolean }

interface NuxtPlugin {
  src: string
  mode?: 'all' | 'server' | 'client'
  order?: number
}

参数

pluginOptions

类型: NuxtPluginTemplate

必填: true

一个包含以下属性的插件模板对象:

• src (可选)
  类型: string
  模板的路径。如果未提供 src，则必须提供 getContents。
• filename (可选)
  类型: string
  模板的文件名。如果未提供 filename，它将从 src 路径生成。在这种情况下，src 选项是必需的。
• dst (可选)
  类型: string
  目标文件的路径。如果未提供 dst，它将从 filename 路径和 nuxt 的 buildDir 选项生成。
• mode (可选)
  类型: 'all' | 'server' | 'client'
  默认值: 'all'
  如果设置为 'all'，插件将包含在客户端和服务器端的捆绑包中。如果设置为 'server'，插件将仅包含在服务器端的捆绑包中。如果设置为 'client'，插件将仅包含在客户端的捆绑包中。你还可以在指定 src 选项时使用 .client 和 .server 修饰符，以仅在客户端或服务器端使用插件。
• options (可选)
  类型: Options
  传递给模板的选项。
• getContents (可选)
  类型: (data: Options) => string | Promise<string>
  一个将使用 options 对象调用的函数。它应返回一个字符串或一个解析为字符串的 promise。如果提供了 src，则会忽略此函数。
• write (可选)
  类型: boolean
  如果设置为 true，模板将被写入目标文件。否则，模板将仅在虚拟文件系统中使用。
• order (可选)
  类型: number
  默认值: 0
  插件的顺序。这允许更细粒度地控制插件的顺序，应仅由高级用户使用。较低的数字先运行，用户插件默认为 0。建议将 order 设置为 -20 到 20 之间的数字，用于 pre-plugins（在 Nuxt 插件之前运行的插件）和 post-plugins（在 Nuxt 插件之后运行的插件）。

options

类型: AddPluginOptions

默认值: {}

传递给插件的选项。如果 append 设置为 true，插件将被追加到插件数组而不是插入到开头。

示例

// https://github.com/vuejs/vuefire
import { createResolver, defineNuxtModule, addPluginTemplate } from '@nuxt/kit'

export default defineNuxtModule({
  setup() {
    const resolver = createResolver(import.meta.url)

    addPluginTemplate({
      src: resolve(templatesDir, 'plugin.ejs'),
      options: {
        ...options,
        ssr: nuxt.options.ssr,
      },
    })
  }
})