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

[docs] Fix scroll shift #24418

Merged
merged 1 commit into from
Jan 15, 2021
Merged

[docs] Fix scroll shift #24418

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
78 changes: 40 additions & 38 deletions docs/src/modules/components/AppNavDrawer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import Drawer from '@material-ui/core/Drawer';
import SwipeableDrawer from '@material-ui/core/SwipeableDrawer';
import Divider from '@material-ui/core/Divider';
import Hidden from '@material-ui/core/Hidden';
import useMediaQuery from '@material-ui/core/useMediaQuery';
import Box from '@material-ui/core/Box';
import DiamondSponsors from 'docs/src/modules/components/DiamondSponsors';
import AppNavDrawerItem from 'docs/src/modules/components/AppNavDrawerItem';
Expand All @@ -16,15 +17,16 @@ import PageContext from 'docs/src/modules/components/PageContext';
import { useUserLanguage, useTranslate } from 'docs/src/modules/utils/i18n';

let savedScrollTop = null;

function PersistScroll(props) {
const { children } = props;
const { children, enabled } = props;
const rootRef = React.useRef();

React.useEffect(() => {
const parent = rootRef.current ? rootRef.current.parentElement : null;
const activeElement = document.querySelector('.app-drawer-active');
const activeElement = parent.querySelector('.app-drawer-active');

if (!parent || !activeElement || !activeElement.scrollIntoView) {
if (!enabled || !parent || !activeElement || !activeElement.scrollIntoView) {
return undefined;
}

Expand All @@ -33,22 +35,21 @@ function PersistScroll(props) {
if (savedScrollTop === null || activeBox.top - savedScrollTop < 0) {
// Center the selected item in the list container.
activeElement.scrollIntoView();
// Fix a Chrome issue, reset the tabbable ring back to the top of the document.
document.body.scrollIntoView();
} else {
parent.scrollTop = savedScrollTop;
}

return () => {
savedScrollTop = parent.scrollTop;
};
}, []);
}, [enabled]);

return <div ref={rootRef}>{children}</div>;
}

PersistScroll.propTypes = {
children: PropTypes.node,
enabled: PropTypes.bool,
};

const styles = (theme) => ({
Expand Down Expand Up @@ -149,42 +150,43 @@ function AppNavDrawer(props) {
const userLanguage = useUserLanguage();
const languagePrefix = userLanguage === 'en' ? '' : `/${userLanguage}`;
const t = useTranslate();
const mobile = useMediaQuery((theme) => theme.breakpoints.down('lg'));

const navItems = React.useMemo(
() => renderNavItems({ onClose, pages, activePage, depth: 0, t }),
[activePage, pages, onClose, t],
);
const drawer = (
<PersistScroll>
<div className={classes.toolbarIe11}>
<div className={classes.toolbar}>
<Link className={classes.title} href="/" onClick={onClose} variant="h6" color="inherit">
Material-UI
</Link>
{process.env.LIB_VERSION ? (
<Link
color="textSecondary"
variant="caption"
href={`https://material-ui.com${languagePrefix}/versions/`}
onClick={onClose}
>
{/* eslint-disable-next-line material-ui/no-hardcoded-labels -- version string is untranslatable */}
{`v${process.env.LIB_VERSION}`}
const drawer = React.useMemo(() => {
const navItems = renderNavItems({ onClose, pages, activePage, depth: 0, t });

return (
<React.Fragment>
<div className={classes.toolbarIe11}>
<div className={classes.toolbar}>
<Link className={classes.title} href="/" onClick={onClose} variant="h6" color="inherit">
Material-UI
</Link>
) : null}
{process.env.LIB_VERSION ? (
<Link
color="textSecondary"
variant="caption"
href={`https://material-ui.com${languagePrefix}/versions/`}
onClick={onClose}
>
{/* eslint-disable-next-line material-ui/no-hardcoded-labels -- version string is untranslatable */}
{`v${process.env.LIB_VERSION}`}
</Link>
) : null}
</div>
</div>
</div>
<Divider />
<Box sx={{ mx: 3, my: 2 }}>
<DiamondSponsors spot="drawer" />
</Box>
{navItems}
</PersistScroll>
);
<Divider />
<Box sx={{ mx: 3, my: 2 }}>
<DiamondSponsors spot="drawer" />
</Box>
{navItems}
</React.Fragment>
);
}, [activePage, pages, onClose, t, classes, languagePrefix]);

return (
<nav className={className} aria-label={t('mainNavigation')}>
<Hidden lgUp={!disablePermanent} implementation="js">
{disablePermanent || mobile ? (
<SwipeableDrawer
classes={{
paper: clsx(classes.paper, 'algolia-drawer'),
Expand All @@ -200,7 +202,7 @@ function AppNavDrawer(props) {
>
{drawer}
</SwipeableDrawer>
</Hidden>
) : null}
{disablePermanent ? null : (
<Hidden lgDown implementation="css">
<Drawer
Expand All @@ -210,7 +212,7 @@ function AppNavDrawer(props) {
variant="permanent"
open
>
{drawer}
<PersistScroll enabled={!mobile}>{drawer}</PersistScroll>
</Drawer>
</Hidden>
)}
Expand Down