jnsdls/use-dark-mode

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

use-dark-mode

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

useDarkMode works in one of two ways:

1. By toggling a CSS class on whatever element you specify (defaults to document.body). You then setup your CSS to display different views based on the presence of the selector. For example, the following CSS is used in the demo app to ease the background color in/out of dark mode.

   body {
     background-color: #fff;
     color: #333;
     transition: background-color 0.3s ease;
   }
   body.dark-mode {
     background-color: #1a1919;
     color: #999;
   }

2. If you don't use global classes, you can specify a callback and take care of the implementation of switching to dark mode yourself.

Requirement ⚠️

To use use-dark-mode, you must use [email protected]. React Hooks is currently at RFC stage.

Installation

$ npm i use-dark-mode

Usage

const [isDarkMode, setDarkMode, clearDarkMode, toggleDarkMode] = useDarkMode(
  false,
  optionalConfigObject
);

Config

You pass useDarkMode an initialState (whether it should be in dark mode by by default) and an optional configuration object. The configuration object contains the following.

Key	Description
className	The class to apply. Default = dark-mode.
element	The element to apply the class name. Default = document.body.
callback	A callback function that will be called when the state changes and it is safe to access the DOM (i.e. it is called from within a useEffect). If you specify callback then className and element are ignored (i.e. no classes are automatically placed on the DOM). You have full control!

Return object

Key	Description
isDarkMode	A boolean containing the current state of dark mode.
setDarkMode	A function that allows you to set dark mode to true.
clearDarkMode	A function that allows you to set dark mode to false.
toggleDarkMode	A function that allows you to toggle dark mode.

Example

Here is a simple component that uses useDarkMode to provide a dark mode toggle control. If dark mode is selected, the CSS class dark-mode is applied to document.body and is removed when de-selected.

import React from 'react';

import Toggle from './Toggle';
import useDarkMode from 'use-dark-mode';

const DarkModeToggle = () => {
  const [isDarkMode, setDarkMode, clearDarkMode, toggleDarkMode] = useDarkMode(
    false
  );

  return (
    <div>
      <button type="button" onClick={clearDarkMode}>
        ☀
      </button>
      <Toggle checked={isDarkMode} onChange={toggleDarkMode} />
      <button type="button" onClick={setDarkMode}>
        ☾
      </button>
    </div>
  );
};

export default DarkModeToggle;

Live demo

You can view/edit the dark mode demo app on CodeSandbox.

License

MIT Licensed

---

A special thanks to @revelcw for his help and inspiration on this package.