Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

4.5 KB
Raw Blame
import { ScriptOnce } from '@tanstack/react-router';
import { createIsomorphicFn } from '@tanstack/react-start';
import { createContext, type ReactNode, use, useEffect } from 'react';
import { z } from 'zod';
import { useCookieStore } from '@/hooks/use-cookie-store';
import { mapKeys } from '@/utils/object-to-zod-enums';

const UserThemeSchema = z.enum(['light', 'dark', 'system']).catch('system');
const AppThemeSchema = z.enum(['light', 'dark']).catch('light');

const clientOnly = <T extends (...args: any[]) => void>(fn: T) => {
  if (typeof window === 'undefined') {
    return (() => {}) as unknown as T;
  }
  return fn;
};

export type UserTheme = z.infer<typeof UserThemeSchema>;
export type AppTheme = z.infer<typeof AppThemeSchema>;

const themeStorageKey = 'ui-theme';

const getSystemTheme = createIsomorphicFn()
  .server((): AppTheme => 'light')
  .client((): AppTheme => {
    return window.matchMedia('(prefers-color-scheme: dark)').matches
      ? 'dark'
      : 'light';
  });

const handleThemeChange = clientOnly((userTheme: UserTheme) => {
  const validatedTheme = UserThemeSchema.parse(userTheme);

  const root = document.documentElement;
  root.classList.remove('light', 'dark', 'system');

  if (validatedTheme === 'system') {
    const systemTheme = getSystemTheme();
    root.classList.add(systemTheme, 'system');
  } else {
    root.classList.add(validatedTheme);
  }
});

const setupPreferredListener = clientOnly(() => {
  const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)');
  const handler = () => handleThemeChange('system');
  mediaQuery.addEventListener('change', handler);
  return () => mediaQuery.removeEventListener('change', handler);
});

export const themeConfig: Record<UserTheme, { icon: string; label: string }> = {
  light: { icon: '☀️', label: 'Light' },
  dark: { icon: '🌒', label: 'Dark' },
  system: { icon: '💻', label: 'System' },
};

const themes = mapKeys(themeConfig).map((key) => ({
  key,
  ...themeConfig[key],
}));

const themeScript = (() => {
  function themeFn() {
    try {
      // Read theme from cookie
      const cookies = document.cookie.split('; ');
      const themeCookie = cookies.find((c) => c.startsWith('ui-theme='));
      const storedTheme = themeCookie ? themeCookie.split('=')[1] : 'system';
      const validTheme = ['light', 'dark', 'system'].includes(storedTheme)
        ? storedTheme
        : 'system';

      if (validTheme === 'system') {
        const systemTheme = window.matchMedia('(prefers-color-scheme: dark)')
          .matches
          ? 'dark'
          : 'light';
        document.documentElement.classList.add(systemTheme, 'system');
      } else {
        document.documentElement.classList.add(validTheme);
      }
    } catch (e) {
      const systemTheme = window.matchMedia('(prefers-color-scheme: dark)')
        .matches
        ? 'dark'
        : 'light';
      document.documentElement.classList.add(systemTheme, 'system');
    }
  }
  return `(${themeFn.toString()})();`;
})();

export const ThemeScriptOnce = () => {
  return <ScriptOnce>{themeScript}</ScriptOnce>;
};

type ThemeContextProps = {
  userTheme: UserTheme;
  appTheme: AppTheme;
  theme: AppTheme;
  setTheme: (theme: UserTheme) => void;
  getNextTheme: () => UserTheme;
  themes: typeof themes;
};
const ThemeContext = createContext<ThemeContextProps | undefined>(undefined);

type ThemeProviderProps = {
  children: ReactNode;
};
export function ThemeProvider({ children }: ThemeProviderProps) {
  const [userTheme, setUserTheme] = useCookieStore<UserTheme>(
    'ui-theme',
    'system'
  );

  useEffect(() => {
    if (userTheme !== 'system') {
      return;
    }
    return setupPreferredListener();
  }, [userTheme]);

  const appTheme = userTheme === 'system' ? getSystemTheme() : userTheme;

  const setTheme = (newUserTheme: UserTheme) => {
    const validatedTheme = UserThemeSchema.parse(newUserTheme);
    setUserTheme(validatedTheme);
    handleThemeChange(validatedTheme);
  };

  const getNextTheme = () => {
    const themes = Object.keys(themeConfig) as UserTheme[];
    const currentIndex = themes.indexOf(userTheme);
    const nextIndex = (currentIndex + 1) % themes.length;
    return themes[nextIndex];
  };

  return (
    <ThemeContext
      value={{
        userTheme,
        appTheme,
        theme: appTheme,
        setTheme,
        getNextTheme,
        themes,
      }}
    >
      {children}
    </ThemeContext>
  );
}

export const useTheme = () => {
  const context = use(ThemeContext);
  if (!context) {
    throw new Error('useTheme must be used within a ThemeProvider');
  }

  return context;
};