Add save theme for user functionality

This commit is contained in:
Wendelin 2025-02-12 15:30:15 +01:00
parent 1349c8520c
commit 4f9ca3b173
No known key found for this signature in database
6 changed files with 254 additions and 33 deletions

View File

@ -1,5 +1,11 @@
import type { Connection } from "home-assistant-js-websocket"; import type { Connection } from "home-assistant-js-websocket";
import { createCollection } from "home-assistant-js-websocket"; import { createCollection } from "home-assistant-js-websocket";
import type { HomeAssistant, ThemeSettings } from "../types";
import {
fetchFrontendUserData,
saveFrontendUserData,
subscribeFrontendUserData,
} from "./frontend";
export interface ThemeVars { export interface ThemeVars {
// Incomplete // Incomplete
@ -50,3 +56,16 @@ export const subscribeThemes = (
conn, conn,
onChange onChange
); );
export const SELECTED_THEME_KEY = "selectedTheme";
export const saveSelectedTheme = (hass: HomeAssistant, data?: ThemeSettings) =>
saveFrontendUserData(hass.connection, SELECTED_THEME_KEY, data);
export const subscribeSelectedTheme = (
hass: HomeAssistant,
callback: (selectedTheme?: ThemeSettings | null) => void
) => subscribeFrontendUserData(hass.connection, SELECTED_THEME_KEY, callback);
export const fetchSelectedTheme = (hass: HomeAssistant) =>
fetchFrontendUserData(hass.connection, SELECTED_THEME_KEY);

View File

@ -16,6 +16,7 @@ import {
} from "../../resources/styles-data"; } from "../../resources/styles-data";
import type { HomeAssistant } from "../../types"; import type { HomeAssistant } from "../../types";
import { documentationUrl } from "../../util/documentation-url"; import { documentationUrl } from "../../util/documentation-url";
import type { StorageLocation } from "../../state/themes-mixin";
const USE_DEFAULT_THEME = "__USE_DEFAULT_THEME__"; const USE_DEFAULT_THEME = "__USE_DEFAULT_THEME__";
const HOME_ASSISTANT_THEME = "default"; const HOME_ASSISTANT_THEME = "default";
@ -26,6 +27,9 @@ export class HaPickThemeRow extends LitElement {
@property({ type: Boolean }) public narrow = false; @property({ type: Boolean }) public narrow = false;
@property({ attribute: false })
public storageLocation: StorageLocation = "browser";
@state() _themeNames: string[] = []; @state() _themeNames: string[] = [];
protected render(): TemplateResult { protected render(): TemplateResult {
@ -171,13 +175,19 @@ export class HaPickThemeRow extends LitElement {
private _handleColorChange(ev: CustomEvent) { private _handleColorChange(ev: CustomEvent) {
const target = ev.target as any; const target = ev.target as any;
fireEvent(this, "settheme", { [target.name]: target.value }); fireEvent(this, "settheme", {
settings: { [target.name]: target.value },
storageLocation: this.storageLocation,
});
} }
private _resetColors() { private _resetColors() {
fireEvent(this, "settheme", { fireEvent(this, "settheme", {
primaryColor: undefined, settings: {
accentColor: undefined, primaryColor: undefined,
accentColor: undefined,
},
storageLocation: this.storageLocation,
}); });
} }
@ -198,7 +208,10 @@ export class HaPickThemeRow extends LitElement {
dark = true; dark = true;
break; break;
} }
fireEvent(this, "settheme", { dark }); fireEvent(this, "settheme", {
settings: { dark },
storageLocation: this.storageLocation,
});
} }
private _handleThemeSelection(ev) { private _handleThemeSelection(ev) {
@ -210,17 +223,23 @@ export class HaPickThemeRow extends LitElement {
if (theme === USE_DEFAULT_THEME) { if (theme === USE_DEFAULT_THEME) {
if (this.hass.selectedTheme?.theme) { if (this.hass.selectedTheme?.theme) {
fireEvent(this, "settheme", { fireEvent(this, "settheme", {
theme: "", settings: {
primaryColor: undefined, theme: "",
accentColor: undefined, primaryColor: undefined,
accentColor: undefined,
},
storageLocation: this.storageLocation,
}); });
} }
return; return;
} }
fireEvent(this, "settheme", { fireEvent(this, "settheme", {
theme, settings: {
primaryColor: undefined, theme,
accentColor: undefined, primaryColor: undefined,
accentColor: undefined,
},
storageLocation: this.storageLocation,
}); });
} }

View File

@ -1,18 +1,23 @@
import "@material/mwc-button"; import { mdiAlertCircleOutline } from "@mdi/js";
import type { UnsubscribeFunc } from "home-assistant-js-websocket"; import type { UnsubscribeFunc } from "home-assistant-js-websocket";
import type { CSSResultGroup, TemplateResult } from "lit"; import type { CSSResultGroup, TemplateResult } from "lit";
import { css, html, LitElement } from "lit"; import { css, html, LitElement, nothing } from "lit";
import { customElement, property, state } from "lit/decorators"; import { customElement, property, state } from "lit/decorators";
import { fireEvent } from "../../common/dom/fire_event"; import { fireEvent } from "../../common/dom/fire_event";
import "../../components/ha-card"; import "../../components/ha-card";
import "../../components/ha-button";
import "../../components/ha-expansion-panel";
import "../../components/ha-switch";
import "../../components/ha-svg-icon";
import "../../layouts/hass-tabs-subpage"; import "../../layouts/hass-tabs-subpage";
import { profileSections } from "./ha-panel-profile"; import { profileSections } from "./ha-panel-profile";
import { isExternal } from "../../data/external"; import { isExternal } from "../../data/external";
import { SELECTED_THEME_KEY } from "../../data/ws-themes";
import type { CoreFrontendUserData } from "../../data/frontend"; import type { CoreFrontendUserData } from "../../data/frontend";
import { getOptimisticFrontendUserDataCollection } from "../../data/frontend"; import { getOptimisticFrontendUserDataCollection } from "../../data/frontend";
import { showConfirmationDialog } from "../../dialogs/generic/show-dialog-box"; import { showConfirmationDialog } from "../../dialogs/generic/show-dialog-box";
import { haStyle } from "../../resources/styles"; import { haStyle } from "../../resources/styles";
import type { HomeAssistant, Route } from "../../types"; import type { HomeAssistant, Route, ThemeSettings } from "../../types";
import "./ha-advanced-mode-row"; import "./ha-advanced-mode-row";
import "./ha-enable-shortcuts-row"; import "./ha-enable-shortcuts-row";
import "./ha-force-narrow-row"; import "./ha-force-narrow-row";
@ -27,6 +32,8 @@ import "./ha-pick-time-zone-row";
import "./ha-push-notifications-row"; import "./ha-push-notifications-row";
import "./ha-set-suspend-row"; import "./ha-set-suspend-row";
import "./ha-set-vibrate-row"; import "./ha-set-vibrate-row";
import { storage } from "../../common/decorators/storage";
import type { HaSwitch } from "../../components/ha-switch";
@customElement("ha-profile-section-general") @customElement("ha-profile-section-general")
class HaProfileSectionGeneral extends LitElement { class HaProfileSectionGeneral extends LitElement {
@ -38,6 +45,15 @@ class HaProfileSectionGeneral extends LitElement {
@property({ attribute: false }) public route!: Route; @property({ attribute: false }) public route!: Route;
@storage({
key: SELECTED_THEME_KEY,
state: true,
subscribe: true,
})
private _browserThemeSettings?: ThemeSettings;
@state() private _browserThemeActivated = false;
private _unsubCoreData?: UnsubscribeFunc; private _unsubCoreData?: UnsubscribeFunc;
private _getCoreData() { private _getCoreData() {
@ -91,9 +107,9 @@ class HaProfileSectionGeneral extends LitElement {
: ""} : ""}
</div> </div>
<div class="card-actions"> <div class="card-actions">
<mwc-button class="warning" @click=${this._handleLogOut}> <ha-button class="warning" @click=${this._handleLogOut}>
${this.hass.localize("ui.panel.profile.logout")} ${this.hass.localize("ui.panel.profile.logout")}
</mwc-button> </ha-button>
</div> </div>
</ha-card> </ha-card>
<ha-card <ha-card
@ -128,6 +144,26 @@ class HaProfileSectionGeneral extends LitElement {
.narrow=${this.narrow} .narrow=${this.narrow}
.hass=${this.hass} .hass=${this.hass}
></ha-pick-first-weekday-row> ></ha-pick-first-weekday-row>
${this._browserThemeSettings || this._browserThemeActivated
? html`
<ha-settings-row .narrow=${this.narrow}>
<span slot="heading">
${this.hass.localize("ui.panel.profile.themes.header")}
</span>
<span class="theme-warning" slot="description">
<ha-svg-icon .path=${mdiAlertCircleOutline}></ha-svg-icon>
${this.hass.localize(
"ui.panel.profile.themes.device.user_theme_info"
)}
</span>
</ha-settings-row>
`
: html`<ha-pick-theme-row
.narrow=${this.narrow}
.hass=${this.hass}
this._browserThemeActivated}
.storageLocation=${"user"}
></ha-pick-theme-row>`}
${this.hass.user!.is_admin ${this.hass.user!.is_admin
? html` ? html`
<ha-advanced-mode-row <ha-advanced-mode-row
@ -148,10 +184,42 @@ class HaProfileSectionGeneral extends LitElement {
<div class="card-content"> <div class="card-content">
${this.hass.localize("ui.panel.profile.client_settings_detail")} ${this.hass.localize("ui.panel.profile.client_settings_detail")}
</div> </div>
<ha-pick-theme-row <ha-settings-row .narrow=${this.narrow}>
.narrow=${this.narrow} <span slot="heading">
.hass=${this.hass} ${this.hass.localize(
></ha-pick-theme-row> isExternal
? "ui.panel.profile.themes.device.mobile_app_header"
: "ui.panel.profile.themes.device.browser_header"
)}
</span>
<span slot="description">
${this.hass.localize(
"ui.panel.profile.themes.device.description"
)}
</span>
<ha-switch
.checked=${!!this._browserThemeSettings ||
this._browserThemeActivated}
@change=${this._toggleBrowserTheme}
></ha-switch>
</ha-settings-row>
${this._browserThemeSettings || this._browserThemeActivated
? html`
<ha-expansion-panel
outlined
.header=${this.hass.localize(
"ui.panel.profile.themes.device.custom_theme"
)}
expanded
>
<ha-pick-theme-row
class="device-theme"
.narrow=${this.narrow}
.hass=${this.hass}
></ha-pick-theme-row>
</ha-expansion-panel>
`
: nothing}
<ha-pick-dashboard-row <ha-pick-dashboard-row
.narrow=${this.narrow} .narrow=${this.narrow}
.hass=${this.hass} .hass=${this.hass}
@ -167,11 +235,11 @@ class HaProfileSectionGeneral extends LitElement {
"ui.panel.profile.customize_sidebar.description" "ui.panel.profile.customize_sidebar.description"
)} )}
</span> </span>
<mwc-button @click=${this._customizeSidebar}> <ha-button @click=${this._customizeSidebar}>
${this.hass.localize( ${this.hass.localize(
"ui.panel.profile.customize_sidebar.button" "ui.panel.profile.customize_sidebar.button"
)} )}
</mwc-button> </ha-button>
</ha-settings-row> </ha-settings-row>
${this.hass.dockedSidebar !== "auto" || !this.narrow ${this.hass.dockedSidebar !== "auto" || !this.narrow
? html` ? html`
@ -225,6 +293,40 @@ class HaProfileSectionGeneral extends LitElement {
}); });
} }
private async _toggleBrowserTheme(ev: Event) {
const switchElement = ev.target as HaSwitch;
const enabled = switchElement.checked;
if (!enabled) {
if (!this._browserThemeSettings && this._browserThemeActivated) {
// no changed have made, disable without confirmation
this._browserThemeActivated = false;
} else {
const confirm = await showConfirmationDialog(this, {
title: this.hass.localize(
"ui.panel.profile.themes.device.delete_header"
),
text: this.hass.localize(
"ui.panel.profile.themes.device.delete_description"
),
confirmText: this.hass.localize("ui.common.delete"),
destructive: true,
});
if (confirm) {
this._browserThemeActivated = false;
this._browserThemeSettings = undefined;
fireEvent(this, "resetBrowserTheme");
} else {
// revert switch
switchElement.click();
}
}
} else {
this._browserThemeActivated = true;
}
}
static get styles(): CSSResultGroup { static get styles(): CSSResultGroup {
return [ return [
haStyle, haStyle,
@ -251,6 +353,20 @@ class HaProfileSectionGeneral extends LitElement {
text-align: center; text-align: center;
color: var(--secondary-text-color); color: var(--secondary-text-color);
} }
ha-expansion-panel {
margin: 0 8px 8px;
}
.theme-warning {
color: var(--warning-color);
display: flex;
align-items: center;
gap: 8px;
}
.device-theme {
display: block;
padding-bottom: 16px;
}
`, `,
]; ];
} }

View File

@ -3,18 +3,36 @@ import {
invalidateThemeCache, invalidateThemeCache,
} from "../common/dom/apply_themes_on_element"; } from "../common/dom/apply_themes_on_element";
import type { HASSDomEvent } from "../common/dom/fire_event"; import type { HASSDomEvent } from "../common/dom/fire_event";
import { subscribeThemes } from "../data/ws-themes"; import {
import type { Constructor, HomeAssistant } from "../types"; fetchSelectedTheme,
import { storeState } from "../util/ha-pref-storage"; saveSelectedTheme,
SELECTED_THEME_KEY,
subscribeSelectedTheme,
subscribeThemes,
} from "../data/ws-themes";
import type { Constructor, HomeAssistant, ThemeSettings } from "../types";
import { clearStateKey, storeState } from "../util/ha-pref-storage";
import type { HassBaseEl } from "./hass-base-mixin"; import type { HassBaseEl } from "./hass-base-mixin";
export type StorageLocation = "user" | "browser";
interface SetThemeSettings {
settings: Partial<HomeAssistant["selectedTheme"]>;
storageLocation: StorageLocation;
}
declare global { declare global {
// for add event listener // for add event listener
interface HTMLElementEventMap { interface HTMLElementEventMap {
settheme: HASSDomEvent<Partial<HomeAssistant["selectedTheme"]>>; settheme: HASSDomEvent<SetThemeSettings>;
} }
interface HASSDomEvents { interface HASSDomEvents {
settheme: Partial<HomeAssistant["selectedTheme"]>; settheme: SetThemeSettings;
resetBrowserTheme: undefined;
}
interface FrontendUserData {
selectedTheme?: ThemeSettings;
} }
} }
@ -27,16 +45,34 @@ export default <T extends Constructor<HassBaseEl>>(superClass: T) =>
protected firstUpdated(changedProps) { protected firstUpdated(changedProps) {
super.firstUpdated(changedProps); super.firstUpdated(changedProps);
this.addEventListener("settheme", (ev) => { this.addEventListener("settheme", (ev) => {
const selectedTheme = {
...this.hass!.selectedTheme!,
...ev.detail.settings,
};
this._updateHass({ this._updateHass({
selectedTheme: { selectedTheme,
...this.hass!.selectedTheme!,
...ev.detail,
},
}); });
this._applyTheme(mql.matches); this._applyTheme(mql.matches);
storeState(this.hass!);
if (ev.detail.storageLocation === "browser") {
storeState(this.hass!);
} else {
clearStateKey(SELECTED_THEME_KEY);
saveSelectedTheme(this.hass!, selectedTheme);
}
}); });
mql.addListener((ev) => this._applyTheme(ev.matches));
this.addEventListener("resetBrowserTheme", async () => {
clearStateKey(SELECTED_THEME_KEY);
const selectedTheme = await fetchSelectedTheme(this.hass!);
this._updateHass({
selectedTheme,
});
this._applyTheme(mql.matches);
});
mql.addEventListener("change", (ev) => this._applyTheme(ev.matches));
if (!this._themeApplied && mql.matches) { if (!this._themeApplied && mql.matches) {
applyThemesOnElement( applyThemesOnElement(
document.documentElement, document.documentElement,
@ -63,6 +99,20 @@ export default <T extends Constructor<HassBaseEl>>(superClass: T) =>
invalidateThemeCache(); invalidateThemeCache();
this._applyTheme(mql.matches); this._applyTheme(mql.matches);
}); });
subscribeSelectedTheme(
this.hass!,
(selectedTheme?: ThemeSettings | null) => {
if (
!window.localStorage.getItem(SELECTED_THEME_KEY) &&
selectedTheme
) {
this._themeApplied = true;
this._updateHass({ selectedTheme });
this._applyTheme(mql.matches);
}
}
);
} }
private _applyTheme(darkPreferred: boolean) { private _applyTheme(darkPreferred: boolean) {

View File

@ -7575,7 +7575,16 @@
"primary_color": "Primary color", "primary_color": "Primary color",
"accent_color": "Accent color", "accent_color": "Accent color",
"reset": "Reset", "reset": "Reset",
"use_default": "Use default theme" "use_default": "Use default theme",
"device": {
"browser_header": "Browser theme",
"mobile_app_header": "Mobile app theme",
"custom_theme": "Custom theme",
"description": "Overwrite user theme with custom device settings",
"delete_header": "Delete device theme",
"delete_description": "Are you sure you want to delete the device specific theme?",
"user_theme_info": "Device theme is active. Delete it to edit the user theme."
}
}, },
"dashboard": { "dashboard": {
"header": "Dashboard", "header": "Dashboard",

View File

@ -11,6 +11,8 @@ const STORED_STATE = [
"defaultPanel", "defaultPanel",
]; ];
const CLEARABLE_STATE = ["selectedTheme"];
export function storeState(hass: HomeAssistant) { export function storeState(hass: HomeAssistant) {
try { try {
STORED_STATE.forEach((key) => { STORED_STATE.forEach((key) => {
@ -55,3 +57,9 @@ export function getState() {
export function clearState() { export function clearState() {
window.localStorage.clear(); window.localStorage.clear();
} }
export function clearStateKey(key: string) {
if (CLEARABLE_STATE.includes(key)) {
window.localStorage.removeItem(key);
}
}