@oceanprotocol/use-dark-mode/types/index.d.ts

A custom React Hook to help you implement a "dark mode" component.

/**
 * A config object allowing you to specify certain aspects of `useDarkMode`
 */
export interface DarkModeConfig {
  classNameDark?: string; // A className to set "dark mode". Default = "dark-mode".
  classNameLight?: string; // A className to set "light mode". Default = "light-mode".
  element?: HTMLElement; // The element to apply the className. Default = `document.body`
  onChange?: (val?: boolean) => void; // Overide the default className handler with a custom callback.
  storageKey?: string; // Specify the `localStorage` key. Default = "darkMode". Set to `null` to disable persistent storage.
  storageProvider?: WindowLocalStorage; // A storage provider. Default = `localStorage`.
  global?: Window; // The global object. Default = `window`.
}

/**
 * An object returned from a call to `useDarkMode`.
 */
export interface DarkMode {
  readonly value: boolean;
  enable: () => void;
  disable: () => void;
  toggle: () => void;
}

/**
 * A custom React Hook to help you implement a "dark mode" component for your application.
 */
export default function useDarkMode(
  initialState?: boolean,
  config?: DarkModeConfig
): DarkMode;