Instant loading scroll restoration

[ofek]

Description

Page refreshes do not keep your place but rather take you to the top in v5.x with the following config:

theme:
  name: material
  features:
    - instant

Expected behavior

Pressing F5 should maintain your approximate spot on the page

Actual behavior

Pressing F5 (without an anchor selected) takes you to the top

Steps to reproduce the bug

1. Scroll down
2. Refresh
3. Notice your view resets

Package versions

• Python: 3.8
• MkDocs: 1.1
• Material: 5.0.0rc2

Project configuration

theme:
  name: material
  features:
    - instant

System information

• OS: Windows 10
• Browser: Chrome

[squidfunk]

Hmm. Could you please add some more information and adhere to the issue template?

[ofek]

Done!

[squidfunk]

Perfect, thanks!

[squidfunk]

Should be fixed as of 4d370fe. The reason why this was happening lies in the fact that the value of history.scrollRestoration is persisted across reloads:

mkdocs-material/src/assets/javascripts/index.ts

Lines 361 to 363 in 4d370fe

	/* Disable automatic scroll restoration, as it doesn't work nicely */
	if ("scrollRestoration" in history)
	history.scrollRestoration = "manual"

The following line now hands back the task of scroll restoration to the browser before the reload:

mkdocs-material/src/assets/javascripts/index.ts

Lines 352 to 356 in 4d370fe

	/* Hack: ensure that page loads restore scroll offset */
	fromEvent(window, "beforeunload")
	.subscribe(() => {
	history.scrollRestoration = "auto"
	})

After the reload, scroll restoration is set back to "manual" when instant loading is enabled. The change is deployed with instant loading enabled on the deploy preview. Does it work for you?

[ofek]

It works!!!

[squidfunk]

Cool. I'll be cleaning up some stuff today and will release a final RC including all fixes made.

[squidfunk]

The fix was just released as part of RC 4. See #1498 for details.