SSR 兼容性

VitePress 在生产构建期间在 Node.js 中预渲染应用程序，使用 Vue 的服务器端渲染 (SSR) 功能。这意味着主题组件中的所有自定义代码都受到 SSR 兼容性的约束。

Vue SSR 文档提供了有关什么是 SSR、SSR / SSG 之间的关系以及编写 SSR 友好代码的常见注意事项的更多上下文。经验法则是只在 Vue 组件的 beforeMount 或 mounted 钩子中访问浏览器 / DOM API。

<ClientOnly>

如果你正在使用或演示对 SSR 不友好的组件（例如，包含自定义指令），你可以将它们包装在内置的 <ClientOnly> 组件中：

<ClientOnly>
  <NonSSRFriendlyComponent />
</ClientOnly>

在导入时访问浏览器 API 的库

一些组件或库在导入时访问浏览器 API。要使用在导入时假定浏览器环境的代码，你需要动态导入它们。

在 Mounted 钩子中导入

<script setup>
import { onMounted } from 'vue'

onMounted(() => {
  import('./lib-that-access-window-on-import').then((module) => {
    // use code
  })
})
</script>

条件导入

你也可以使用 import.meta.env.SSR 标志（Vite env 变量的一部分）有条件地导入依赖项：

if (!import.meta.env.SSR) {
  import('./lib-that-access-window-on-import').then((module) => {
    // use code
  })
}

由于 theme.enhanceApp 可以是异步的，你可以有条件地导入和注册访问浏览器 API 的 Vue 插件：

// .vitepress/theme/index.js
export default {
  // ...
  async enhanceApp({ app }) {
    if (!import.meta.env.SSR) {
      const plugin = await import('plugin-that-access-window-on-import')
      app.use(plugin.default)
    }
  }
}

如果你使用 TypeScript：

// .vitepress/theme/index.ts
import type { Theme } from 'vitepress'

export default {
  // ...
  async enhanceApp({ app }) {
    if (!import.meta.env.SSR) {
      const plugin = await import('plugin-that-access-window-on-import')
      app.use(plugin.default)
    }
  }
} satisfies Theme

defineClientComponent

VitePress 为导入 Vue 组件提供了一个方便的辅助程序，该组件在导入时访问浏览器 API。

<script setup>
import { defineClientComponent } from 'vitepress'

const ClientComp = defineClientComponent(() => {
  return import('component-that-access-window-on-import')
})
</script>

<template>
  <ClientComp />
</template>

你还可以将 props/children/slots 传递给目标组件：

<script setup>
import { ref } from 'vue'
import { defineClientComponent } from 'vitepress'

const clientCompRef = ref()
const ClientComp = defineClientComponent(
  () => import('component-that-access-window-on-import'),

  // args 传递给 h() - https://cn.vuejs.org/guide/extras/render-function.html#creating-vnodes
  [
    {
      ref: clientCompRef
    },
    {
      default: () => 'default slot',
      foo: () => h('div', 'foo'),
      bar: () => [h('span', 'one'), h('span', 'two')]
    }
  ],

  // 加载后的回调，可以是异步的
  () => {
    console.log('loaded')
  }
)
</script>

<template>
  <ClientComp />
</template>

目标组件只会在包装器组件的 mounted 钩子中导入。