Darkmode made easy
npm install darkenhtml
`
$3
Install darken with npm:
`sh
npm install darken
`
And import it in your code:
`javascript
import darken from 'darken';
const darkmode = new darken();
`
Usage
Here is a basic usage of darken:
`html
`
You can either use a class and/or CSS variables to customize your styles.
Options
`javascript
const defaultOptions = {
container: null,
default: "light",
toggle: null,
remember: "darken-mode",
usePrefersColorScheme: true,
timestamps: {},
class: "darken",
variables: {},
stylesheets: {},
}
`
$3
Type: String, Default: null
Element selector to the container of darken. The dark mode will be applied only to the selected container.
If the value is left to null, the document element will be selected instead.
$3
Type: String, Default: "light"
Defines the default mode on page load.
$3
Type: String, Default: null
Element selector to the toggle button, the selected element will call the toggle method on click.
$3
Type: String, Default: "darken-mode"
Name of the value stored in the browser local storage, this value contains the active mode ("dark" or "light").
If this option is set to null the active mode is not stored.
$3
Type: Boolean, Default: true
If true the prefers-color-scheme media query will be used to determine the default mode.
If the remember option is active, this will only be used if no active mode is stored (in most case the first time a user comes to the app/website). If the remember option is not active then a listener will be added to the prefers-color-scheme media query for live update.
$3
Type: Object, Default: {}
Define the stylesheet path of each mode. This stylesheet href will be changed on mode switch dynamically. The stylesheet will be removed if no path is given for a mode.
Default stylesheet id is darken-stylesheet but can be changed.
`javascript
stylesheets: {
id: "darkmode-stylesheet",
dark: "dark.css",
light: "light.css",
}
`
$3
Type: Object, Default: {}
Define a timestamps mode switch to start light and dark modes at given times of the day.
There is 2 keys to the object, dark and light, the values of those keys are defining the times (using the format ) at wich the corresponding mode will start being active.
If the remember option is active, this will only be used if no active mode is stored (in most case the first time a user comes to the app/website).
If the usePrefersColorScheme option is active, this option will not be used.
`javascript
timestamps: {
dark: "20:00",
light: "6:00",
}
`
$3
Type: String, Default: "darken"
Class that will be added to the selected container when the dark Fmode is active. The class is removed of the selected container once the dark mode is disabled.
If no container is selected, the class will be added to the body element instead.
$3
Type: Object, Default: {}
List of CSS variables that will change when the dark mode is active.
The keys of the object are the variables names, the value are arrays where the 1th index is the value the variable will take in lightmode and the 2nd index the value the variable will take in dark mode. This is the most compact way to use variables.
`javascript
variables: {
"--name-of-the-variable": ["light mode value", "dark mode value"],
"--background-color": ["white", "black"],
}
`
If you prefer, you can use an object based syntax. This syntax is more clear but less compact.
`javascript
variables: {
"--name-of-the-variable": {
light: "light mode value",
dark: "dark mode value"
},
"--background-color": {
light: "white",
dark: "black"
},
}
`
API
The darken class is the entry point to the library.
`javascript
const darkmode = new darken(options, callback);
`
See details about options above. The options are optional.
The callback method will be called at every mode switch with a active boolean parameter. The callback is optional.
`javascript
const darkmode = new darken(function(active) {
if (active) console.log("Dark mode is active");
else console.log("Dark mode is inactive");
});
`
$3
Return: none
Toggles dark mode.
`javascript
darkmode.toggle();
`
$3
Return: none
Enables dark mode.
`javascript
darkmode.on();
`
$3
Return: none
Disables dark mode.
`javascript
darkmode.off();
`
Testing
You can launch tests and generate a coverage report using the following npm command :
`sh
npm test
`
If you want to test while developing, another command triggers the watch mode (But it does not generate coverage report) :
`sh
npm run test:watch
`
Contributing
Any help and contribution is always welcome, feel free to submit issues and/or contribute to the project.
1. Fork the Project
2. Create your Feature or Fix Branch (git checkout -b feature/feature-name or git checkout -b fix/fix-name)
3. Commit your Changes (git commit -m 'Add some feature or fix')
4. Push to the Branch (git push origin feature/feature-name or git push origin fix/fix-name)
5. Open a Pull Request
License
darken is distributed under the MIT License. See LICENSE` for more information.