A local-first personal finance app
experimental sidebar: respect light theme sidebar overrides (#9003)
Matt Fiddamanbfa850ca618c
diff --git a/packages/component-library/package.json b/packages/component-library/package.jsonindex 4394a17bbb..73784abf90 100644--- a/packages/component-library/package.json+++ b/packages/component-library/package.json@@ -44,6 +44,7 @@"./theme": "./src/theme.ts","./themes/palette.css": "./src/themes/palette.css","./themes/light.css": "./src/themes/light.css",+ "./themes/sidebar-redesign-light.css": "./src/themes/sidebar-redesign-light.css","./themes/dark.css": "./src/themes/dark.css","./themes/midnight.css": "./src/themes/midnight.css","./tokens": "./src/tokens.ts",diff --git a/packages/component-library/src/themes/light.css b/packages/component-library/src/themes/light.cssindex de7d713933..a10a68d2d6 100644--- a/packages/component-library/src/themes/light.css+++ b/packages/component-library/src/themes/light.css@@ -80,16 +80,6 @@--color-sidebarBorder: var(--color-sidebarItemBackgroundHover);--color-sidebarControlBackground: var(--color-sidebarItemBackgroundHover);--color-sidebarBrand: var(--color-sidebarItemAccentSelected);- --color-sidebarRedesignBackground: var(--palette-white);- --color-sidebarRedesignItemText: var(--palette-navy800);- --color-sidebarRedesignItemBackgroundHover: var(--palette-navy100);- --color-sidebarRedesignItemAccentSelected: var(--palette-purple500);- --color-sidebarRedesignItemTextSelected: var(--palette-purple600);- --color-sidebarRedesignItemBackgroundSelected: var(--palette-purple100);- --color-sidebarRedesignItemBackgroundFailed: var(--palette-red500);- --color-sidebarRedesignHeaderText: var(--palette-gray700);- --color-sidebarRedesignTextSubdued: var(--palette-navy600);- --color-sidebarRedesignTextMuted: var(--palette-navy400);--color-menuBackground: var(--palette-white);--color-menuItemBackground: var(--palette-navy50);@@ -280,40 +270,3 @@--color-chartQual8: var(--palette-chartQual8);--color-chartQual9: var(--palette-chartQual9);}--/* Light-theme overrides scoped to the redesigned sidebar so the classic- sidebar keeps its navy styling while the newSidebarUI flag exists. This- block only remaps the sidebar token family onto the sidebarRedesign*- values declared at :root, where custom themes can override them. */-.sidebar-redesign {- --color-sidebarBackground: var(--color-sidebarRedesignBackground);- --color-sidebarItemText: var(--color-sidebarRedesignItemText);- --color-sidebarItemBackgroundHover: var(- --color-sidebarRedesignItemBackgroundHover- );- --color-sidebarItemAccentSelected: var(- --color-sidebarRedesignItemAccentSelected- );- --color-sidebarItemTextSelected: var(--color-sidebarRedesignItemTextSelected);- --color-sidebarItemBackgroundSelected: var(- --color-sidebarRedesignItemBackgroundSelected- );- --color-sidebarItemBackgroundFailed: var(- --color-sidebarRedesignItemBackgroundFailed- );- --color-sidebarHeaderText: var(--color-sidebarRedesignHeaderText);- --color-sidebarTextSubdued: var(--color-sidebarRedesignTextSubdued);- --color-sidebarTextMuted: var(--color-sidebarRedesignTextMuted);- /* Derived tokens must be redeclared here: var() references in custom- properties resolve where the property is declared, so the :root- derivations would otherwise keep the classic navy values */- --color-sidebarTextFailed: var(--color-sidebarItemBackgroundFailed);- --color-sidebarBackgroundFailedSubtle: color-mix(- in srgb,- var(--color-sidebarItemBackgroundFailed) 16%,- transparent- );- --color-sidebarBorder: var(--color-sidebarItemBackgroundHover);- --color-sidebarControlBackground: var(--color-sidebarItemBackgroundHover);- --color-sidebarBrand: var(--color-sidebarItemAccentSelected);-}diff --git a/packages/component-library/src/themes/sidebar-redesign-light.css b/packages/component-library/src/themes/sidebar-redesign-light.cssnew file mode 100644index 0000000000..f189b097da--- /dev/null+++ b/packages/component-library/src/themes/sidebar-redesign-light.css@@ -0,0 +1,49 @@+/* Light palette for the redesigned sidebar. ThemeStyle injects this with the+ built-in light theme unless a custom theme or CSS override styles the classic+ sidebar tokens. The sidebarRedesign* values can be overridden one at a time+ from a custom theme or the CSS override, since those are declared later. */+:root {+ --color-sidebarRedesignBackground: var(--palette-white);+ --color-sidebarRedesignItemText: var(--palette-navy800);+ --color-sidebarRedesignItemBackgroundHover: var(--palette-navy100);+ --color-sidebarRedesignItemAccentSelected: var(--palette-purple500);+ --color-sidebarRedesignItemTextSelected: var(--palette-purple600);+ --color-sidebarRedesignItemBackgroundSelected: var(--palette-purple100);+ --color-sidebarRedesignItemBackgroundFailed: var(--palette-red500);+ --color-sidebarRedesignHeaderText: var(--palette-gray700);+ --color-sidebarRedesignTextSubdued: var(--palette-navy600);+ --color-sidebarRedesignTextMuted: var(--palette-navy400);+}++/* Derived tokens are redeclared because var() references in custom+ properties resolve where the property is declared. */+.sidebar-redesign {+ --color-sidebarBackground: var(--color-sidebarRedesignBackground);+ --color-sidebarItemText: var(--color-sidebarRedesignItemText);+ --color-sidebarItemBackgroundHover: var(+ --color-sidebarRedesignItemBackgroundHover+ );+ --color-sidebarItemAccentSelected: var(+ --color-sidebarRedesignItemAccentSelected+ );+ --color-sidebarItemTextSelected: var(--color-sidebarRedesignItemTextSelected);+ --color-sidebarItemBackgroundSelected: var(+ --color-sidebarRedesignItemBackgroundSelected+ );+ --color-sidebarItemBackgroundFailed: var(+ --color-sidebarRedesignItemBackgroundFailed+ );+ --color-sidebarHeaderText: var(--color-sidebarRedesignHeaderText);+ --color-sidebarTextSubdued: var(--color-sidebarRedesignTextSubdued);+ --color-sidebarTextMuted: var(--color-sidebarRedesignTextMuted);+ --color-sidebarItemTextUpdated: var(--color-sidebarItemText);+ --color-sidebarTextFailed: var(--color-sidebarItemBackgroundFailed);+ --color-sidebarBackgroundFailedSubtle: color-mix(+ in srgb,+ var(--color-sidebarItemBackgroundFailed) 16%,+ transparent+ );+ --color-sidebarBorder: var(--color-sidebarItemBackgroundHover);+ --color-sidebarControlBackground: var(--color-sidebarItemBackgroundHover);+ --color-sidebarBrand: var(--color-sidebarItemAccentSelected);+}diff --git a/packages/desktop-client/src/style/customThemes.test.ts b/packages/desktop-client/src/style/customThemes.test.tsindex aabf042632..0d37832686 100644--- a/packages/desktop-client/src/style/customThemes.test.ts+++ b/packages/desktop-client/src/style/customThemes.test.ts@@ -7,7 +7,9 @@ import {MAX_FONT_FILE_SIZE,migrateLegacyOverride,parseInstalledTheme,+ usesRedesignSidebarPalette,validateThemeCss,+ validateThemeCssSafely,} from './customThemes';import type { InstalledTheme } from './customThemes';@@ -1850,3 +1852,77 @@ describe('migrateLegacyOverride', () => {expect(result?.newDarkJson).toBe(darkJson);});});++describe('validateThemeCssSafely', () => {+ it('returns the validated CSS for a valid theme', () => {+ expect(+ validateThemeCssSafely(':root { --color-pageBackground: #fff; }'),+ ).toContain('--color-pageBackground');+ });++ it('returns an empty string and reports invalid CSS', () => {+ const onError = vi.fn();+ expect(+ validateThemeCssSafely(+ '@media (prefers-color-scheme: dark) { :root { --color-sidebarBackground: navy; } }',+ onError,+ ),+ ).toBe('');+ expect(onError).toHaveBeenCalledOnce();+ expect(validateThemeCssSafely(undefined, onError)).toBe('');+ expect(onError).toHaveBeenCalledOnce();+ });++ it('keeps the redesign palette when only rejected CSS styles the sidebar', () => {+ expect(+ usesRedesignSidebarPalette(+ validateThemeCssSafely(+ '@media (prefers-color-scheme: dark) { :root { --color-sidebarBackground: navy; } }',+ ),+ ),+ ).toBe(true);+ });+});++describe('usesRedesignSidebarPalette', () => {+ it('keeps the redesign palette for themes that leave the sidebar alone', () => {+ expect(usesRedesignSidebarPalette('')).toBe(true);+ expect(+ usesRedesignSidebarPalette(':root { --color-pageBackground: #fff; }'),+ ).toBe(true);+ expect(+ usesRedesignSidebarPalette(+ ':root { --color-pageText: var(--color-sidebarBackground); }',+ ),+ ).toBe(true);+ expect(+ usesRedesignSidebarPalette(+ ':root { /* --color-sidebarBackground: navy; */ --color-pageBackground: #fff; }',+ ),+ ).toBe(true);+ });++ it('falls back to the classic palette for themes that style the classic sidebar', () => {+ expect(+ usesRedesignSidebarPalette(+ ':root {\n --color-pageBackground: #fff;\n --color-sidebarBackground: hsl(237, 51%, 23%);\n}',+ ),+ ).toBe(false);+ expect(+ usesRedesignSidebarPalette(':root { --color-sidebarItemText:#fff; }'),+ ).toBe(false);+ });++ it('keeps the redesign palette when redesign tokens are overridden', () => {+ expect(+ usesRedesignSidebarPalette(+ ':root { --color-sidebarRedesignItemTextSelected: red; }',+ ),+ ).toBe(true);+ expect(+ usesRedesignSidebarPalette(+ ':root { --color-sidebarBackground: navy; }\n:root { --color-sidebarRedesignBackground: #eef; }',+ ),+ ).toBe(true);+ });+});diff --git a/packages/desktop-client/src/style/customThemes.ts b/packages/desktop-client/src/style/customThemes.tsindex 1ed7b3625d..5e9868fde5 100644--- a/packages/desktop-client/src/style/customThemes.ts+++ b/packages/desktop-client/src/style/customThemes.ts@@ -652,6 +652,27 @@ export function generateThemeId(urlOrRepo: string): string {return `theme-${Math.abs(hash).toString(36)}`;}+export function validateThemeCssSafely(+ css: string | undefined,+ onError?: (error: unknown) => void,+): string {+ if (!css?.trim()) return '';+ try {+ return validateThemeCss(css);+ } catch (error) {+ onError?.(error);+ return '';+ }+}++export function usesRedesignSidebarPalette(css: string): boolean {+ const declarations = css.replace(/\/\*[\s\S]*?\*\//g, '');+ return (+ /--color-sidebarRedesign[A-Za-z]*\s*:/.test(declarations) ||+ !/--color-sidebar(?!Redesign)[A-Za-z]*\s*:/.test(declarations)+ );+}+/*** Parse the installed theme JSON from global prefs.* Returns a single InstalledTheme or null if none is installed.diff --git a/packages/desktop-client/src/style/theme.tsx b/packages/desktop-client/src/style/theme.tsxindex 31578516ed..696411bae4 100644--- a/packages/desktop-client/src/style/theme.tsx+++ b/packages/desktop-client/src/style/theme.tsx@@ -4,6 +4,7 @@ import darkThemeCss from '@actual-app/components/themes/dark.css?inline';import lightThemeCss from '@actual-app/components/themes/light.css?inline';import midnightThemeCss from '@actual-app/components/themes/midnight.css?inline';import paletteCss from '@actual-app/components/themes/palette.css?inline';+import sidebarRedesignLightCss from '@actual-app/components/themes/sidebar-redesign-light.css?inline';import type { DarkTheme, Theme } from '@actual-app/core/types/prefs';import { useGlobalPref } from '#hooks/useGlobalPref';@@ -12,7 +13,8 @@ import {isBaseTheme,migrateLegacyOverride,parseInstalledTheme,- validateThemeCss,+ usesRedesignSidebarPalette,+ validateThemeCssSafely,} from './customThemes';const themes = {@@ -103,20 +105,33 @@ export function ThemeStyle() {'installedCustomDarkTheme',);+ const [customCssOverride] = useGlobalPref('customCssOverride');+// Rendered rather than injected from an effect so the CSS variables exist// in the same commit as any consumer effect that reads them.+ const customLightTheme = parseInstalledTheme(installedCustomLightThemeJson);const themeColors =- getBaseThemeColors(- parseInstalledTheme(installedCustomLightThemeJson)?.baseTheme,- ) ?? getBaseThemeColors(activeTheme === 'auto' ? 'light' : activeTheme);+ getBaseThemeColors(customLightTheme?.baseTheme) ??+ getBaseThemeColors(activeTheme === 'auto' ? 'light' : activeTheme);if (!themeColors) return null;+ const sidebarRedesignCss =+ themeColors === themes.light.colors &&+ usesRedesignSidebarPalette(+ [customLightTheme?.cssContent, customCssOverride]+ .map(css => validateThemeCssSafely(css))+ .join('\n'),+ )+ ? sidebarRedesignLightCss+ : null;+if (activeTheme !== 'auto') {return (<><style>{paletteCss}</style><style>{themeColors}</style>+ {sidebarRedesignCss != null && <style>{sidebarRedesignCss}</style>}</>);}@@ -133,6 +148,11 @@ export function ThemeStyle() {<><style>{paletteCss}</style><style media="(prefers-color-scheme: light)">{themeColors}</style>+ {sidebarRedesignCss != null && (+ <style media="(prefers-color-scheme: light)">+ {sidebarRedesignCss}+ </style>+ )}<style media="(prefers-color-scheme: dark)">{darkColors}</style></>);@@ -157,15 +177,10 @@ export function CustomThemeStyle() {const [customCssOverride] = useGlobalPref('customCssOverride');const validatedCss = useMemo(() => {- const safeValidate = (css: string | undefined, errorLabel: string) => {- if (!css?.trim()) return '';- try {- return validateThemeCss(css);- } catch (error) {- console.error(errorLabel, { error });- return '';- }- };+ const safeValidate = (css: string | undefined, errorLabel: string) =>+ validateThemeCssSafely(css, error =>+ console.error(errorLabel, { error }),+ );let baseCss = '';if (activeTheme === 'auto') {diff --git a/upcoming-release-notes/fix-new-sidebar-custom-light-themes.md b/upcoming-release-notes/fix-new-sidebar-custom-light-themes.mdnew file mode 100644index 0000000000..061648dc05--- /dev/null+++ b/upcoming-release-notes/fix-new-sidebar-custom-light-themes.md@@ -0,0 +1,6 @@+---+category: Bugfix+authors: [matt-fidd]+---++Fix light custom themes losing their sidebar colours in the experimental new sidebar