usePrefersDarkTheme

function usePrefersDarkTheme(disabled = false): boolean;

A simple wrapper around the useMediaQuery hook with "(prefers-color-scheme: dark)".

Example Usage

import { usePrefersDarkTheme } from "@react-md/core/theme/usePrefersDarkTheme";

function Example() {
  const prefersDarkTheme = usePrefersDarkTheme();
  if (prefersDarkTheme) {
    // do something
  }

  return null;
}

Parameters

disabled (optional) - Set to true to disable the media query

Returns

true if the user prefers the dark theme through their system preferences.

See Also