onPrehydrate v3.12

源码
使用 onPrehydrate 在 Nuxt 对页面进行 hydration 之前，立即在客户端运行一个回调。
此可组合函数在 Nuxt v3.12+ 中可用。

onPrehydrate 是一个可组合的生命周期钩子，允许你在客户端在 Nuxt 对页面进行 hydration 之前立即运行一个回调。

这是一个高级工具，应谨慎使用。例如，nuxt-time 和 @nuxtjs/color-mode 会操作 DOM 以避免 hydration 不匹配。

使用

在 Vue 组件的 setup 函数中（例如在 <script setup> 中）或在插件中调用 onPrehydrate。该调用本身只有在服务端执行时才会生效，并且会从你的客户端构建中移除。不过，你传入的回调会被序列化并内联到 HTML 中，因此它会在 Nuxt 进行 hydration 之前立即在浏览器中运行。这意味着它可以访问诸如 window 和 DOM 之类的浏览器全局对象。

类型

Signature
export function onPrehydrate (callback: (el: HTMLElement) => void): void
export function onPrehydrate (callback: string | ((el: HTMLElement) => void), key?: string): undefined | string

参数

ParameterTypeRequiredDescription
callback((el: HTMLElement) => void) | string是在 Nuxt 执行 hydration 之前要运行的函数（或字符串化的函数）。它将被字符串化并内联到 HTML 中。不应有外部依赖或引用回调外的变量。在 Nuxt 运行时初始化之前运行，因此不应依赖 Nuxt 或 Vue 的上下文。
keystring否（高级）用于标识 prehydrate 脚本的唯一键，适用于像多个根节点这样的高级场景。

返回值

  • 当仅传入回调函数时返回 undefined。
  • 当传入回调和 key 时返回一个字符串（prehydrate id），可用于在高级用例中设置或访问 data-prehydrate-id 属性。

示例

app/app.vue
<script setup lang="ts">
declare const window: Window
// ---cut---
onPrehydrate(() => {
  // 在浏览器中运行，正好在 Nuxt 开始水合之前
  console.log(window)
})

// 访问根元素
onPrehydrate((el) => {
  console.log(el.outerHTML)
  // <div data-v-inspector="app.vue:15:3" data-prehydrate-id=":b3qlvSiBeH:"> 你好 </div>
})

// 高级：自行访问/设置 `data-prehydrate-id`
const prehydrateId = onPrehydrate((el) => {})
</script>

<template>
  <div>
    你好
  </div>
</template>

在底层，这个回调会在构建时被转成字符串并进行压缩，然后以内联 <script> 标签的形式注入到服务端渲染的 HTML 中，位置就在 </body> 结束标签之前。对于上面的示例，渲染后的 HTML 大致如下：

<div data-prehydrate-id=":b3qlvSiBeH:"> 你好 </div>
<script>(()=>{console.log(window)})()</script>
<script>document.querySelectorAll('[data-prehydrate-id*=":b3qlvSiBeH:"]').forEach(el=>{console.log(el.outerHTML)})</script>

当回调接收一个 el 参数时，组件的根元素会被标记上一个 data-prehydrate-id 属性，这样内联脚本就可以找到它。