Don't use browser scroll restore in DiscussionPage (#2476)

Although native browser scroll restorations have become quite powerful, it interferes with Flarum's PostStream, so if we're on a DiscussionPage, we use manual scroll restoration.
flarum · Nov 30, 2020 · f968420 · f968420
1 parent d5e124b
commit f968420
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/js/src/common/components/Page.js b/js/src/common/components/Page.js
@@ -29,6 +29,13 @@ export default class Page extends Component {
      * @type {Boolean}
      */
     this.scrollTopOnCreate = true;
+
+    /**
+     * Whether the browser should restore scroll state on refreshes.
+     *
+     * @type {Boolean}
+     */
+    this.useBrowserScrollRestoration = true;
   }
 
   oncreate(vnode) {
@@ -41,6 +48,10 @@ export default class Page extends Component {
     if (this.scrollTopOnCreate) {
       $(window).scrollTop(0);
     }
+
+    if ('scrollRestoration' in history) {
+      history.scrollRestoration = this.useBrowserScrollRestoration ? 'auto' : 'manual';
+    }
   }
 
   onremove() {

diff --git a/js/src/forum/components/DiscussionPage.js b/js/src/forum/components/DiscussionPage.js
@@ -18,6 +18,8 @@ export default class DiscussionPage extends Page {
   oninit(vnode) {
     super.oninit(vnode);
 
+    this.useBrowserScrollRestoration = false;
+
     /**
      * The discussion that is being viewed.
      *