Restore scroll position when using back navigation in dashboard (#24777)

Restore scroll position when using backup navigation in dashboard
This commit is contained in:
Paul Bottein 2025-03-26 08:21:04 +01:00 committed by GitHub
parent e3f5e921d6
commit 9cfcd21a93
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -76,9 +76,9 @@ import { getLovelaceStrategy } from "./strategies/get-strategy";
import { isLegacyStrategyConfig } from "./strategies/legacy-strategy";
import type { Lovelace } from "./types";
import "./views/hui-view";
import "./views/hui-view-container";
import type { HUIView } from "./views/hui-view";
import "./views/hui-view-background";
import "./views/hui-view-container";
@customElement("hui-root")
class HUIRoot extends LitElement {
@ -99,6 +99,8 @@ class HUIRoot extends LitElement {
private _viewCache?: Record<string, HUIView>;
private _viewScrollPositions: Record<string, number> = {};
private _debouncedConfigChanged: () => void;
private _conversation = memoizeOne((_components) =>
@ -110,7 +112,7 @@ class HUIRoot extends LitElement {
// The view can trigger a re-render when it knows that certain
// web components have been loaded.
this._debouncedConfigChanged = debounce(
() => this._selectView(this._curView, true),
() => this._selectView(this._curView, true, false),
100,
false
);
@ -525,13 +527,22 @@ class HUIRoot extends LitElement {
window.addEventListener("scroll", this._handleWindowScroll, {
passive: true,
});
window.addEventListener("popstate", this._handlePopState);
}
public disconnectedCallback(): void {
super.disconnectedCallback();
window.removeEventListener("scroll", this._handleWindowScroll);
window.removeEventListener("popstate", this._handlePopState);
}
private _restoreScroll = false;
private _handlePopState = () => {
// If we navigated back, we want to restore the scroll position.
this._restoreScroll = true;
};
protected updated(changedProperties: PropertyValues): void {
super.updated(changedProperties);
@ -572,9 +583,6 @@ class HUIRoot extends LitElement {
}
newSelectView = index;
}
// Will allow to override history scroll restoration when using back button
setTimeout(() => scrollTo({ behavior: "auto", top: 0 }), 1);
}
if (changedProperties.has("lovelace")) {
@ -613,7 +621,10 @@ class HUIRoot extends LitElement {
newSelectView = this._curView;
}
// Will allow for ripples to start rendering
afterNextRender(() => this._selectView(newSelectView, force));
afterNextRender(() => {
this._selectView(newSelectView, force, this._restoreScroll);
this._restoreScroll = false;
});
}
}
@ -921,17 +932,26 @@ class HUIRoot extends LitElement {
}
}
private _selectView(viewIndex: HUIRoot["_curView"], force: boolean): void {
private _selectView(
viewIndex: HUIRoot["_curView"],
force: boolean,
restoreScroll: boolean
): void {
if (!force && this._curView === viewIndex) {
return;
}
if (this._curView != null) {
this._viewScrollPositions[this._curView] = window.scrollY;
}
viewIndex = viewIndex === undefined ? 0 : viewIndex;
this._curView = viewIndex;
if (force) {
this._viewCache = {};
this._viewScrollPositions = {};
}
// Recreate a new element to clear the applied themes.
@ -963,10 +983,15 @@ class HUIRoot extends LitElement {
if (!force && this._viewCache![viewIndex]) {
view = this._viewCache![viewIndex];
const position = restoreScroll
? this._viewScrollPositions[viewIndex] || 0
: 0;
setTimeout(() => scrollTo({ behavior: "auto", top: position }), 0);
} else {
view = document.createElement("hui-view");
view.index = viewIndex;
this._viewCache![viewIndex] = view;
setTimeout(() => scrollTo({ behavior: "auto", top: 0 }), 0);
}
view.lovelace = this.lovelace;