Interface ThemeModeContext

Source

interface ThemeModeContext {
  /**
   * Toggles between light and dark theme modes.
   * @returns Promise resolving to the new theme mode preference.
   * @source
   */
  toggle: () => Promise<boolean>;

  /**
   * Sets the theme to dark mode.
   * @source
   */
  dark: () => Promise<void>;

  /**
   * Sets the theme to light mode.
   * @source
   */
  light: () => Promise<void>;

  /**
   * Sets the theme to system preference (respects OS theme).
   * @returns Promise resolving to whether system preference was applied.
   * @source
   */
  system: () => Promise<boolean>;

  /**
   * Retrieves the current theme mode setting.
   * @returns Promise resolving to the current mode: "dark", "light", or "system".
   * @source
   */
  current: () => Promise<"dark" | "light" | "system">;
}
Copy