Scaladoc: scaladoc anchor navigation can't handle some same page links

KacperFKorban commented 1 year ago

Compiler version

main

Description

In some cases, scaladoc can't properly scroll to anchors that are on the same page. In those cases, it takes several tries for scaladoc to scroll the entire way. e.g.

scaladoc-anchor-same-page-oopsie

Expectation

Scaladoc should always be able to scroll to anchors.

Dedelweiss commented 1 year ago

Hello, from what I noticed during my test, the problem comes from the fact that the anchor does not remain in the URL. After some research, I found this javascript that replaces the anchor with an empty string. In scaladoc/resources/dotty_res/scripts/ux.js:

if (lastEntry.isIntersecting) {
  window.location.hash = "";
  removeAllHighlights();
  const id = getIdOfElement(lastEntry);

  getTocListElement(id).parentElement.classList.toggle("active");
}

So from what I see, this if statement checks if the last entry in entries is intersecting with the window, indicating that it is visible on the screen. If that's the case, the code performs the following actions:

It resets the window's anchor.
It calls the removeAllHighlights function to remove any existing highlights from the table of contents elements and put the element where we are in active

So I know what the purpose of this if is but when I delete it, I don't see any change (and it works better).