jake/dark-mode
1
Fork 0
mirror of https://github.com/jakejarvis/dark-mode.git synced 2025-04-26 01:45:24 -04:00
Code Issues Releases Activity
dark-mode/README.md
Jake Jarvis 2d02c52925
Update README.md
2021-08-03 13:23:21 -04:00

1.3 KiB
Raw Blame History

🌓 Dark mode switcheroo

CI npm (scoped)

Simple dark mode switching with saved preference via local storage & dynamic OS setting detection!

Usage

darkMode([...options])

import darkMode from "@jakejarvis/dark-mode";

darkMode({
  toggle: document.querySelector(".dark-mode-toggle"),
  classes: {
    light: "light",
    dark: "dark",
  },
  default: "light",
  storageKey: "dark_mode_pref",
});

Options

All optional.

  • toggle: The clickable HTML element used to toggle between the two themes. (optional)
  • classes: An object containing the <body> class names for the light and dark themes. (optional, default: { light: "light", dark: "dark" })
  • default: The initial <body> class hard-coded into the HTML template. (optional, default: light)
  • storageKey: Name of the localStorage key holding the user's preference. (optional, default: dark_mode_pref)

License

MIT