shadcn-vue icon indicating copy to clipboard operation
shadcn-vue copied to clipboard

[Bug]: `shadcn-nuxt` produces hydration warnings for some components

Open e-tho opened this issue 1 year ago • 26 comments

Environment

Developement/Production OS: NixOS 24.05.20240106.46ae021 (Uakari) x86_64
Node version: 21.1.0
Package manager: [email protected]
Radix Vue version: 1.2.7
Shadcn Nuxt version: 0.8.6
Vue version: 3.4.7
Nuxt version: 3.9.1
Nuxt mode: universal
Nuxt target: server
CSS framework: [email protected]
Client OS: NixOS 24.05.20240106.46ae021 (Uakari) x86_64
Browser: Firefox 121.0

Link to minimal reproduction

https://stackblitz.com/edit/nuxt-starter-rgoa7e?file=pages%2Findex.vue

Steps to reproduce

Install and set up shadcn-nuxt with <Accordion> and <Button> components.

Describe the bug

Since 0.8.6 some components in my project such as <Button>, <AccordionTrigger> and <AccordionContent> produce these SSR-related warnings.

[Vue warn]: Hydration attribute mismatch on ...
- rendered on server: id="radix-75"
- expected on client: id="radix-1"
Note: this mismatch is check-only. The DOM will not be rectified in production due to performance overhead.
You should fix the source of the mismatch. 
...

I tried initializing shadcn-vue again, deleting node_modules and package-lock.json and reinstalling the project, but nothing helped. It seems to come from the version of radix-vue used by shadcn-nuxt.

Expected behavior

No response

Conext & Screenshots (if applicable)

No response

e-tho avatar Jan 09 '24 20:01 e-tho

This issue is not on your end. It appeared after Vue 3.4 as it now checks for hydration mismatches in attributes. This also happens in Nuxt UI for example. There's a PR that introduces new useId composable that generates SSR friendly id (Stays the same on server & client) which will solve this issue. Maybe something similar needs to be ported to shadcn vue

MuhammadM1998 avatar Jan 10 '24 10:01 MuhammadM1998

https://github.com/radix-vue/radix-vue/discussions/558#discussioncomment-8045611

sadeghbarati avatar Jan 10 '24 11:01 sadeghbarati

I'm also seeing this. Temporary solution for me was to pin vue to 3.3.13...

  "overrides": {
    "vue": "3.3.13"
  },

jontybrook avatar Jan 10 '24 20:01 jontybrook

I'm also seeing this. Temporary solution for me was to pin vue to 3.3.13...

  "overrides": {
    "vue": "3.3.13"
  },

It doesn't fix the problem, it just hides the warnings. The problem remains the same. A useId() hook should appear in version 3.5 of vue, making it easier to correct the problem.

valh1996 avatar Jan 11 '24 17:01 valh1996

Seems there was a useId() added for nuxt 3.10

https://nuxt.com/blog/v3-10#ssr-safe-accessible-unique-id-creation

beejaz avatar Jan 30 '24 17:01 beejaz

This seems to happen with the auto imported component. Not with a manual imported component.

I've reported this to the Nuxt repo aswell with reproduction link: https://github.com/nuxt/nuxt/issues/25696

mattickx avatar Feb 08 '24 13:02 mattickx

I had the same problem with the form example. Fixed this case locally inside FormItem.vue by removing the import from radix-vue, so it uses the one from Nuxt automatically:

<script lang="ts" setup>
import { provide } from 'vue'
import { useId } from 'radix-vue'  <-- remove this one
import { cn } from '@/lib/utils'

const props = defineProps<{
  class?: HTMLAttributes['class']
}>()

const id = useId()
provide(FORM_ITEM_INJECTION_KEY, id)
</script>

peterhijma avatar Mar 17 '24 16:03 peterhijma

I had the same problem with the form example. Fixed this case locally inside FormItem.vue by removing the import from radix-vue, so it uses the one from Nuxt automatically:

import { useId } from 'radix-vue'  <-- remove this one

This might be a solution for Form components, but I still have issues with plain components (auto imported). Example with Progress component, described in: https://github.com/nuxt/nuxt/issues/25696

mattickx avatar Mar 18 '24 11:03 mattickx

I'd like to point out that the solution @peterhijma works for Form 🙏 . Although I have the same issue on DropDownMenu, and it seems that i can't apply the same fix.

MercurialUroboros avatar Apr 27 '24 08:04 MercurialUroboros

@MercurialUroboros Try this https://github.com/radix-vue/shadcn-vue/issues/637#issuecomment-2198640328 in your app.vue

