Skip to content

Fix hydration flash in global sidebar nav #1102

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

Closed
rakesh2OO5 wants to merge 1 commit into from
Closed

Fix hydration flash in global sidebar nav #1102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
62 changes: 36 additions & 26 deletions src/components/Nav/NavPanels.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ import { JumpToLinks } from "./JumpToLinks";
import { MainNavLinks } from "./MainNavLinks";
import { useEffect, useState } from "preact/hooks";

const BREAKPOINT = 768;

const getIsMobile = () => {
if (typeof window === "undefined") return false; // assume desktop on SSR
return window.innerWidth < BREAKPOINT;
};


interface NavPanelsProps {
mainLinks: {
label: string;
Expand Down Expand Up @@ -32,38 +40,40 @@ export const NavPanels = (props: NavPanelsProps) => {
jumpToState,
} = props;

const [isOpen, setIsOpen] = useState({ main: false, jump: false });
const [isMobile, setIsMobile] = useState(true);
const [isMobile, setIsMobile] = useState(getIsMobile);

const [isOpen, setIsOpen] = useState(() => {
const mobile = getIsMobile();
return {
main: !mobile,
jump: !mobile,
};
});


// Defaults to closed on mobile, open on desktop
// Have to do this in a lifecycle method
// so that we can still server-side render
useEffect(() => {
const startsMobile = window.innerWidth < 768;
setIsMobile(startsMobile);
setIsOpen({ main: !startsMobile, jump: !startsMobile });
// We use a resize observer to the user's window crosses the
// threshhold between mobile and desktop
const documentObserver = new ResizeObserver((entries) => {
for (const entry of entries) {
if (!isMobile && entry.contentRect.width < 768) {
setIsMobile(true);
setIsOpen({
main: false,
jump: false,
});
} else if (isMobile && entry.contentRect.width >= 768) {
setIsMobile(false);
setIsOpen({
main: true,
jump: true,
});
}
}
const handleResize = () => {
const mobile = window.innerWidth < BREAKPOINT;

setIsMobile((prev) => {
if (prev === mobile) return prev;

setIsOpen({
main: !mobile,
jump: !mobile,
});

return mobile;
});
documentObserver.observe(document.body);
return () => documentObserver.disconnect();
}, [setIsMobile, setIsOpen, isMobile]);
};

window.addEventListener("resize", handleResize);
return () => window.removeEventListener("resize", handleResize);
}, []);


const handleMainNavToggle = () => {
setIsOpen((prev) => ({
Expand Down