feat(#1932): implement smooth scrolling for anchor navigation across site #1965
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,56 @@ | ||
| $(function(){ | ||
| var doc = $(document); | ||
|
|
||
| // Configuration for smooth scrolling | ||
| var scrollDuration = 500; | ||
| var headerOffset = 120; | ||
|
|
||
| // Smooth scroll function | ||
| function smoothScrollToElement(target) { | ||
| var $target = $(target); | ||
|
|
||
| // Handle IDs with dots (like express.urlencoded) | ||
| if (!$target.length && typeof target === 'string' && target.indexOf('.') > -1) { | ||
| var targetId = target.replace('#', ''); | ||
| $target = $('[id="' + targetId + '"]'); | ||
| } | ||
|
|
||
| if ($target.length) { | ||
| $('html, body').animate({ | ||
| scrollTop: $target.offset().top - headerOffset | ||
| }, scrollDuration); | ||
| return true; | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| // top link | ||
| $('#top').click(function(e){ | ||
| $('html, body').animate({scrollTop : 0}, 500); | ||
| return false; | ||
| }); | ||
|
|
||
| // Smooth scrolling for all anchor links | ||
| $(document).on('click', 'a[href^="#"]:not([href="#"]):not([href="#top"])', function(e) { | ||
| var href = $(this).attr('href'); | ||
| if (smoothScrollToElement(href)) { | ||
| e.preventDefault(); | ||
|
There was a problem hiding this comment. Can you please remove this line https://github.com/expressjs/expressjs.com/blob/gh-pages/js/menu.js#L186 ? Since default behavior stopped here. |
||
| // Update URL after scroll | ||
| if (history.pushState) { | ||
| history.pushState(null, null, href); | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| // Handle direct hash navigation on page load | ||
| $(window).on('load', function() { | ||
| if (window.location.hash) { | ||
| setTimeout(function() { | ||
| smoothScrollToElement(window.location.hash); | ||
| }, 300); | ||
| } | ||
| }); | ||
|
|
||
| // scrolling links | ||
| var added; | ||
| doc.scroll(function(e){ | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should minimize the scope of this click event. Currently, $(document).on('click'...) attaches the handler to all anchor links with
#across every page. However, smooth scrolling is only needed on API pages, since the TOC exists only there. Scoping it to#api-docavoids unnecessary event handling and prevents inconsistent anchor#behavior on other pages. Also, checking"#api-doc"exist on page is required before applying click event.