---
title: "defineLazyHydrationComponent"
description: "定义一个具有特定策略的懒加载水合组件。"
canonical_url: "https://nuxt.zhcndoc.com/docs/3.x/api/utils/define-lazy-hydration-component"
---
# defineLazyHydrationComponent

> 定义一个具有特定策略的懒加载水合组件。

`defineLazyHydrationComponent` 是一个编译器宏，用于帮助你创建具有特定懒加载水合策略的组件。懒加载水合会延迟水合操作，直到组件可见或浏览器完成了更关键的任务。这可以显著降低首次渲染时的性能开销，尤其适用于非关键组件。

## 使用方法

### 可见性策略

当组件进入视口时进行水合。

```vue
<script setup lang="ts">
const LazyHydrationMyComponent = defineLazyHydrationComponent(
  'visible',
  () => import('./components/MyComponent.vue'),
)
</script>

<template>
  <div>
    <!--
      当元素距离进入视口还有100px时触发水合。
    -->
    <LazyHydrationMyComponent :hydrate-on-visible="{ rootMargin: '100px' }" />
  </div>
</template>
```

`hydrateOnVisible` 属性是可选的。你可以传入一个对象来自定义底层使用的 `IntersectionObserver` 行为。

::read-more{to="https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver/IntersectionObserver" title="IntersectionObserver 选项"}
查看更多关于 `hydrate-on-visible` 的选项。
::

::note
底层使用了 Vue 内置的 [`hydrateOnVisible` 策略](https://vuejs.org/guide/components/async.html#hydrate-on-visible)。
::

### 空闲策略

当浏览器处于空闲状态时进行水合。适合需要尽快加载但不阻塞关键渲染路径的组件。

```vue
<script setup lang="ts">
const LazyHydrationMyComponent = defineLazyHydrationComponent(
  'idle',
  () => import('./components/MyComponent.vue'),
)
</script>

<template>
  <div>
    <!-- 当浏览器空闲或超过2000ms后触发水合。 -->
    <LazyHydrationMyComponent :hydrate-on-idle="2000" />
  </div>
</template>
```

`hydrateOnIdle` 属性是可选的。你可以传入一个正数以指定最长超时时间。

空闲策略适用于可在浏览器空闲时进行水合的组件。

::note
底层使用了 Vue 内置的 [`hydrateOnIdle` 策略](https://vuejs.org/guide/components/async.html#hydrate-on-idle)。
::

### 交互策略

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

```vue
<script setup lang="ts">
const LazyHydrationMyComponent = defineLazyHydrationComponent(
  'interaction',
  () => import('./components/MyComponent.vue'),
)
</script>

<template>
  <div>
    <!--
      当元素被指针悬停时触发水合。
    -->
    <LazyHydrationMyComponent hydrate-on-interaction="mouseover" />
  </div>
</template>
```

`hydrateOnInteraction` 属性是可选的。如果你不传入事件或事件列表，默认会在 `pointerenter`、`click` 和 `focus` 事件触发时进行水合。

::note
底层使用了 Vue 内置的 [`hydrateOnInteraction` 策略](https://vuejs.org/guide/components/async.html#hydrate-on-interaction)。
::

### 媒体查询策略

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

```vue
<script setup lang="ts">
const LazyHydrationMyComponent = defineLazyHydrationComponent(
  'mediaQuery',
  () => import('./components/MyComponent.vue'),
)
</script>

<template>
  <div>
    <!--
      当窗口宽度大于或等于 768px 时触发水合。
    -->
    <LazyHydrationMyComponent hydrate-on-media-query="(min-width: 768px)" />
  </div>
</template>
```

::note
底层使用了 Vue 内置的 [`hydrateOnMediaQuery` 策略](https://vuejs.org/guide/components/async.html#hydrate-on-media-query)。
::

### 时间策略

在指定延迟（毫秒）后进行水合。

```vue
<script setup lang="ts">
const LazyHydrationMyComponent = defineLazyHydrationComponent(
  'time',
  () => import('./components/MyComponent.vue'),
)
</script>

<template>
  <div>
    <!-- 1000 毫秒后触发水合。 -->
    <LazyHydrationMyComponent :hydrate-after="1000" />
  </div>
</template>
```

时间策略适用于可以等待特定时间后再进行水合的组件。

### 条件策略

根据布尔条件进行水合。

```vue
<script setup lang="ts">
const LazyHydrationMyComponent = defineLazyHydrationComponent(
  'if',
  () => import('./components/MyComponent.vue'),
)

const isReady = ref(false)

function myFunction () {
  // 触发自定义水合策略…
  isReady.value = true
}
</script>

<template>
  <div>
    <!-- 当 isReady 变为 true 时触发水合。 -->
    <LazyHydrationMyComponent :hydrate-when="isReady" />
  </div>
</template>
```

条件策略适合可能并非总需水合的组件。

### 永不水合

组件永远不会被水合。

```vue
<script setup lang="ts">
const LazyHydrationMyComponent = defineLazyHydrationComponent(
  'never',
  () => import('./components/MyComponent.vue'),
)
</script>

<template>
  <div>
    <!-- 此组件永远不会被 Vue 水合。 -->
    <LazyHydrationMyComponent />
  </div>
</template>
```

### 监听水合事件

所有延迟水合组件在水合完成时都会触发 `@hydrated` 事件。

```vue
<script setup lang="ts">
const LazyHydrationMyComponent = defineLazyHydrationComponent(
  'visible',
  () => import('./components/MyComponent.vue'),
)

function onHydrate () {
  console.log('组件已完成水合！')
}
</script>

<template>
  <div>
    <LazyHydrationMyComponent
      :hydrate-on-visible="{ rootMargin: '100px' }"
      @hydrated="onHydrate"
    />
  </div>
</template>
```

## 参数

::warning
为确保编译器正确识别此宏，避免使用外部变量。以下写法将导致宏无法被正确识别：

```vue
<script setup lang="ts">
const strategy = 'visible'
const source = () => import('./components/MyComponent.vue')
const LazyHydrationMyComponent = defineLazyHydrationComponent(strategy, source)
</script>
```
::

### `strategy`

- **类型**: `'visible' | 'idle' | 'interaction' | 'mediaQuery' | 'if' | 'time' | 'never'`
- **必填**: `true`

| 策略            | 描述                  |
| ------------- | ------------------- |
| `visible`     | 组件进入视口时进行水合。        |
| `idle`        | 浏览器空闲时或延迟一定时间后进行水合。 |
| `interaction` | 用户交互（如点击、悬停）后进行水合。  |
| `mediaQuery`  | 符合指定媒体查询条件时进行水合。    |
| `if`          | 当指定布尔条件满足时进行水合。     |
| `time`        | 延迟指定时间后进行水合。        |
| `never`       | 禁止 Vue 对该组件进行水合。    |

### `source`

- **类型**: `() => Promise<Component>`
- **必填**: `true`

---

- [源码](https://github.com/nuxt/nuxt/blob/main/packages/nuxt/src/app/components/plugins/lazy-hydration-macro-transform.ts)


## Sitemap

See the full [sitemap](https://nuxt.zhcndoc.com/sitemap.md) for all pages.