docsifyjs / docsify

🃏 A magical documentation site generator.
https://docsify.js.org
MIT License
27.47k stars 5.67k forks source link

Fix auto-scroll undershooting correction location on initial page load #2238

Closed nrankin18 closed 1 month ago

nrankin18 commented 1 year ago

Summary

Bug: Navigating to an anchor link on docs with images causes the initial auto-scroll to "undershoot" the correct location. This is because the scroll location is calculated prior to the images loading, so the image heights aren't accounted for in the location calculation.

Fix: Wait for the document to finish loading and then scroll to the location. After scrolling to the location, call el.scrollIntoView() as a backup.

Additional Bug: Auto-scroll on an initial page load does not scroll the appropriate sidebar item into view. This is because #highlight() is blocked while the Tweezer animation is running and will not scroll the sidebar if the item is already active.

Fix: Call #highlight() after the Tweezer scroll animation is complete with a parameter to force the scroll.

Related issue, if any:

https://github.com/docsifyjs/docsify/issues/351 https://github.com/docsifyjs/docsify/issues/559

What kind of change does this PR introduce?

Bugfix

For any code change,

Does this PR introduce a breaking change?

No

Tested in the following browsers:

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docsify-preview ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 25, 2023 5:33am