chore(client): add comments for data-allow-mismatch usage

vuepress · Sep 3, 2024 · 64f0215 · 64f0215
1 parent bb265c0
commit 64f0215
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/client/src/components/ClientOnly.ts b/packages/client/src/components/ClientOnly.ts
@@ -2,6 +2,10 @@ import { defineComponent, onMounted, ref } from 'vue'
 
 /**
  * Wrapper component that only renders its content on the client side and skips server side rendering
+ *
+ * Since vue 3.5, you can try the new `data-allow-mismatch` attribute instead of `<ClientOnly>` component in some cases to avoid hydration mismatch.
+ *
+ * @see https://blog.vuejs.org/posts/vue-3-5#data-allow-mismatch
  */
 export const ClientOnly = defineComponent({
   name: 'ClientOnly',