Interface ThemeContextType

The shape of the theme context value provided to consumers.

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

The current theme preferences (system and local).

isDarkMode

isDarkMode: boolean

Whether dark mode is currently enabled.

setThemeMode

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

Function to set the theme mode.

toggleTheme

toggleTheme: () => Promise<boolean>

Function to toggle between dark and light modes.

Settings

Member Visibility

On This Page

Properties