mirror of
https://github.com/home-assistant/frontend.git
synced 2025-07-24 09:46:36 +00:00
Add save theme for user functionality
This commit is contained in:
parent
1349c8520c
commit
4f9ca3b173
@ -1,5 +1,11 @@
|
||||
import type { Connection } 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 {
|
||||
// Incomplete
|
||||
@ -50,3 +56,16 @@ export const subscribeThemes = (
|
||||
conn,
|
||||
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);
|
||||
|
@ -16,6 +16,7 @@ import {
|
||||
} from "../../resources/styles-data";
|
||||
import type { HomeAssistant } from "../../types";
|
||||
import { documentationUrl } from "../../util/documentation-url";
|
||||
import type { StorageLocation } from "../../state/themes-mixin";
|
||||
|
||||
const USE_DEFAULT_THEME = "__USE_DEFAULT_THEME__";
|
||||
const HOME_ASSISTANT_THEME = "default";
|
||||
@ -26,6 +27,9 @@ export class HaPickThemeRow extends LitElement {
|
||||
|
||||
@property({ type: Boolean }) public narrow = false;
|
||||
|
||||
@property({ attribute: false })
|
||||
public storageLocation: StorageLocation = "browser";
|
||||
|
||||
@state() _themeNames: string[] = [];
|
||||
|
||||
protected render(): TemplateResult {
|
||||
@ -171,13 +175,19 @@ export class HaPickThemeRow extends LitElement {
|
||||
|
||||
private _handleColorChange(ev: CustomEvent) {
|
||||
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() {
|
||||
fireEvent(this, "settheme", {
|
||||
primaryColor: undefined,
|
||||
accentColor: undefined,
|
||||
settings: {
|
||||
primaryColor: undefined,
|
||||
accentColor: undefined,
|
||||
},
|
||||
storageLocation: this.storageLocation,
|
||||
});
|
||||
}
|
||||
|
||||
@ -198,7 +208,10 @@ export class HaPickThemeRow extends LitElement {
|
||||
dark = true;
|
||||
break;
|
||||
}
|
||||
fireEvent(this, "settheme", { dark });
|
||||
fireEvent(this, "settheme", {
|
||||
settings: { dark },
|
||||
storageLocation: this.storageLocation,
|
||||
});
|
||||
}
|
||||
|
||||
private _handleThemeSelection(ev) {
|
||||
@ -210,17 +223,23 @@ export class HaPickThemeRow extends LitElement {
|
||||
if (theme === USE_DEFAULT_THEME) {
|
||||
if (this.hass.selectedTheme?.theme) {
|
||||
fireEvent(this, "settheme", {
|
||||
theme: "",
|
||||
primaryColor: undefined,
|
||||
accentColor: undefined,
|
||||
settings: {
|
||||
theme: "",
|
||||
primaryColor: undefined,
|
||||
accentColor: undefined,
|
||||
},
|
||||
storageLocation: this.storageLocation,
|
||||
});
|
||||
}
|
||||
return;
|
||||
}
|
||||
fireEvent(this, "settheme", {
|
||||
theme,
|
||||
primaryColor: undefined,
|
||||
accentColor: undefined,
|
||||
settings: {
|
||||
theme,
|
||||
primaryColor: undefined,
|
||||
accentColor: undefined,
|
||||
},
|
||||
storageLocation: this.storageLocation,
|
||||
});
|
||||
}
|
||||
|
||||
|
@ -1,18 +1,23 @@
|
||||
import "@material/mwc-button";
|
||||
import { mdiAlertCircleOutline } from "@mdi/js";
|
||||
import type { UnsubscribeFunc } from "home-assistant-js-websocket";
|
||||
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 { fireEvent } from "../../common/dom/fire_event";
|
||||
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 { profileSections } from "./ha-panel-profile";
|
||||
import { isExternal } from "../../data/external";
|
||||
import { SELECTED_THEME_KEY } from "../../data/ws-themes";
|
||||
import type { CoreFrontendUserData } from "../../data/frontend";
|
||||
import { getOptimisticFrontendUserDataCollection } from "../../data/frontend";
|
||||
import { showConfirmationDialog } from "../../dialogs/generic/show-dialog-box";
|
||||
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-enable-shortcuts-row";
|
||||
import "./ha-force-narrow-row";
|
||||
@ -27,6 +32,8 @@ import "./ha-pick-time-zone-row";
|
||||
import "./ha-push-notifications-row";
|
||||
import "./ha-set-suspend-row";
|
||||
import "./ha-set-vibrate-row";
|
||||
import { storage } from "../../common/decorators/storage";
|
||||
import type { HaSwitch } from "../../components/ha-switch";
|
||||
|
||||
@customElement("ha-profile-section-general")
|
||||
class HaProfileSectionGeneral extends LitElement {
|
||||
@ -38,6 +45,15 @@ class HaProfileSectionGeneral extends LitElement {
|
||||
|
||||
@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 _getCoreData() {
|
||||
@ -91,9 +107,9 @@ class HaProfileSectionGeneral extends LitElement {
|
||||
: ""}
|
||||
</div>
|
||||
<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")}
|
||||
</mwc-button>
|
||||
</ha-button>
|
||||
</div>
|
||||
</ha-card>
|
||||
<ha-card
|
||||
@ -128,6 +144,26 @@ class HaProfileSectionGeneral extends LitElement {
|
||||
.narrow=${this.narrow}
|
||||
.hass=${this.hass}
|
||||
></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
|
||||
? html`
|
||||
<ha-advanced-mode-row
|
||||
@ -148,10 +184,42 @@ class HaProfileSectionGeneral extends LitElement {
|
||||
<div class="card-content">
|
||||
${this.hass.localize("ui.panel.profile.client_settings_detail")}
|
||||
</div>
|
||||
<ha-pick-theme-row
|
||||
.narrow=${this.narrow}
|
||||
.hass=${this.hass}
|
||||
></ha-pick-theme-row>
|
||||
<ha-settings-row .narrow=${this.narrow}>
|
||||
<span slot="heading">
|
||||
${this.hass.localize(
|
||||
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
|
||||
.narrow=${this.narrow}
|
||||
.hass=${this.hass}
|
||||
@ -167,11 +235,11 @@ class HaProfileSectionGeneral extends LitElement {
|
||||
"ui.panel.profile.customize_sidebar.description"
|
||||
)}
|
||||
</span>
|
||||
<mwc-button @click=${this._customizeSidebar}>
|
||||
<ha-button @click=${this._customizeSidebar}>
|
||||
${this.hass.localize(
|
||||
"ui.panel.profile.customize_sidebar.button"
|
||||
)}
|
||||
</mwc-button>
|
||||
</ha-button>
|
||||
</ha-settings-row>
|
||||
${this.hass.dockedSidebar !== "auto" || !this.narrow
|
||||
? 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 {
|
||||
return [
|
||||
haStyle,
|
||||
@ -251,6 +353,20 @@ class HaProfileSectionGeneral extends LitElement {
|
||||
text-align: center;
|
||||
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;
|
||||
}
|
||||
`,
|
||||
];
|
||||
}
|
||||
|
@ -3,18 +3,36 @@ import {
|
||||
invalidateThemeCache,
|
||||
} from "../common/dom/apply_themes_on_element";
|
||||
import type { HASSDomEvent } from "../common/dom/fire_event";
|
||||
import { subscribeThemes } from "../data/ws-themes";
|
||||
import type { Constructor, HomeAssistant } from "../types";
|
||||
import { storeState } from "../util/ha-pref-storage";
|
||||
import {
|
||||
fetchSelectedTheme,
|
||||
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";
|
||||
|
||||
export type StorageLocation = "user" | "browser";
|
||||
|
||||
interface SetThemeSettings {
|
||||
settings: Partial<HomeAssistant["selectedTheme"]>;
|
||||
storageLocation: StorageLocation;
|
||||
}
|
||||
|
||||
declare global {
|
||||
// for add event listener
|
||||
interface HTMLElementEventMap {
|
||||
settheme: HASSDomEvent<Partial<HomeAssistant["selectedTheme"]>>;
|
||||
settheme: HASSDomEvent<SetThemeSettings>;
|
||||
}
|
||||
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) {
|
||||
super.firstUpdated(changedProps);
|
||||
this.addEventListener("settheme", (ev) => {
|
||||
const selectedTheme = {
|
||||
...this.hass!.selectedTheme!,
|
||||
...ev.detail.settings,
|
||||
};
|
||||
this._updateHass({
|
||||
selectedTheme: {
|
||||
...this.hass!.selectedTheme!,
|
||||
...ev.detail,
|
||||
},
|
||||
selectedTheme,
|
||||
});
|
||||
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) {
|
||||
applyThemesOnElement(
|
||||
document.documentElement,
|
||||
@ -63,6 +99,20 @@ export default <T extends Constructor<HassBaseEl>>(superClass: T) =>
|
||||
invalidateThemeCache();
|
||||
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) {
|
||||
|
@ -7575,7 +7575,16 @@
|
||||
"primary_color": "Primary color",
|
||||
"accent_color": "Accent color",
|
||||
"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": {
|
||||
"header": "Dashboard",
|
||||
|
@ -11,6 +11,8 @@ const STORED_STATE = [
|
||||
"defaultPanel",
|
||||
];
|
||||
|
||||
const CLEARABLE_STATE = ["selectedTheme"];
|
||||
|
||||
export function storeState(hass: HomeAssistant) {
|
||||
try {
|
||||
STORED_STATE.forEach((key) => {
|
||||
@ -55,3 +57,9 @@ export function getState() {
|
||||
export function clearState() {
|
||||
window.localStorage.clear();
|
||||
}
|
||||
|
||||
export function clearStateKey(key: string) {
|
||||
if (CLEARABLE_STATE.includes(key)) {
|
||||
window.localStorage.removeItem(key);
|
||||
}
|
||||
}
|
||||
|
Loading…
x
Reference in New Issue
Block a user