Nuxt 会自动导入此目录中的任何组件（以及您可能正在使用的任何模块注册的组件）。

-| components/
---| AppHeader.vue
---| AppFooter.vue

<template>
  <div>
    <AppHeader />
    <NuxtPage />
    <AppFooter />
  </div>
</template>

组件名称

如果您有一个组件位于嵌套目录中，例如：

-| components/
---| base/
-----| foo/
-------| Button.vue

...那么组件的名称将基于其路径目录和文件名，并去除重复的部分。因此，组件的名称将是：

<BaseFooButton />

如果您希望仅根据名称而不是路径自动导入组件，则需要使用配置对象的扩展形式将 pathPrefix 选项设置为 false：

export default defineNuxtConfig({
  components: [
    {
      path: '~/components',
      pathPrefix: false, // [!code ++]
    },
  ],
});

这将使用与 Nuxt 2 中相同的策略注册组件。例如，~/components/Some/MyComponent.vue 将可以用作 <MyComponent> 而不是 <SomeMyComponent>。

动态组件

如果您想使用 Vue 的 <component :is="someComputedComponent"> 语法，您需要使用 Vue 提供的 resolveComponent 辅助函数，或者直接从 #components 导入组件并将其传递给 is 属性。

例如：

<script setup lang="ts">
import { SomeComponent } from '#components'

const MyButton = resolveComponent('MyButton')
</script>

<template>
  <component :is="clickable ? MyButton : 'div'" />
  <component :is="SomeComponent" />
</template>

或者，虽然不推荐，您可以全局注册所有组件，这将为所有组件创建异步块，并使它们在整个应用程序中可用。

  export default defineNuxtConfig({
    components: {
+     global: true,
+     dirs: ['~/components']
    },
  })

您还可以通过将某些组件放在 ~/components/global 目录中，或在文件名中使用 .global.vue 后缀来选择性地全局注册某些组件。如上所述，每个全局组件都在单独的块中呈现，因此请小心不要过度使用此功能。

动态导入

要动态导入组件（也称为懒加载组件），您只需在组件名称前添加 Lazy 前缀即可。如果组件并不总是需要，这特别有用。

通过使用 Lazy 前缀，您可以推迟加载组件代码直到合适的时机，这有助于优化 JavaScript 包的大小。

<script setup lang="ts">
const show = ref(false)
</script>

<template>
  <div>
    <h1>Mountains</h1>
    <LazyMountainsList v-if="show" />
    <button v-if="!show" @click="show = true">Show List</button>
  </div>
</template>

延迟（或懒）水合

懒组件非常适合控制应用程序中的块大小，但它们并不总是能提高运行时性能，因为除非有条件地渲染，否则它们仍然会急切加载。在实际应用中，一些页面可能包含大量内容和组件，并且大多数时候并不需要所有组件在页面加载时立即交互。让它们全部急切加载可能会对性能产生负面影响。

为了优化您的应用程序，您可能希望推迟某些组件的水合，直到它们可见，或者直到浏览器完成更重要的任务。

Nuxt 支持使用懒（或延迟）水合，允许您控制组件何时变得可交互。

水合策略

Nuxt 提供了一系列内置的水合策略。每个懒组件只能使用一种策略。

hydrate-on-visible

当组件在视口中可见时进行水合。

<template>
  <div>
    <LazyMyComponent hydrate-on-visible />
  </div>
</template>

hydrate-on-idle

当浏览器空闲时进行水合。如果您需要组件尽快加载，但不阻塞关键渲染路径，这是合适的。

您还可以传递一个数字作为最大超时时间。

<template>
  <div>
    <LazyMyComponent hydrate-on-idle />
  </div>
</template>

hydrate-on-interaction

在指定的交互（例如，点击，鼠标悬停）后进行水合。

<template>
  <div>
    <LazyMyComponent hydrate-on-interaction="mouseover" />
  </div>
</template>

如果您没有传递事件或事件列表，它默认在 pointerenter 和 focus 上进行水合。

hydrate-on-media-query

当窗口匹配媒体查询时进行水合。

<template>
  <div>
    <LazyMyComponent hydrate-on-media-query="(max-width: 768px)" />
  </div>
</template>

hydrate-after

在指定的延迟（以毫秒为单位）后进行水合。

<template>
  <div>
    <LazyMyComponent :hydrate-after="2000" />
  </div>
