Instant navigation: toc item requires two clicks after navigating away and returning

[rachel-rigdon-sp]

Context

No response

Bug description

When using Instant Loading, selecting a link in the table of contents, navigating away, returning, and then selecting the same toc item does not jump to the id until the second click.

I've confirmed this in Chrome, Firefox, and Edge.

Related links

• Reporting a bug
• Use a content action button to link to the Comments h2 #7050 (reply in thread)

Reproduction

9.5.22+insiders.4.53.8-instant-nav-bug-repro.zip

Steps to reproduce

1. Select a right-side toc item.
2. Use the left-side navigation to go to another page.
3. Use the left-side navigation to return to the first page.
4. Select the same right-side toc item. It now requires two clicks to navigate to.

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'll investigate.

[squidfunk]

Fixed in 485fa76! Thanks for the excellent issue and reproduction, that made isolating and fixing the issue really easy. The problem was that the pathname change was not properly detected, which is now ensured by the document$ subscription and the double switch map on location$. The comment explains how it works:

mkdocs-material/src/templates/assets/javascripts/integrations/instant/index.ts

Lines 366 to 378 in 485fa76

	// Handle instant navigation events that are triggered by the user clicking
	// on an anchor link with a hash fragment different from the current one, as
	// well as from popstate events, which are emitted when the user navigates
	// back and forth between pages. We use a two-layered subscription to scope
	// the scroll restoration to the current page, as we don't need to restore
	// the viewport offset when the user navigates to a different page, as this
	// is already handled by the previous observable.
	document$.pipe(
	switchMap(() => location$),
	distinctUntilKeyChanged("pathname"),
	switchMap(() => location$),
	distinctUntilKeyChanged("hash")
	),

Perfect issue! Thanks for taking the time.

[rachel-rigdon-sp]

Thank you so much for the fix! 🙌🏻

[squidfunk]

Released as part of 9.5.23.

[soronpo]

Thank you so much!