Interface ThemeContextType

Context value providing theme state and action functions.

Source

interface ThemeContextType {
  theme: ThemePreferences;
  isDarkMode: boolean;
  setThemeMode: (mode: ThemeMode) => Promise<boolean>;
  toggleTheme: () => Promise<boolean>;
}
interface ThemeContextType {
    theme: ThemePreferences;
    isDarkMode: boolean;
    setThemeMode: (mode: ThemeMode) => Promise<boolean>;
    toggleTheme: () => Promise<boolean>;
}

Properties

theme isDarkMode setThemeMode toggleTheme

Properties

theme

theme: ThemePreferences

Current theme preferences (system preference and local override).

isDarkMode

isDarkMode: boolean

Whether dark mode is currently applied to the document.

setThemeMode

setThemeMode: (mode: ThemeMode) => Promise<boolean>

Function to set the theme mode (dark, light, or system).

toggleTheme

toggleTheme: () => Promise<boolean>

Function to toggle between dark and light modes (preserves system mode if set).

Settings

Member Visibility

On This Page

Properties