</template>

hydrate-when

基于布尔条件进行水合。

<template>
  <div>
    <LazyMyComponent :hydrate-when="isReady" />
  </div>
</template>
<script setup lang="ts">
const isReady = ref(false)
function myFunction() {
  // 触发自定义水合策略...
  isReady.value = true
}
</script>

hydrate-never

永不水合组件。

<template>
  <div>
    <LazyMyComponent hydrate-never />
  </div>
</template>

监听水合事件

所有延迟水合组件在水合时都会发出 @hydrated 事件。

<template>
  <div>
    <LazyMyComponent hydrate-on-visible @hydrated="onHydrate" />
  </div>
</template>

<script setup lang="ts">
function onHydrate() {
  console.log("组件已被水合！")
}
</script>

注意事项和最佳实践

延迟水合可以提供性能优势，但正确使用它至关重要：

1. 优先考虑视口内的内容： 避免对关键的、首屏内容进行延迟水合。它最适合不立即需要的内容。

2. 条件渲染： 在懒组件上使用 v-if="false" 时，您可能不需要延迟水合。您可以只使用普通的懒组件。

3. 共享状态： 注意跨多个组件的共享状态（v-model）。在一个组件中更新模型可能会触发所有绑定到该模型的组件的水合。

4. 使用每个策略的预期用例： 每个策略都针对特定目的进行了优化。

   • hydrate-when 最适合可能不总是需要水合的组件。
   • hydrate-after 适用于可以等待特定时间的组件。
   • hydrate-on-idle 适用于可以在浏览器空闲时水合的组件。

5. 避免在交互组件上使用 hydrate-never： 如果组件需要用户交互，则不应设置为永不水合。

直接导入

如果您希望或需要绕过 Nuxt 的自动导入功能，您也可以从 #components 显式导入组件。

<script setup lang="ts">
import { NuxtLink, LazyMountainsList } from '#components'

const show = ref(false)
</script>

<template>
  <div>
    <h1>Mountains</h1>
    <LazyMountainsList v-if="show" />
    <button v-if="!show" @click="show = true">Show List</button>
    <NuxtLink to="/">Home</NuxtLink>
  </div>
</template>

自定义目录

默认情况下，仅扫描 ~/components 目录。如果您想添加其他目录，或更改如何在此目录的子文件夹中扫描组件，您可以将其他目录添加到配置中：

export default defineNuxtConfig({
  components: [
    // ~/calendar-module/components/event/Update.vue => <EventUpdate />
    { path: '~/calendar-module/components' },

    // ~/user-module/components/account/UserDeleteDialog.vue => <UserDeleteDialog />
    { path: '~/user-module/components', pathPrefix: false },

    // ~/components/special-components/Btn.vue => <SpecialBtn />
    { path: '~/components/special-components', prefix: 'Special' },

    // 如果您希望对 `~/components` 的子目录应用覆盖，确保这最后出现。
    //
    // ~/components/Btn.vue => <Btn />
    // ~/components/base/Btn.vue => <BaseBtn />
    '~/components'
  ]
})

npm 包

如果您想从 npm 包自动导入组件，可以在 本地模块 中使用 addComponent 来注册它们。

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

export default defineNuxtModule({
  setup() {
    // import { MyComponent as MyAutoImportedComponent } from 'my-npm-package'
    addComponent({
      name: 'MyAutoImportedComponent',
      export: 'MyComponent',
      filePath: 'my-npm-package',
    })
  },
})

组件扩展

默认情况下，任何具有在 nuxt.config.ts 的 extensions 键 中指定的扩展名的文件都被视为组件。 如果您需要限制应注册为组件的文件扩展名，可以使用组件目录声明的扩展形式及其 extensions 键：

export default defineNuxtConfig({
  components: [
    {
      path: '~/components',
      extensions: ['.vue'], // [!code ++]
    }
  ]
})

客户端组件

如果组件仅在客户端渲染，您可以在组件中添加 .client 后缀。

| components/
--| Comments.client.vue

<template>
  <div>
    <!-- 此组件将仅在客户端渲染 -->
    <Comments />
  </div>
</template>

服务器组件

服务器组件允许在客户端应用程序中进行服务器渲染单个组件。即使您正在生成静态站点，也可以在 Nuxt 中使用服务器组件。这使得构建复杂的站点成为可能，这些站点混合了动态组件、服务器渲染的 HTML 甚至静态的标记块。

