mirror of
https://gerrit.wikimedia.org/r/mediawiki/skins/Vector.git
synced 2024-11-30 02:15:49 +00:00
80a111d0e4
We want the link that the user has clicked inside the TOC to be "active" (e.g. bolded) regardless of whether the browser's scroll position corresponds to that section. Therefore, we need to temporarily ignore section observer until the browser has finished scrolling to the section (if needed). However, because the scroll event happens asyncronously after the user clicks on a link and may not even happen at all (e.g. the user has scrolled all the way to the bottom and clicks a section that is already in the viewport), determining when we should resume section observer is a bit tricky. Because a scroll event may not even be triggered after clicking the link, we instead allow the browser to perform a maximum number of repaints before resuming sectionObserver. Per T297614#7687656, Firefox wasn't consistently activating the table of contents section that the user clicked even after waiting 2 frames. After further investigation, it sometimes waits up to 3 frames before painting the new scroll position so we have that as the limit. Bug: T297614 Change-Id: If3632529f58c15348a7200258f4f5999ea0dadc4
23 lines
568 B
JavaScript
23 lines
568 B
JavaScript
/**
|
|
* Helper method that calls a specified callback before the browser has
|
|
* performed a specified number of repaints.
|
|
*
|
|
* Uses `requestAnimationFrame` under the hood to determine the next repaint.
|
|
*
|
|
* @param {Function} callback
|
|
* @param {number} frameCount The number of frames to wait before calling the
|
|
* specified callback.
|
|
*/
|
|
function deferUntilFrame( callback, frameCount ) {
|
|
if ( frameCount === 0 ) {
|
|
callback();
|
|
return;
|
|
}
|
|
|
|
requestAnimationFrame( () => {
|
|
deferUntilFrame( callback, frameCount - 1 );
|
|
} );
|
|
}
|
|
|
|
module.exports = deferUntilFrame;
|