Skip to content

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

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

Closed
wants to merge 3 commits into from
Closed

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

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9bdf26b
Fix scrolling
nrankin18 Sep 24, 2023
5cb872b
Fix scroll to top
nrankin18 Sep 24, 2023
87c7e07
Wait for document load
nrankin18 Sep 24, 2023
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
92 changes: 48 additions & 44 deletions src/core/event/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import Tweezer from 'tweezer.js';
import { isMobile } from '../util/env.js';
import { body, on } from '../util/dom.js';
import * as dom from '../util/dom.js';
import { removeParams } from '../router/util.js';
import config from '../config.js';
import { removeParams } from '../router/util.js';
import * as dom from '../util/dom.js';
import { body, on } from '../util/dom.js';
import { isMobile } from '../util/env.js';

/** @typedef {import('../Docsify.js').Constructor} Constructor */

Expand All @@ -18,14 +17,14 @@ export function Events(Base) {

// If 'history', rely on the browser's scroll auto-restoration when going back or forward
if (source !== 'history') {
// Scroll to ID if specified
if (this.route.query.id) {
this.#scrollIntoView(this.route.path, this.route.query.id);
}
// Scroll to top if a link was clicked and auto2top is enabled
if (source === 'navigate') {
auto2top && this.#scroll2Top(auto2top);
}
// Scroll to ID if specified
if (this.route.query.id) {
this.#scrollIntoView(this.route.path, this.route.query.id);
}
}

if (this.config.loadNavbar) {
Expand All @@ -49,40 +48,57 @@ export function Events(Base) {
#nav = {};

#hoverOver = false;
#scroller = null;
#enableScrollEvent = true;
#coverHeight = 0;
#delayScrollInterval;
async #scrollTo(el) {
this.#enableScrollEvent = false;

#scrollTo(el, offset = 0) {
if (this.#scroller) {
this.#scroller.stop();
if (document.readyState !== 'complete') {
clearInterval(this.#delayScrollInterval);
await new Promise(resolve => {
this.#delayScrollInterval = setInterval(() => {
if (document.readyState === 'complete') {
clearInterval(this.#delayScrollInterval);
resolve();
}
}, 100);
});
}

this.#enableScrollEvent = false;
this.#scroller = new Tweezer({
start: window.pageYOffset,
end:
Math.round(el.getBoundingClientRect().top) +
window.pageYOffset -
offset,
duration: 500,
})
.on('tick', v => window.scrollTo(0, v))
.on('done', () => {
el.scrollIntoView({ behavior: 'smooth' });

// Determine when scrolling has stopped
let prevTop;
const completeIntervalId = setInterval(() => {
const top = el.getBoundingClientRect().top;
if (top === prevTop) {
console.log('clearing');
clearInterval(completeIntervalId);
this.#enableScrollEvent = true;
this.#scroller = null;
})
.begin();
}
prevTop = top;
}, 500);
}

#highlight(path) {
#delayHighlightInterval;
async #highlight(path) {
let delayed = false;
if (!this.#enableScrollEvent) {
return;
delayed = true;
clearInterval(this.#delayHighlightInterval);
await new Promise(resolve => {
this.#delayHighlightInterval = setInterval(() => {
if (this.#enableScrollEvent) {
clearInterval(this.#delayHighlightInterval);
resolve();
}
}, 100);
});
}

const sidebar = dom.getNode('.sidebar');
const anchors = dom.findAll('.anchor');
const wrap = dom.find(sidebar, '.sidebar-nav');
let active = dom.find(sidebar, 'li.active');
const doc = document.documentElement;
const top =
Expand All @@ -107,7 +123,7 @@ export function Events(Base) {

const li = this.#nav[this.#getNavKey(path, last.getAttribute('data-id'))];

if (!li || li === active) {
if (!li || (li === active && !delayed)) {
return;
}

Expand All @@ -116,20 +132,8 @@ export function Events(Base) {
active = li;

// Scroll into view
// https://github.com/vuejs/vuejs.org/blob/master/themes/vue/source/js/common.js#L282-L297
if (!this.#hoverOver && dom.body.classList.contains('sticky')) {
const height = sidebar.clientHeight;
const curOffset = 0;
const cur = active.offsetTop + active.clientHeight + 40;
const isInView =
active.offsetTop >= wrap.scrollTop && cur <= wrap.scrollTop + height;
const notThan = cur - curOffset < height;

sidebar.scrollTop = isInView
? wrap.scrollTop
: notThan
? curOffset
: cur - height;
active.scrollIntoView();
}
}

Expand Down