服务器组件可以单独使用，也可以与 客户端组件 配对使用。

独立服务器组件

独立服务器组件将始终在服务器上渲染，也称为 Islands 组件。

当它们的属性更新时，这将导致网络请求更新就地渲染的 HTML。

服务器组件目前是实验性的，为了使用它们，您需要在 nuxt.config 中启用 'component islands' 功能：

export default defineNuxtConfig({
  experimental: {
    componentIslands: true
  }
})

现在，您可以使用 .server 后缀注册仅服务器组件，并在应用程序中的任何地方自动使用它们。

-| components/
---| HighlightedMarkdown.server.vue

<template>
  <div>
    <!--
      这将自动在服务器上渲染，这意味着您的 markdown 解析 + 高亮库不会包含在客户端包中。
     -->
    <HighlightedMarkdown markdown="# Headline" />
  </div>
</template>

仅服务器组件在底层使用 <NuxtIsland>，这意味着 lazy 属性和 #fallback 插槽都传递给它。

服务器组件中的客户端组件

您可以通过在希望客户端加载的组件上设置 nuxt-client 属性来部分水合组件。

<template>
  <div>
    <HighlightedMarkdown markdown="# Headline" />
    <!-- Counter 将在客户端加载和水合 -->
    <Counter nuxt-client :count="5" />
  </div>
</template>

服务器组件上下文

在渲染仅服务器或 island 组件时，<NuxtIsland> 发起一个 fetch 请求，该请求返回一个 NuxtIslandResponse。（如果在服务器上渲染，这是一个内部请求，如果在客户端导航时渲染，您可以在网络选项卡中看到该请求。）

这意味着：

• 将在服务器端创建一个新的 Vue 应用程序以创建 NuxtIslandResponse。
• 在渲染组件时将创建一个新的 'island context'。
• 您无法从应用程序的其余部分访问 'island context'，也无法从 island 组件访问应用程序的其余部分的上下文。换句话说，服务器组件或 island 是与应用程序的其余部分隔离的。
• 在渲染 island 时，您的插件将再次运行，除非它们设置了 env: { islands: false }（您可以在对象语法插件中进行设置）。

在 island 组件中，您可以通过 nuxtApp.ssrContext.islandContext 访问其 island 上下文。请注意，虽然 island 组件仍标记为实验性，但此上下文的格式可能会更改。

与客户端组件配对

在这种情况下，.server + .client 组件是组件的两个“半部分”，可以用于在服务器和客户端侧分别实现组件的高级用例。

-| components/
---| Comments.client.vue
---| Comments.server.vue

<template>
  <div>
    <!-- 此组件将在服务器上渲染 Comments.server，然后在浏览器中挂载后渲染 Comments.client -->
    <Comments />
  </div>
</template>

内置 Nuxt 组件

Nuxt 提供了许多组件，包括 <ClientOnly> 和 <DevOnly>。您可以在 API 文档中阅读更多关于它们的信息。

库作者

制作具有自动 tree-shaking 和组件注册功能的 Vue 组件库非常简单。✨

您可以使用 @nuxt/kit 提供的 addComponentsDir 方法在 Nuxt 模块中注册组件目录。

想象一下这样的目录结构：

-| node_modules/
---| awesome-ui/
-----| components/
-------| Alert.vue
-------| Button.vue
-----| nuxt.ts
-| pages/
---| index.vue
-| nuxt.config.ts

然后在 awesome-ui/nuxt.ts 中，您可以使用 addComponentsDir 钩子：

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

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

    // 添加 ./components 目录到列表中
    addComponentsDir({
      path: resolver.resolve('./components'),
      prefix: 'awesome',
    })
  },
})

就是这样！现在在您的项目中，您可以在 nuxt.config 文件中将您的 UI 库作为 Nuxt 模块导入：

export default defineNuxtConfig({
  modules: ['awesome-ui/nuxt']
})

... 然后直接在我们的 pages/index.vue 中使用模块组件（以 awesome- 为前缀）：

<template>
  <div>
    My <AwesomeButton>UI button</AwesomeButton>!
    <awesome-alert>Here's an alert!</awesome-alert>
  </div>
</template>

它将仅在使用时自动导入组件，并在更新 node_modules/awesome-ui/components/ 中的组件时支持 HMR。