Skip to content

docs: remove smooth behavior from SideNav autoscroll #9828

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

Merged
reidbarber merged 3 commits into from
Mar 28, 2026
+4 −2
Merged

docs: remove smooth behavior from SideNav autoscroll #9828

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
297c8c0
docs: remove smooth behavior from SideNav autoscroll
reidbarber Mar 23, 2026
c4ca87e
only scroll on mount
reidbarber Mar 27, 2026
4656457
Merge remote-tracking branch 'origin/main' into docs-remove-smooth-au…
reidbarber Mar 27, 2026
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
6 changes: 4 additions & 2 deletions packages/dev/s2-docs/src/Nav.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,16 +256,18 @@ export function SideNavItem(props) {

export function SideNavLink(props) {
let linkRef = useRef<HTMLAnchorElement | null>(null);
let shouldAutoScrollOnMount = useRef(props.isSelected);
let selected = useContext(SideNavContext);
let {isExternal, ...linkProps} = props;

useEffect(() => {
let link = linkRef.current;
if (!link || !props.isSelected) {
if (!link || !props.isSelected || !shouldAutoScrollOnMount.current) {
return;
}

link.scrollIntoView({block: 'start', behavior: 'smooth'});
shouldAutoScrollOnMount.current = false;
link.scrollIntoView({block: 'start'});
Copy link
Copy Markdown
Member

@devongovett devongovett Mar 23, 2026

Choose a reason for hiding this comment

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

I noticed that it scrolls even when you click on a link in the sidebar. For example scroll down and then click a link near the top, it will move when you click it. Maybe we should only do this on the initial page load?

Copy link
Copy Markdown
Contributor

@nwidynski nwidynski Mar 23, 2026

Choose a reason for hiding this comment

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

If I understand what you mean correctly, this should be fixed when using our shim here instead, as that implements the equivalent of scrollIntoViewIfNeeded.

}, [props.isSelected]);

return (
Expand Down
Loading