day-night-switcher v0.9.2

Use day and night theme on your website

Reading a website at night with a clear theme is tiring for the eyes.

A good idea is then to have a clear version and a dark version of the site, one for the day, the other for the night.

This little lib deal with that.

Before continue, you can see a live example on Codepen: https://codepen.io/malenki/pen/MdXRbv

Prerequisites

CSS

In your HTML, add into HEAD followings:

<link rel="alternate stylesheet" data-daynight-css="night" type="text/css" href="night.css">
<link rel="stylesheet" data-daynight-css="day" type="text/css" href="day.css">

The important part is to use attribute data-daynight-css on CSS used for night and day times.

At load time, the disabled theme must have attribute rel="alternate stylesheet", enabled theme must have attribute rel="stylesheet".

Note: more than one CSS per moment is possible, just do not forget the data-nightday-css attribute.

Swither(s)

To switch from day to night or night to day, you must define at least one switcher, for example using a link:

<a data-daynight-moment="day" href="#foo">Switch to night theme</a>

Note that attribute data-daynight-moment must have actual desired moment.

Add script

Add script at bottom of the BODY tag:

<script src="/path/to/daynight.min.js"></script>

And that’s all, no more work to enable this feature!

Note: you can download the script from Github, or you can get it using NPM:

npm i day-night-switcher

See the NPM page project: https://www.npmjs.com/package/day-night-switcher

Styling switcher

As switcher uses specific attribute, you may define some style to change it and show its status.

An example could be:

    a[data-daynight-moment] {
        text-decoration: none;
        transition: all 200ms;
    }
    a[data-daynight-moment*="night"]:before {
        content: "🌙";
    }

    a[data-daynight-moment*="day"]:before {
        content: "🌞";
    }

Avoiding Flash changing all CSS

It is better to use two CSS files to define only colors changes and keep apart other CSS features. If not, you get a "flash" while changing CSS day/night.

To avoid it, you could add attribut data-daynight-base-colors to SCRIPT tag containing call to JS file. Its value is a string with colors values separated by period. First is for day, and second is for night. This colors are set for BODY tag before switching CSS file.

Usefull while browsing the site, no "white flash" on changing page in dark mode.

Exemple:

<script src="/path/to/daynight.min.js" data-daynight-base-colors="#fff;#222"></script>