darkmodejs

---

Utility package for managing Dark Mode on the web.

> Dark Mode is a feature in modern Operating Systems which allows you to change your default UI from a light to dark theme. On the web we can take advantage of this to control the theme of our website.

Utilises the matchMedia API and its listeners, in combination with the prefers-color-scheme media query, in order to fire functions whenever you're in Dark Mode.

!Example application using darkmodejs in Windows 10 Firefox
_Example application using darkmodejs in Windows 10 Firefox_

📝 Prerequisites

Requires an Operating System which supports Dark Mode:

- macOS 10.14
- iOS 13.0
- iPadOS 13.0
- Windows 10
- ... or greater

Also requires support for the prefers-color-scheme media query. A complete list of supported browsers can be found on caniuse.

> ⚠️ Breaking change in v2+: whilst the base API exposed by darkmodejs has remained the same, under the hood MediaQueryList's addListener and removeListener methods are marked as deprecated in the Web Standard, and have thus been replaced with addEventListener and removeEventListener respectfully. There is a slight difference in browser compatibility for very old browsers which were never explicitly supported, but for that reason a major version bump was created.

🏁 Install

``
$ npm install @assortment/darkmodejs
`

🎈 Usage

`js
import darkmodejs from '@assortment/darkmodejs';

const config = { onChange: (activeTheme, themes) => {} };

darkmodejs(config);
`

If you need ES5 support, you can require the package instead.

`js
const darkmodejs = require('@assortment/darkmodejs');
`

An example could be logging to console when a theme is active:

`js
import darkmodejs from '@assortment/darkmodejs';

const onChange = (activeTheme, themes) => {
switch (activeTheme) {
case themes.DARK:
console.log('darkmode enabled');
break;
case themes.LIGHT:
console.log('lightmode enabled');
break;
case themes.NO_PREF:
console.log('no preference enabled');
break;
case themes.NO_SUPP:
console.log('no support sorry');
break;
}
};

darkmodejs({ onChange });
`

You can also do a spot of cleanup by calling the removeListeners function that is returned from darkmodejs. It removes both DARK and LIGHT query listeners.

`js
const dmjs = darkmodejs({ onChange });

dmjs.removeListeners();
`

This can be useful when unmounting components or pages that use dynamic routing techniques.

⚙ API

$3

darkmodejs accepts a config object, which in turn accepts a single function of onChange.

#### onChange(activeTheme, themes)

_Type: Function. Required: No._

This function is called when darkmodejs is executed to check:

- if there is support for prefers-color-scheme;
- if the dark, light or no-preference theme is active.

The function is also bound to MediaQueryList.addListener to listen for changes.

##### activeTheme

_Type: String. Required: No._

Returns the current active theme.

##### themes

_Type: Object{String}. Required: No._

Returns all available theme states:

`
{
DARK: 'dark',
LIGHT: 'light',
NO_PREF: 'no-preference',
NO_SUPP: 'no-support'
}
`

$3

Once initiated, you also have access to the removeListeners function for cleanup purposes.

#### removeListeners

_Type: Function._

Removes both DARK and LIGHT query listeners.

🎬 Examples

The following examples are taken from darkmodejs-demo, a demo application created to show how you can use @assortment/darkmodejs in conjunction with Emotion Theming to control your website's theme based on a user's OS preference.

- 💻 Code: https://github.com/Assortment/darkmodejs-demo
- 🌐 URL: https://darkmodejs-demo.netlify.com/

$3

#### Safari (supported)

!Supported in MacOS with Safari

#### Firefox (supported)

!Supported in MacOS with Firefox

$3

#### Firefox (supported)

!Supported in Windows 10 with Firefox

#### Chrome (not supported until Chrome 76)

!Not supported in Windows 10 with Chrome 75

$3

Special mention to no-preference. To my knowledge I don't believe any Operating System currently allows for a no preference option, so there's no current circumstance where this returns true from a prefers-color-scheme` media query. That said, as its part of the specification I've included it as an option in the demo app if you ever want to do anything specific.

!Example no preference theme set

✍️ License

MIT © Luke Whitehouse