Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

refactor(theme): in-house theme management (#979)

Corentin Thomasset555593484752
diff --git a/apps/papra-client/index.html b/apps/papra-client/index.html
index 8c1b1755..5e762546 100644
--- a/apps/papra-client/index.html
+++ b/apps/papra-client/index.html
@@ -66,14 +66,16 @@
<style>.sr-only {position: absolute;width: 1px;height: 1px;padding: 0;margin: -1px;overflow: hidden;clip: rect(0, 0, 0, 0);white-space: nowrap;border-width: 0;}</style>
- <!-- Prevent flash of wrong theme on load -->
+ <!-- Prevent FOUC, default to dark theme -->
<script>
(function () {
- const stored = localStorage?.getItem('papra_color_mode') ?? 'dark';
+ try{
+ const stored = localStorage?.getItem('papra_color_mode');
+ const systemPrefersDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
+ const isLight = stored === 'light' || (stored === 'system' && !systemPrefersDark);
- if (stored === 'dark') {
- document.documentElement.setAttribute('data-kb-theme', 'dark');
- }
+ document.documentElement.setAttribute('data-kb-theme', isLight ? 'light' : 'dark');
+ } catch {}
})();
</script>
</head>
diff --git a/apps/papra-client/src/index.tsx b/apps/papra-client/src/index.tsx
index ef990445..5120cd12 100644
--- a/apps/papra-client/src/index.tsx
+++ b/apps/papra-client/src/index.tsx
@@ -1,7 +1,5 @@
/* @refresh reload */
-import type { ConfigColorMode } from '@kobalte/core/color-mode';
-import { ColorModeProvider, createLocalStorageManager } from '@kobalte/core/color-mode';
import { Router } from '@solidjs/router';
import { QueryClientProvider } from '@tanstack/solid-query';
@@ -15,6 +13,7 @@ import { I18nProvider } from './modules/i18n/i18n.provider';
import { AboutDialogProvider } from './modules/shared/components/about-dialog';
import { ConfirmModalProvider } from './modules/shared/confirm';
import { queryClient } from './modules/shared/query/query-client';
+import { ThemeProvider } from './modules/theme/theme.provider';
import { IdentifyUser } from './modules/tracking/components/identify-user.component';
import { PageViewTracker } from './modules/tracking/components/pageview-tracker.component';
import { Toaster } from './modules/ui/components/sonner';
@@ -28,10 +27,6 @@ const DemoIndicator = isDemoMode
render(
() => {
- const initialColorMode: ConfigColorMode = 'dark';
- const colorModeStorageKey = 'papra_color_mode';
- const localStorageManager = createLocalStorageManager(colorModeStorageKey);
-
return (
<QueryClientProvider client={queryClient}>
<Router
@@ -42,10 +37,7 @@ render(
<IdentifyUser />
<I18nProvider>
<ConfirmModalProvider>
- <ColorModeProvider
- initialColorMode={initialColorMode}
- storageManager={localStorageManager}
- >
+ <ThemeProvider>
<CommandPaletteProvider>
<ConfigProvider>
<AboutDialogProvider>
@@ -60,7 +52,7 @@ render(
<Toaster />
</CommandPaletteProvider>
- </ColorModeProvider>
+ </ThemeProvider>
</ConfirmModalProvider>
</I18nProvider>
diff --git a/apps/papra-client/src/modules/command-palette/command-palette.provider.tsx b/apps/papra-client/src/modules/command-palette/command-palette.provider.tsx
index ca15c96b..50148ef0 100644
--- a/apps/papra-client/src/modules/command-palette/command-palette.provider.tsx
+++ b/apps/papra-client/src/modules/command-palette/command-palette.provider.tsx
@@ -8,7 +8,7 @@ import { useI18n } from '../i18n/i18n.provider';
import { cn } from '../shared/style/cn';
import { toArrayIf } from '../shared/utils/array';
import { debounce } from '../shared/utils/timing';
-import { useThemeStore } from '../theme/theme.store';
+import { useTheme } from '../theme/theme.provider';
import { CommandDialog, CommandEmpty, CommandGroup, CommandInput, CommandItem, CommandList, CommandLoading } from '../ui/components/command';
const CommandPaletteContext = createContext<{
@@ -53,7 +53,7 @@ export const CommandPaletteProvider: ParentComponent = (props) => {
});
const navigate = useNavigate();
- const { setColorMode } = useThemeStore();
+ const { setThemePreference } = useTheme();
const searchDocs = debounce(async ({ searchQuery }: { searchQuery: string }) => {
const [result] = await safely(fetchOrganizationDocuments({ searchQuery, organizationId: params.organizationId, pageIndex: 0, pageSize: 5 }));
@@ -108,17 +108,17 @@ export const CommandPaletteProvider: ParentComponent = (props) => {
{
label: t('layout.theme.light'),
icon: 'i-tabler-sun',
- action: () => setColorMode({ mode: 'light' }),
+ action: () => setThemePreference('light'),
},
{
label: t('layout.theme.dark'),
icon: 'i-tabler-moon',
- action: () => setColorMode({ mode: 'dark' }),
+ action: () => setThemePreference('dark'),
},
{
label: t('layout.theme.system'),
icon: 'i-tabler-device-laptop',
- action: () => setColorMode({ mode: 'system' }),
+ action: () => setThemePreference('system'),
},
],
},
diff --git a/apps/papra-client/src/modules/theme/theme.constants.ts b/apps/papra-client/src/modules/theme/theme.constants.ts
new file mode 100644
index 00000000..0144df5a
--- /dev/null
+++ b/apps/papra-client/src/modules/theme/theme.constants.ts
@@ -0,0 +1,9 @@
+export const THEME_PREFERENCES = {
+ LIGHT: 'light',
+ DARK: 'dark',
+ SYSTEM: 'system',
+} as const;
+
+export const THEME_STORAGE_KEY = 'papra_color_mode';
+export const DEFAULT_THEME_PREFERENCE = THEME_PREFERENCES.DARK;
+export const THEME_ATTRIBUTE = 'data-kb-theme';
diff --git a/apps/papra-client/src/modules/theme/theme.models.test.ts b/apps/papra-client/src/modules/theme/theme.models.test.ts
new file mode 100644
index 00000000..6054d3b2
--- /dev/null
+++ b/apps/papra-client/src/modules/theme/theme.models.test.ts
@@ -0,0 +1,31 @@
+import { describe, expect, test } from 'vitest';
+import { getThemeFromPreference, isValidThemePreference } from './theme.models';
+
+describe('theme models', () => {
+ describe('isValidThemePreference', () => {
+ test('valid theme preferences are either "light", "dark" or "system"', () => {
+ expect(isValidThemePreference('light')).toBe(true);
+ expect(isValidThemePreference('dark')).toBe(true);
+ expect(isValidThemePreference('system')).toBe(true);
+
+ expect(isValidThemePreference('invalid')).toBe(false);
+ expect(isValidThemePreference(123)).toBe(false);
+ expect(isValidThemePreference(null)).toBe(false);
+ expect(isValidThemePreference(undefined)).toBe(false);
+ expect(isValidThemePreference({})).toBe(false);
+ });
+ });
+
+ describe('getThemeFromPreference', () => {
+ test('returns the system theme when preference is "system", otherwise returns the theme preference', () => {
+ expect(getThemeFromPreference({ themePreference: 'light', systemTheme: 'dark' })).toBe('light');
+ expect(getThemeFromPreference({ themePreference: 'light', systemTheme: 'light' })).toBe('light');
+
+ expect(getThemeFromPreference({ themePreference: 'dark', systemTheme: 'dark' })).toBe('dark');
+ expect(getThemeFromPreference({ themePreference: 'dark', systemTheme: 'light' })).toBe('dark');
+
+ expect(getThemeFromPreference({ themePreference: 'system', systemTheme: 'dark' })).toBe('dark');
+ expect(getThemeFromPreference({ themePreference: 'system', systemTheme: 'light' })).toBe('light');
+ });
+ });
+});
diff --git a/apps/papra-client/src/modules/theme/theme.models.ts b/apps/papra-client/src/modules/theme/theme.models.ts
new file mode 100644
index 00000000..ee12ac7b
--- /dev/null
+++ b/apps/papra-client/src/modules/theme/theme.models.ts
@@ -0,0 +1,18 @@
+import type { Theme, ThemePreference } from './theme.types';
+import { THEME_PREFERENCES } from './theme.constants';
+
+export function isValidThemePreference(value: unknown): value is ThemePreference {
+ return (
+ value === THEME_PREFERENCES.LIGHT
+ || value === THEME_PREFERENCES.DARK
+ || value === THEME_PREFERENCES.SYSTEM
+ );
+}
+
+export function getThemeFromPreference({ themePreference, systemTheme }: { themePreference: ThemePreference; systemTheme: Theme }): Theme {
+ if (themePreference === THEME_PREFERENCES.SYSTEM) {
+ return systemTheme;
+ }
+
+ return themePreference;
+}
diff --git a/apps/papra-client/src/modules/theme/theme.provider.tsx b/apps/papra-client/src/modules/theme/theme.provider.tsx
new file mode 100644
index 00000000..b51f182e
--- /dev/null
+++ b/apps/papra-client/src/modules/theme/theme.provider.tsx
@@ -0,0 +1,79 @@
+import type { ParentComponent } from 'solid-js';
+import type { Theme, ThemePreference } from './theme.types';
+import { createContext, createSignal, onCleanup, useContext } from 'solid-js';
+import { DEFAULT_THEME_PREFERENCE, THEME_ATTRIBUTE, THEME_STORAGE_KEY } from './theme.constants';
+import { getThemeFromPreference, isValidThemePreference } from './theme.models';
+
+const themeContext = createContext<{
+ getTheme: () => Theme;
+ getThemePreference: () => ThemePreference;
+ setThemePreference: (theme: ThemePreference) => void;
+}>();
+
+export function useTheme() {
+ const context = useContext(themeContext);
+
+ if (!context) {
+ throw new Error('useTheme must be used within a ThemeProvider');
+ }
+
+ return context;
+}
+
+export const ThemeProvider: ParentComponent = (props) => {
+ const themeMediaQuery = window.matchMedia('(prefers-color-scheme: dark)');
+
+ const [systemTheme, setSystemTheme] = createSignal<Theme>(themeMediaQuery.matches ? 'dark' : 'light');
+
+ const getInitialThemePreference = (): ThemePreference => {
+ const storedPreference = localStorage.getItem(THEME_STORAGE_KEY);
+
+ if (isValidThemePreference(storedPreference)) {
+ return storedPreference;
+ }
+
+ return DEFAULT_THEME_PREFERENCE;
+ };
+
+ const [getLocalThemePreference, setLocalThemePreference] = createSignal<ThemePreference>(getInitialThemePreference());
+
+ const getTheme = () => getThemeFromPreference({ themePreference: getLocalThemePreference(), systemTheme: systemTheme() });
+
+ const applyTheme = (theme: Theme) => {
+ document.documentElement.setAttribute(THEME_ATTRIBUTE, theme);
+ };
+
+ const setThemePreference = (newPreference: ThemePreference) => {
+ setLocalThemePreference(newPreference);
+ localStorage.setItem(THEME_STORAGE_KEY, newPreference);
+
+ const newTheme = getThemeFromPreference({ themePreference: newPreference, systemTheme: systemTheme() });
+ applyTheme(newTheme);
+ };
+
+ const handleSystemThemeChange = (e: MediaQueryListEvent) => {
+ const newSystemTheme: Theme = e.matches ? 'dark' : 'light';
+ setSystemTheme(newSystemTheme);
+
+ if (getLocalThemePreference() === 'system') {
+ applyTheme(newSystemTheme);
+ }
+ };
+
+ themeMediaQuery.addEventListener('change', handleSystemThemeChange);
+ onCleanup(() => {
+ themeMediaQuery.removeEventListener('change', handleSystemThemeChange);
+ });
+
+ return (
+ <themeContext.Provider
+ value={{
+ getTheme,
+ getThemePreference: getLocalThemePreference,
+ setThemePreference,
+ }}
+ >
+ {props.children}
+ </themeContext.Provider>
+ );
+};
diff --git a/apps/papra-client/src/modules/theme/theme.store.ts b/apps/papra-client/src/modules/theme/theme.store.ts
deleted file mode 100644
index 08baae97..00000000
--- a/apps/papra-client/src/modules/theme/theme.store.ts
+++ /dev/null
@@ -1,11 +0,0 @@
-import type { ConfigColorMode } from '@kobalte/core/color-mode';
-import { useColorMode } from '@kobalte/core/color-mode';
-
-export function useThemeStore() {
- const { setColorMode, colorMode: getColorMode } = useColorMode();
-
- return {
- setColorMode: ({ mode }: { mode: ConfigColorMode }) => setColorMode(mode),
- getColorMode,
- };
-}
diff --git a/apps/papra-client/src/modules/theme/theme.types.ts b/apps/papra-client/src/modules/theme/theme.types.ts
new file mode 100644
index 00000000..0f460048
--- /dev/null
+++ b/apps/papra-client/src/modules/theme/theme.types.ts
@@ -0,0 +1,2 @@
+export type Theme = 'light' | 'dark';
+export type ThemePreference = Theme | 'system';
diff --git a/apps/papra-client/src/modules/ui/layouts/auth-layout.component.tsx b/apps/papra-client/src/modules/ui/layouts/auth-layout.component.tsx
index 54acaa41..35d88eb7 100644
--- a/apps/papra-client/src/modules/ui/layouts/auth-layout.component.tsx
+++ b/apps/papra-client/src/modules/ui/layouts/auth-layout.component.tsx
@@ -1,13 +1,13 @@
import type { ParentComponent } from 'solid-js';
import { A } from '@solidjs/router';
import { cn } from '@/modules/shared/style/cn';
-import { useThemeStore } from '@/modules/theme/theme.store';
+import { useTheme } from '@/modules/theme/theme.provider';
import { Button } from '../components/button';
import { DropdownMenu, DropdownMenuContent, DropdownMenuTrigger } from '../components/dropdown-menu';
import { LanguageSwitcher, ThemeSwitcher } from './sidenav.layout';
export const AuthLayout: ParentComponent = (props) => {
- const themeStore = useThemeStore();
+ const { getTheme } = useTheme();
return (
<div class="h-screen w-full flex flex-col">
@@ -21,7 +21,7 @@ export const AuthLayout: ParentComponent = (props) => {
<div class="flex gap-2">
<DropdownMenu>
<DropdownMenuTrigger as={Button} variant="outline" aria-label="Theme switcher">
- <div class={cn('size-4.5', { 'i-tabler-moon': themeStore.getColorMode() === 'dark', 'i-tabler-sun': themeStore.getColorMode() === 'light' })} />
+ <div class={cn('size-4.5', { 'i-tabler-moon': getTheme() === 'dark', 'i-tabler-sun': getTheme() === 'light' })} />
<div class="ml-2 i-tabler-chevron-down text-muted-foreground text-sm" />
</DropdownMenuTrigger>
<DropdownMenuContent class="w-42">
diff --git a/apps/papra-client/src/modules/ui/layouts/sidenav.layout.tsx b/apps/papra-client/src/modules/ui/layouts/sidenav.layout.tsx
index 33f8b02c..2608d685 100644
--- a/apps/papra-client/src/modules/ui/layouts/sidenav.layout.tsx
+++ b/apps/papra-client/src/modules/ui/layouts/sidenav.layout.tsx
@@ -8,7 +8,7 @@ import { useDocumentUpload } from '@/modules/documents/components/document-impor
import { GlobalDropArea } from '@/modules/documents/components/global-drop-area.component';
import { useI18n } from '@/modules/i18n/i18n.provider';
import { UsageWarningCard } from '@/modules/subscriptions/components/usage-warning-card';
-import { useThemeStore } from '@/modules/theme/theme.store';
+import { useTheme } from '@/modules/theme/theme.provider';
import { Button } from '@/modules/ui/components/button';
import { UserSettingsDropdown } from '@/modules/users/components/user-settings.component';
import { useCurrentUser } from '@/modules/users/composables/useCurrentUser';
@@ -16,20 +16,20 @@ import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuRadioG
import { Sheet, SheetContent, SheetTrigger } from '../components/sheet';
export const ThemeSwitcher: Component = () => {
- const themeStore = useThemeStore();
+ const { setThemePreference } = useTheme();
const { t } = useI18n();
return (
<>
- <DropdownMenuItem onClick={() => themeStore.setColorMode({ mode: 'light' })} class="flex items-center gap-2 cursor-pointer">
+ <DropdownMenuItem onClick={() => setThemePreference('light')} class="flex items-center gap-2 cursor-pointer">
<div class="i-tabler-sun text-lg" />
{t('layout.theme.light')}
</DropdownMenuItem>
- <DropdownMenuItem onClick={() => themeStore.setColorMode({ mode: 'dark' })} class="flex items-center gap-2 cursor-pointer">
+ <DropdownMenuItem onClick={() => setThemePreference('dark')} class="flex items-center gap-2 cursor-pointer">
<div class="i-tabler-moon text-lg" />
{t('layout.theme.dark')}
</DropdownMenuItem>
- <DropdownMenuItem onClick={() => themeStore.setColorMode({ mode: 'system' })} class="flex items-center gap-2 cursor-pointer">
+ <DropdownMenuItem onClick={() => setThemePreference('system')} class="flex items-center gap-2 cursor-pointer">
<div class="i-tabler-device-laptop text-lg" />
{t('layout.theme.system')}
</DropdownMenuItem>
@@ -70,7 +70,7 @@ export const SidenavLayout: ParentComponent<{
sideNav: Component;
showSearch?: boolean;
}> = (props) => {
- const themeStore = useThemeStore();
+ const { getTheme } = useTheme();
const params = useParams();
const { openCommandPalette } = useCommandPalette();
const { t } = useI18n();
@@ -122,7 +122,7 @@ export const SidenavLayout: ParentComponent<{
<DropdownMenu>
<DropdownMenuTrigger as={Button} class="text-base hidden sm:flex" variant="outline" aria-label="Theme switcher">
- <div classList={{ 'i-tabler-moon': themeStore.getColorMode() === 'dark', 'i-tabler-sun': themeStore.getColorMode() === 'light' }} />
+ <div classList={{ 'i-tabler-moon': getTheme() === 'dark', 'i-tabler-sun': getTheme() === 'light' }} />
<div class="ml-2 i-tabler-chevron-down text-muted-foreground text-sm" />
</DropdownMenuTrigger>
<DropdownMenuContent class="w-42">