MuhammadM1998 avatar Jul 08 '24 19:07 MuhammadM1998

@MercurialUroboros @MuhammadM1998 Did you have any issue with components like the Progress component? As described in https://github.com/nuxt/nuxt/issues/25696 I'm still having hydration warnings even though there is no use of useId() in these components

mattickx avatar Jul 10 '24 14:07 mattickx

Thank you!!

SuperKojima avatar Jul 17 '24 06:07 SuperKojima

Over the past six months, I’ve extensively used Shadcn and tested nearly every component. While the useId() fix for Nuxt has resolved most hydration issues, I’m still encountering a Vue hydration error with the Menubar component.

I’ve tried various approaches to address this, but the issue persists. I’m not aware of any current workarounds.

maikeleckelboom avatar Jul 28 '24 00:07 maikeleckelboom

using shadcn components with client:load in Astro produces the same hydration errors as well

Rettend avatar Aug 03 '24 21:08 Rettend

im also using shadcn-vue with Nuxt and implemented the ssr hydration fix with useId() but for me it's still throwing hydration errors using the Navigation Menu with Nuxt links

michaelsieminski avatar Aug 07 '24 13:08 michaelsieminski

Also happens with the accordion component

- rendered on server: id="radix-vue-accordion-trigger-11"
- expected on client: id="radix-vue-accordion-trigger-2"

Azurox avatar Aug 28 '24 21:08 Azurox

having this same issue, even if i use a custom useId() in nuxt 3...

<script>
const myUseId = () => useId()
</script>

<template>
<ConfigProvider :use-id="myUseId">
</template>

i guess this can be fixed now with vue 3.5? it features a new useId.

ivan-angjelkoski avatar Sep 05 '24 00:09 ivan-angjelkoski

Has anyone resolved the current issue after the release of Vue 3.5?

I'm currently using:

"nuxt": "^3.13.1",
"radix-vue": "^1.9.5",
"shadcn-nuxt": "^0.10.4",
"vue": "^3.5.4"

I tried the option of using <ConfigProvider :use-id="() => useId() ?? ''">. It partially helped: errors disappeared from the browser console,2024-09-13 in 17 39 59 but they remain in the VSCode terminal.

2024-09-13 in 18 05 12

As I understand, the errors are occurring due to the use of Devtools. Is there a way to resolve them without disabling Devtools?

alan-bevz avatar Sep 13 '24 17:09 alan-bevz

@alan-bevz you need to use the use id in setup, you cant use it in a template. example:

<script setup>
import {useId} from 'vue'.  // Note: you need vue 3.5
const myUseId = () => useId() || ''
</script>

<template>
<ConfigProvider :use-id="myUseId">
...
</template>

ivan-angjelkoski avatar Sep 13 '24 17:09 ivan-angjelkoski

@ivan-angjelkoski Thank you for your response. I tried it, but it didn’t help. However, I think I found the answer to my question here: https://github.com/nuxt/nuxt/pull/28901. As I understand it, my issue will be resolved in Nuxt version 3.13.2.

alan-bevz avatar Sep 13 '24 17:09 alan-bevz

Testing in Nuxt 3.13.2 I still see the console warnings. Did 3.12.2 make the warnings go away for anybody?

genu avatar Sep 16 '24 19:09 genu

Testing in Nuxt 3.13.2 I still see the console warnings. Did 3.12.2 make the warnings go away for anybody?

radix-vue is still not refactored to use Vue useId. That is why we still have these warnings

sadeghbarati avatar Sep 16 '24 19:09 sadeghbarati

Testing in Nuxt 3.13.2 I still see the console warnings. Did 3.12.2 make the warnings go away for anybody?

radix-vue is still not refactored to use Vue useId. That is why we still have these warnings

it is as of today https://github.com/radix-vue/radix-vue/commit/20a755e6cae5c10a2b52798cd294270452a56d78 :tada: release still outstanding though

kkukelka avatar Sep 18 '24 11:09 kkukelka

Testing in Nuxt 3.13.2 I still see the console warnings. Did 3.12.2 make the warnings go away for anybody?

Yes, I made a mistake and misunderstood the fix. The errors have not disappeared.

alan-bevz avatar Sep 18 '24 14:09 alan-bevz

I'm using the latest [email protected] released yesterday and the problem still seems to persist, even after the above mentioned commit got merged.

bennyzen avatar Sep 21 '24 12:09 bennyzen

Having the same issue with dropdown, any solutions ?

premdasvm avatar Sep 22 '24 17:09 premdasvm