feat(app): add configurable global background wallpaper
This commit is contained in:
1 parent
5fb667716f
commit
39aa663ebf
28 files changed
+1240
-1
No files matched your search
@@ -0,0 +1,114 @@
|
||||
// @vitest-environment happy-dom
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { reactive } from "vue";
|
||||
import { BACKGROUND_IMAGE_ACTIVE_CLASS, useBackgroundImage } from "@/composables/useBackgroundImage";
|
||||
import { useTheme } from "@/composables/useTheme";
|
||||
import { defaultBackgroundImageSettings, type BackgroundImageSettings } from "@/lib/app/appBackgroundImage";
|
||||
|
||||
const readBackgroundImageMock = vi.hoisted(() => vi.fn());
|
||||
|
||||
vi.mock("@/lib/backend/api", () => ({
|
||||
readBackgroundImage: readBackgroundImageMock,
|
||||
}));
|
||||
|
||||
vi.mock("@/lib/backend/tauriRuntime", () => ({ isTauriRuntime: () => false }));
|
||||
|
||||
function settingsWith(overrides: Partial<BackgroundImageSettings>) {
|
||||
const base = defaultBackgroundImageSettings();
|
||||
return { editorSettings: reactive({ backgroundImage: { ...base, ...overrides } }) } as Parameters<typeof useBackgroundImage>[0];
|
||||
}
|
||||
|
||||
describe("useBackgroundImage", () => {
|
||||
beforeEach(() => {
|
||||
vi.resetModules();
|
||||
readBackgroundImageMock.mockReset();
|
||||
(globalThis as Record<string, unknown>).__TAURI_INTERNALS__ = {};
|
||||
document.documentElement.className = "";
|
||||
document.documentElement.removeAttribute("style");
|
||||
});
|
||||
|
||||
it("reports no active background without a configured file", () => {
|
||||
const bg = useBackgroundImage(settingsWith({}));
|
||||
expect(bg.backgroundObjectUrl.value).toBeNull();
|
||||
expect(bg.active.value).toBe(false);
|
||||
expect(document.documentElement.classList.contains(BACKGROUND_IMAGE_ACTIVE_CLASS)).toBe(false);
|
||||
});
|
||||
|
||||
it("loads the configured file into an object URL and toggles the global wallpaper class", async () => {
|
||||
const createObjectURL = vi.fn(() => "blob:bg-1");
|
||||
const revokeObjectURL = vi.fn();
|
||||
Object.defineProperty(URL, "createObjectURL", { value: createObjectURL, configurable: true, writable: true });
|
||||
Object.defineProperty(URL, "revokeObjectURL", { value: revokeObjectURL, configurable: true, writable: true });
|
||||
readBackgroundImageMock.mockResolvedValue("aGVsbG8=");
|
||||
|
||||
const bg = useBackgroundImage(settingsWith({ filePath: "/data/background-image.png", fileName: "wall.png" }));
|
||||
await vi.waitFor(() => expect(bg.backgroundObjectUrl.value).toBe("blob:bg-1"));
|
||||
expect(bg.active.value).toBe(true);
|
||||
expect(document.documentElement.classList.contains(BACKGROUND_IMAGE_ACTIVE_CLASS)).toBe(true);
|
||||
});
|
||||
|
||||
it("falls back to no background when the file cannot be read", async () => {
|
||||
readBackgroundImageMock.mockRejectedValue(new Error("gone"));
|
||||
const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
|
||||
|
||||
const bg = useBackgroundImage(settingsWith({ filePath: "/data/background-image.png" }));
|
||||
await vi.waitFor(() => expect(readBackgroundImageMock).toHaveBeenCalled());
|
||||
await Promise.resolve();
|
||||
expect(bg.backgroundObjectUrl.value).toBeNull();
|
||||
expect(bg.active.value).toBe(false);
|
||||
expect(document.documentElement.classList.contains(BACKGROUND_IMAGE_ACTIVE_CLASS)).toBe(false);
|
||||
expect(warnSpy).toHaveBeenCalledTimes(1);
|
||||
warnSpy.mockRestore();
|
||||
});
|
||||
|
||||
it("tints custom palette surface colors from the custom color settings while active", async () => {
|
||||
const theme = useTheme();
|
||||
const originalMode = theme.themeMode.value;
|
||||
const originalPalette = theme.themePalette.value;
|
||||
const originalColors = { ...theme.customUiColors.value };
|
||||
theme.setThemeMode("light");
|
||||
theme.setCustomUiColors({ ...originalColors, background: "#123456", sidebar: "#654321" });
|
||||
theme.setThemePalette("custom");
|
||||
const createObjectURL = vi.fn(() => "blob:bg-custom");
|
||||
Object.defineProperty(URL, "createObjectURL", { value: createObjectURL, configurable: true, writable: true });
|
||||
readBackgroundImageMock.mockResolvedValue("aGVsbG8=");
|
||||
try {
|
||||
const bg = useBackgroundImage(settingsWith({ filePath: "/data/background-image.png", opacity: 0.5 }));
|
||||
await vi.waitFor(() => expect(bg.active.value).toBe(true));
|
||||
await vi.waitFor(() => {
|
||||
expect(document.documentElement.style.getPropertyValue("--background")).toBe("rgb(18 52 86 / 0.5)");
|
||||
expect(document.documentElement.style.getPropertyValue("--sidebar")).toBe("rgb(101 67 33 / 0.5)");
|
||||
});
|
||||
} finally {
|
||||
theme.setCustomUiColors(originalColors);
|
||||
theme.setThemeMode(originalMode);
|
||||
theme.setThemePalette(originalPalette);
|
||||
}
|
||||
});
|
||||
|
||||
it("re-emits custom palette inline surface colors when the wallpaper is inactive", async () => {
|
||||
const theme = useTheme();
|
||||
const originalMode = theme.themeMode.value;
|
||||
const originalPalette = theme.themePalette.value;
|
||||
const originalColors = { ...theme.customUiColors.value };
|
||||
theme.setThemeMode("light");
|
||||
theme.setCustomUiColors({ ...originalColors, background: "#123456", sidebar: "#654321" });
|
||||
theme.setThemePalette("custom");
|
||||
try {
|
||||
// applyCustomUiColors has just written these inline values for the custom palette.
|
||||
document.documentElement.style.setProperty("--background", "rgb(18 52 86)");
|
||||
document.documentElement.style.setProperty("--sidebar", "rgb(101 67 33)");
|
||||
|
||||
const bg = useBackgroundImage(settingsWith({}));
|
||||
await vi.waitFor(() => {
|
||||
expect(document.documentElement.style.getPropertyValue("--background")).toBe("rgb(18 52 86)");
|
||||
expect(document.documentElement.style.getPropertyValue("--sidebar")).toBe("rgb(101 67 33)");
|
||||
});
|
||||
expect(bg.active.value).toBe(false);
|
||||
} finally {
|
||||
theme.setCustomUiColors(originalColors);
|
||||
theme.setThemeMode(originalMode);
|
||||
theme.setThemePalette(originalPalette);
|
||||
}
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user