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

Jump to bottom

[website] Fix navigation menu close behavior #33203

Merged
merged 2 commits into from Jun 23, 2022
Merged

[website] Fix navigation menu close behavior #33203

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49f65ed
fix usage of event handler
oliviertassinari Jun 17, 2022
8749979
debounce open
oliviertassinari Jun 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
59 changes: 41 additions & 18 deletions docs/src/components/header/HeaderNavBar.tsx
View file
Open in desktop
Expand Up @@ -3,6 +3,7 @@ import { styled, alpha } from '@mui/material/styles';
import Box from '@mui/material/Box';
import Popper from '@mui/material/Popper';
import Paper from '@mui/material/Paper';
import { unstable_debounce as debounce } from '@mui/utils';
import Fade from '@mui/material/Fade';
import Typography from '@mui/material/Typography';
import IconImage from 'docs/src/components/icon/IconImage';
Expand Down Expand Up @@ -116,9 +117,8 @@ function getNextIndex(eventKey: KeyboardEvent['key'], currentIndex: number, leng
}

export default function HeaderNavBar() {
const [subMenuOpen, setSubMenuOpen] = React.useState(false);
const [subMenuOpen, setSubMenuOpen] = React.useState<null | 'products' | 'docs'>(null);
const [subMenuIndex, setSubMenuIndex] = React.useState<number | null>(null);
const [docsMenuOpen, setDocsMenuOpen] = React.useState(false);
const navRef = React.useRef<HTMLUListElement | null>(null);
const productsMenuRef = React.useRef<HTMLDivElement | null>(null);
const docsMenuRef = React.useRef<HTMLDivElement | null>(null);
Expand Down Expand Up @@ -165,7 +165,7 @@ export default function HeaderNavBar() {
if (event.key === 'ArrowDown') {
event.preventDefault();
if (event.target === productsMenuRef.current) {
setSubMenuOpen(true);
setSubMenuOpen('products');
}
setSubMenuIndex((prevValue) => {
if (prevValue === null) {
Expand All @@ -190,38 +190,61 @@ export default function HeaderNavBar() {
});
}
if (event.key === 'Escape') {
setSubMenuOpen(false);
setSubMenuOpen(null);
setSubMenuIndex(null);
}
}

const setSubMenuOpenDebounced = React.useMemo(
() => debounce(setSubMenuOpen, 40),
[setSubMenuOpen],
);

const setSubMenuOpenUndebounce = React.useMemo(
() => (value: typeof subMenuOpen) => {
setSubMenuOpenDebounced.clear();
setSubMenuOpen(value);
},
[setSubMenuOpen, setSubMenuOpenDebounced],
);

React.useEffect(() => {
return () => {
setSubMenuOpenDebounced.clear();
};
}, [setSubMenuOpenDebounced]);

return (
<Navigation>
<ul ref={navRef} role="menubar" onKeyDown={handleLeftRightArrow}>
{FEATURE_TOGGLE.nav_products && (
<li
role="none"
onMouseOver={() => setSubMenuOpen(true)}
onFocus={() => setSubMenuOpen(true)}
onMouseOut={() => setSubMenuOpen(false)}
onBlur={() => setSubMenuOpen(false)}
onMouseEnter={() => setSubMenuOpenUndebounce('products')}
Copy link
Member Author

Choose a reason for hiding this comment

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

@siriwatknp I think that we should default to onMouseEnter/onMouseLeave over onMouseOver/onMouseOut because the latter fires unnecessarily more often https://stackoverflow.com/questions/1638877/difference-between-onmouseover-and-onmouseenter.

onFocus={() => setSubMenuOpenUndebounce('products')}
onMouseLeave={() => setSubMenuOpenDebounced(null)}
onBlur={() => setSubMenuOpenUndebounce(null)}
>
<div
role="menuitem"
tabIndex={0}
id="products-menu"
ref={productsMenuRef}
aria-haspopup
aria-expanded={subMenuOpen ? 'true' : 'false'}
aria-expanded={subMenuOpen === 'products' ? 'true' : 'false'}
onKeyDown={handleKeyDown}
>
Products
</div>
<Popper
open={subMenuOpen}
open={subMenuOpen === 'products'}
anchorEl={productsMenuRef.current}
transition
placement="bottom-start"
style={{ zIndex: 1200, pointerEvents: subMenuOpen ? 'visible' : 'none' }}
style={{
zIndex: 1200,
pointerEvents: subMenuOpen === 'products' ? undefined : 'none',
Copy link
Member Author

Choose a reason for hiding this comment

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

The default value of pointer-events is 'auto' not 'visible'. Also 'visible' only makes sense in the context of an SVG element, not for a div. Instead, we can unset the value. https://developer.mozilla.org/en-US/docs/Web/CSS/pointer-events

}}
>
{({ TransitionProps }) => (
<Fade {...TransitionProps} timeout={350}>
Expand Down Expand Up @@ -304,27 +327,27 @@ export default function HeaderNavBar() {
)}
<li
role="none"
onMouseOver={() => setDocsMenuOpen(true)}
onFocus={() => setDocsMenuOpen(true)}
onMouseOut={() => setDocsMenuOpen(false)}
onBlur={() => setDocsMenuOpen(false)}
onMouseEnter={() => setSubMenuOpenUndebounce('docs')}
onFocus={() => setSubMenuOpenUndebounce('docs')}
onMouseLeave={() => setSubMenuOpenDebounced(null)}
onBlur={() => setSubMenuOpenUndebounce(null)}
>
<div
role="menuitem"
tabIndex={0}
id="products-menu"
ref={docsMenuRef}
aria-haspopup
aria-expanded={docsMenuOpen ? 'true' : 'false'}
aria-expanded={subMenuOpen === 'docs' ? 'true' : 'false'}
>
Docs
</div>
<Popper
open={docsMenuOpen}
open={subMenuOpen === 'docs'}
anchorEl={docsMenuRef.current}
transition
placement="bottom-start"
style={{ zIndex: 1200, pointerEvents: docsMenuOpen ? 'visible' : 'none' }}
style={{ zIndex: 1200, pointerEvents: subMenuOpen === 'docs' ? undefined : 'none' }}
>
{({ TransitionProps }) => (
<Fade {...TransitionProps} timeout={350}>
Expand Down