darkmode-helper
v0.4.2
Published
small module that helps manage dark mode
Downloads
10
Readme
darkmode-helper
small module to help manage dark mode. It provides functions for toggling dark mode, switching between light and dark modes, using system mode, and automatically saves the preference in local storage (or a custom storage backend). Also works with windicss / tailwindcss with dark mode set to class.
Table of Contents
install
install with package manager of choice. for example:
pnpm i -D darkmode-helperusage
Use this with a frontend bundler. CDN not supported at the moment, sorry!
import { define_darkmode_helper, create_local_storage } from "darkmode-helper";
export const use_darkmode_helper = await define_darkmode_helper(create_local_storage());
// then, in any other file that it is needed in
import { use_darkmode_helper } from "./other-file";
const helper = use_darkmode_helper();
helper.watch(mode => console.log(mode));
document.querySelector("#dark-button").onclick = () => helper.set_setting("dark");
document.querySelector("#light-button").onclick = () => helper.set_setting("light");
document.querySelector("#system-button").onclick = () => helper.set_setting("system");To detect the mode, import and add dark_watcher, or light_watcher, depending on what you want, as a watcher:
import { dark_watcher } from "darkmode-helper";
helper.watch(dark_watcher);query for the class .dark for dark_watcher, or .light for light_watcheron the <body> tag. If it is there, that mode is on; if not, the opposite mode should be used. You only need one of the two. The setting defaults to using system's color scheme mode. The above code snippet will be enough for tailwind/windicss dark mode set to class.
This module ships additional documentation in the form of jsdoc comments.