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.

Sign up for GitHub

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(theme): fix useWindowSize React hydration issue #9446

Merged
merged 3 commits into from
Oct 25, 2023
Merged

fix(theme): fix useWindowSize React hydration issue #9446

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72d92ed
fix useWindowSize hydration issues
slorber Oct 25, 2023
cd9b788
lint
slorber Oct 25, 2023
b143f19
failfast
slorber Oct 25, 2023
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
26 changes: 10 additions & 16 deletions packages/docusaurus-theme-common/src/hooks/useWindowSize.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ const DesktopThresholdWidth = 996;

function getWindowSize() {
if (!ExecutionEnvironment.canUseDOM) {
return windowSizes.ssr;
throw new Error(
'getWindowSize() should only be called after React hydration',
);
}
return window.innerWidth > DesktopThresholdWidth
? windowSizes.desktop
: windowSizes.mobile;
}

const DevSimulateSSR = process.env.NODE_ENV === 'development' && true;

/**
* Gets the current window size as an enum value. We don't want it to return the
* actual width value, so that it only re-renders once a breakpoint is crossed.
Expand All @@ -39,32 +39,26 @@ const DevSimulateSSR = process.env.NODE_ENV === 'development' && true;
* may need to render BOTH the mobile/desktop elements (and hide one of them
* with mediaquery). We don't return `undefined` on purpose, to make it more
* explicit.
*
* In development mode, this hook will still return `"ssr"` for one second, to
* catch potential layout shifts, similar to strict mode calling effects twice.
*/
export function useWindowSize(): WindowSize {
const [windowSize, setWindowSize] = useState<WindowSize>(() => {
if (DevSimulateSSR) {
return 'ssr';
}
return getWindowSize();
});
const [windowSize, setWindowSize] = useState<WindowSize>(
() =>
// super important to return a constant value to avoid hydration mismatch
// see https://github.com/facebook/docusaurus/issues/9379
'ssr',
);

useEffect(() => {
function updateWindowSize() {
setWindowSize(getWindowSize());
}

const timeout = DevSimulateSSR
? window.setTimeout(updateWindowSize, 1000)
: undefined;
updateWindowSize();

window.addEventListener('resize', updateWindowSize);

return () => {
window.removeEventListener('resize', updateWindowSize);
clearTimeout(timeout);
};
}, []);

Expand Down
Loading