Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: SSR hydration error caused by useId #12719

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions packages/vant/src/composables/use-id.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
import { getCurrentInstance } from 'vue';
import { getCurrentInstance, inject } from 'vue';

let current = 0;
const initial = { current: 0 };
const ID_INJECTION_KEY = 'van-id-injection';

export function useId() {
const vm = getCurrentInstance();
const idInjection = getCurrentInstance()
? inject(ID_INJECTION_KEY, initial)
: initial;
const { name = 'unknown' } = vm?.type || {};

// keep test snapshot stable
if (process.env.NODE_ENV === 'test') {
return name;
}

return `${name}-${++current}`;
if (typeof window === 'undefined' && !inject(ID_INJECTION_KEY)) {
console.warn(
'[vant useId] Looks like you are using server rendering, we suggest injecting an initial value for the ID. eg: app.provide("van-id-injection", { current: 0 })',
);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

最好是不需要让用户注入内容,因为这样有点复杂了

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Vue 3.5 会提供一个 hook 来解决这个问题,参考 vuejs/rfcs#557

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

那先等等官方的实现吧。

目前我能够想到避免服务端缓存的最优的方案就是这个。像指令方案改动比较大,或者Nuxt的useId方案不适用于普通的组件库。

}

return `${name}-${++idInjection.current}`;
}
Loading