Instant navigation: TOC items on visited pages require two clicks

[Nerixyz]

Context

This is very similar to #7183, except that the user doesn't navigate back to the main page but clicks a heading on the visited page, which requires two clicks.

Bug description

When navigation.instant is enabled, jumping to headings using the TOC on "new"/"child" pages requires two clicks.

Related links

• Reporting a bug
• Instant navigation: toc item requires two clicks after navigating away and returning #7183

Reproduction

9.5.50-instant-navigation-bug-2.zip

Steps to reproduce

1. Go to the main/index page
2. Visit the second page through the navigation on the left
3. On the second page, click on a link in the TOC on the right. This requires two clicks.

Browser

No response

Before submitting

• I have read and followed the bug reporting guidelines.
• I have attached links to the documentation, and possibly related issues and discussions.
• I assure that I have removed all customizations before submitting this bug report.
• I have attached a .zip file with a minimal reproduction using the built-in info plugin.

[squidfunk]

Thanks for reporting. I can reproduce the issue. We'll look into it.

[squidfunk]

Okay, I think I've isolated the problem. The pipeline that is in effect when a document was loaded (initial load, or subsequent instant load) always resubscribes to location changes after this happened, in order to detect anchor-only changes (clicking a link in the TOC). I assumed that we need a two-layer subscription here, first filtering on the pathname (= page navigation), and then filtering on the hash fragment (= anchor navigation). This doesn't seem to be true, since removing the first part of the pipeline fixes the issue, as the pathname navigation already happened when the document observable emitted. We seem to be good just filtering distinct hash fragments. It might turn out not to be true once we release this fix, with some other issue re-appearing, but my current guess is that it should be fine. This is also exceptionally hard to test, since browsers are different.

Fixed in 07a434b.

[squidfunk]

@Nerixyz could you please confirm that this fixes your issue?

[pajlada]

I created a fresh venv, installed the version with the fix with pip install git+ssh://[email protected]/squidfunk/mkdocs-material.git@07a434b465aafc1ac228d9f2b7bd8c8f3ac81dda and can confirm it fixes the issue for me

[Nerixyz]

@Nerixyz could you please confirm that this fixes your issue?

Both this and the reproduction from #7183 work now, thank you!

[squidfunk]

Thanks for confirming. Keeping open until released.

[squidfunk]

Released as part of 9.6.0.