docs(useGamepad): resolve SSR detection issues with <ClientOnly> #4699
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
7 tasks
OrbisK
approved these changes
Apr 8, 2025
OrbisK
requested changes
Apr 10, 2025
I tried to modify the SSR Compatibility description, and as you mentioned, I changed demo.vue to demo.client.vue. |
|
@OrbisK Hi, just wanted to kindly follow up on this PR. Please let me know if there's anything I should adjust. If everything looks good, feel free to merge it. Thanks! |
OrbisK
previously approved these changes
May 12, 2025
antfu
approved these changes
May 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes the Gamepad API detection issue in SSR environments by wrapping the component content with
<ClientOnly>. This resolves the issue where the demo incorrectly shows "not supported" even when the browser supports the Gamepad API, particularly when accessed via direct link.The problem occurs due to hydration mismatch between server-side rendering (where Gamepad API is unavailable) and client-side rendering. Using
<ClientOnly>ensures the component is only rendered on the client side, where the API detection can be performed correctly.Fixes #4697
Reference link: https://vitepress.dev/guide/ssr-compat#clientonly
Additional context
This is a common issue with browser-only APIs in SSR environments. The current solution follows VitePress's recommended approach for handling components that rely on browser-specific APIs by using the built-in
<ClientOnly>component.fixes #123).