Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
import type { ElectronApi } from "@triliumnext/commons";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { syncNativeWindowWithTheme } from "./native_window.js";
type Glob = NonNullable<typeof window.glob>;
const themeCtrl = vi.hoisted(() => ({ getThemeStyle: vi.fn(() => "auto") }));
vi.mock("./theme.js", () => ({ getThemeStyle: themeCtrl.getThemeStyle }));
/** The subset of the Electron window API this module drives, all spied. */
const win = {
getZoomFactor: vi.fn(() => 1),
setNativeThemeSource: vi.fn(),
setBackgroundMaterial: vi.fn(),
setVibrancy: vi.fn(),
setTitleBarOverlay: vi.fn(),
setWindowButtonPosition: vi.fn()
};
/**
* Stands in for the computed style of `document.body`: happy-dom does not resolve custom
* properties, and the module only ever reads them by name.
*/
function stubThemeVariables(vars: Record<string, string>) {
vi.spyOn(window, "getComputedStyle").mockReturnValue({
getPropertyValue: (name: string) => vars[name] ?? ""
} as CSSStyleDeclaration);
}
/** The module reads `window.glob.platform`; nothing else of the real globals is needed. */
function setPlatform(platform: Glob["platform"]) {
window.glob = { platform } as Glob;
}
beforeEach(() => {
vi.restoreAllMocks();
vi.clearAllMocks();
themeCtrl.getThemeStyle.mockReturnValue("auto");
win.getZoomFactor.mockReturnValue(1);
setPlatform("linux");
window.electronApi = { window: win } as unknown as ElectronApi;
stubThemeVariables({});
});
describe("syncNativeWindowWithTheme", () => {
it("is a no-op outside Electron", () => {
delete window.electronApi;
syncNativeWindowWithTheme();
expect(win.setNativeThemeSource).not.toHaveBeenCalled();
});
it("forwards the theme's light/dark preference, falling back to the system for 'auto'", () => {
syncNativeWindowWithTheme();
expect(win.setNativeThemeSource).toHaveBeenCalledWith("system");
themeCtrl.getThemeStyle.mockReturnValue("dark");
syncNativeWindowWithTheme();
expect(win.setNativeThemeSource).toHaveBeenCalledWith("dark");
});
it("applies the background material only where the platform supports it", () => {
stubThemeVariables({ "--background-material": " mica " });
setPlatform("win32");
syncNativeWindowWithTheme();
expect(win.setBackgroundMaterial).toHaveBeenCalledWith("mica");
expect(win.setVibrancy).not.toHaveBeenCalled();
// A material the platform does not know about is ignored rather than passed through.
vi.clearAllMocks();
stubThemeVariables({ "--background-material": "under-window" });
syncNativeWindowWithTheme();
expect(win.setBackgroundMaterial).not.toHaveBeenCalled();
vi.clearAllMocks();
setPlatform("darwin");
syncNativeWindowWithTheme();
expect(win.setVibrancy).toHaveBeenCalledWith("under-window");
expect(win.setBackgroundMaterial).not.toHaveBeenCalled();
});
it("sets the title bar overlay colors on Windows and Linux, with an opt-in height", () => {
const colors = {
"--native-titlebar-background": "#111",
"--native-titlebar-foreground": "#eee"
};
// No --native-titlebar-height: keep Chromium's own caption height.
stubThemeVariables(colors);
syncNativeWindowWithTheme();
expect(win.setTitleBarOverlay).toHaveBeenCalledWith({ color: "#111", symbolColor: "#eee" });
vi.clearAllMocks();
stubThemeVariables({ ...colors, "--native-titlebar-height": "36" });
syncNativeWindowWithTheme();
expect(win.setTitleBarOverlay).toHaveBeenCalledWith({ color: "#111", symbolColor: "#eee", height: 36 });
vi.clearAllMocks();
setPlatform("win32");
syncNativeWindowWithTheme();
expect(win.setTitleBarOverlay).toHaveBeenCalledWith({ color: "#111", symbolColor: "#eee", height: 36 });
});
it("skips the overlay when the theme provides no colors for it", () => {
stubThemeVariables({ "--native-titlebar-background": "#111" });
syncNativeWindowWithTheme();
expect(win.setTitleBarOverlay).not.toHaveBeenCalled();
});
it("positions the traffic lights on macOS from the theme's offsets", () => {
setPlatform("darwin");
stubThemeVariables({
"--native-titlebar-darwin-x-offset": "12",
"--native-titlebar-darwin-y-offset": "14"
});
syncNativeWindowWithTheme();
expect(win.setWindowButtonPosition).toHaveBeenCalledWith({ x: 12, y: 14 });
expect(win.setTitleBarOverlay).not.toHaveBeenCalled();
});
it("scales the native button geometry by the zoom factor, since it is given in device-independent pixels", () => {
// The traffic lights are drawn by the system and do not follow the page zoom, so the
// theme's offsets — expressed in the same CSS pixels as the tab bar — have to be converted.
setPlatform("darwin");
win.getZoomFactor.mockReturnValue(0.8);
stubThemeVariables({
"--native-titlebar-darwin-x-offset": "12",
"--native-titlebar-darwin-y-offset": "14"
});
syncNativeWindowWithTheme();
expect(win.setWindowButtonPosition).toHaveBeenCalledWith({ x: 10, y: 10 });
// The Windows/Linux caption buttons are centred within the overlay, so its height is the
// same kind of measurement and scales the same way.
vi.clearAllMocks();
setPlatform("linux");
win.getZoomFactor.mockReturnValue(1.5);
stubThemeVariables({
"--native-titlebar-background": "#111",
"--native-titlebar-foreground": "#eee",
"--native-titlebar-height": "36"
});
syncNativeWindowWithTheme();
expect(win.setTitleBarOverlay).toHaveBeenCalledWith({ color: "#111", symbolColor: "#eee", height: 54 });
});
it("keeps the traffic lights on the centre line the theme asked for, at any zoom", () => {
setPlatform("darwin");
// The buttons are a fixed 14 device-independent pixels tall, so the band Electron reserves
// for them — `14 + 2 * y`, with the buttons centred in it — has to come out at a constant
// height in CSS pixels for them to stay centred on the (scaling) tab bar. A y that merely
// tracked the zoom would give 14 + 2 * 26 = 66 at 200%, dragging the buttons 7 px high.
const bandInCssPixels = (zoomFactor: number) => {
vi.clearAllMocks();
win.getZoomFactor.mockReturnValue(zoomFactor);
stubThemeVariables({
"--native-titlebar-darwin-x-offset": "12",
"--native-titlebar-darwin-y-offset": "13"
});
syncNativeWindowWithTheme();
const [{ y }] = win.setWindowButtonPosition.mock.calls[0];
return (14 + 2 * y) / zoomFactor;
};
for (const zoomFactor of [0.5, 0.8, 1, 1.5, 2]) {
expect(bandInCssPixels(zoomFactor)).toBe(40);
}
});
it("leaves the title bar alone when the native one is visible, since setting the overlay then throws", () => {
window.glob.hasNativeTitleBar = true;
stubThemeVariables({
"--native-titlebar-background": "#111",
"--native-titlebar-foreground": "#eee"
});
syncNativeWindowWithTheme();
expect(win.setTitleBarOverlay).not.toHaveBeenCalled();
expect(win.setWindowButtonPosition).not.toHaveBeenCalled();
// The rest of the sync still runs.
expect(win.setNativeThemeSource).toHaveBeenCalled();
});
});