Remembering the user's scroll position (for History.scrollRestoration)

tl;dr#

You can set whether the page should return to where it was originally scrolled when the user presses the back button.

1const scrollRestoration = history.scrollRestoration;
2if (scrollRestoration === "manual") {
3  console.log(
4    "If the option is set to manual, the scroll position will not be restored and the user will have to move it manually."
5  );
6}

Scroll Restoration#

This section is about Scroll Restoration, the browser History API for scroll restoration. This API allows you to set whether the page should return to the original scroll position when the user presses the browser's back button.

The default is auto, and setting this to manual will not restore the scrolled position.

1// Restore the user's scroll position on the page.
2history.scrollRestoration = "auto"; // default
3
4// The position on the page is not restored and the user must manually scroll to that position.
5history.scrollRestoration = "manual";

See also.#

• MDN Web Docs History API scrollRestoration

Translated with www.DeepL.com/Translator (free version)