drkmd-js

drkmd.js

Simple dark-mode/light-mode logic for any website

🔮 Live Demo

⚡ Features

• Easy to integrate with any site (via script tag or NPM)
• Specify different styles for the dark and light mode with CSS classes
• Automatically detects system theme (and theme changes)
• Trigger a them change with the default theme toggle, a custom element or even programmatically
• Stores users choice in local storage or optionally as a cookie
• Emits a theme-change event for advanced use cases like changing images

👋 Introduction

drkmd.js (short for darkmode.js) lets you add a dark-mode/light-mode toggle to any website. The library detects the system theme automatically and even saves the users choice in local storage or as a cookie.

The library will add the class theme-dark/theme-light to the body of the page and set the attribute data-theme to dark/light on the html tag which can be used to specify different css styles depending on the theme. You can also listen to a theme-change event for more advanced use cases. See usage below how you can customize your page with this.

🚀 Get started

Script tag

Add this to your HTML page:

<script src="https://cdn.jsdelivr.net/npm/drkmd-js/dist/drkmd-js.min.js" data-drkmd-attach></script>

NPM

Install drkmd.js using NPM

npm install drkmd-js

Then add the following JavaScript code:

import Darkmode from 'drkmd-js'

new Darkmode().attach()

Both methods will add the darkmode toggle with all the default options to your page.

The last step is to specify the styling for each theme and then you're done 🎉

Enjoy the dark side 🖤

📚 Usage

Styling

There are multiple ways to specify the different styles for the dark and light mode when using drkmd.js.

drkmd.js adds the class theme-dark/theme-light to the body element of your page, which can be used to specify different styles for each theme:

/* Styles for light theme */
.theme-light {
    background: #fff;
}

/* Styles for dark theme */
.theme-dark {
    background: #000;
}

In most cases it is easier to specify css-variables for different themes (See below for an example).

drkmd.js also adds the attribute data-theme with either light or dark as the value to the html tag. With this the different themes can also be specified with the css selector [data-theme="dark"] and [data-theme="dark"].

Default theme toggle

The easiest way to change the theme is to use the included theme toggle by either adding the data-drkmd-attach attribute to the script tag (or any other element):

<script src="https://cdn.jsdelivr.net/npm/drkmd-js/dist/drkmd-js.min.js" data-drkmd-attach></script>

or by calling .attach():

new Darkmode().attach()

If you use any of the options you can also set attach: true to achieve the same as the two methods above.

By default the button will be added to the bottom right corner of the page and the users choice will be saved in local storage. This can be configured using the options.

Custom buttons

You can add the attribute data-drkmd-toggle to any element to transform it into a theme toggle:

<span data-drkmd-toggle>Toggle theme</span>

When the element is clicked the current theme will be changed.

You can also use data-drkmd-to-light and data-drkmd-to-dark to switch to a specific theme.

Programmatic

drkmd.js can also be used programmatically for more advanced use cases.

To enable/disable Darkmode you can use the method toggle():

const darkmode = new Darkmode()
darkmode.toggle()

There are also other methods available:

darkmode.attach() // Attach the default darkmode button to the page
darkmode.toggle() // Toggle the theme
darkmode.toLight() // Change theme to light
darkmode.toDark() // Change theme to dark
darkmode.currentTheme() // Returns the current theme as a string (dark/light)
darkmode.isDark() // Returns true if the current theme is dark
darkmode.isLight() // Returns true if the current theme is light

Events

By default drkmd.js emits a theme-change event everytime the theme changes:

import Darkmode from 'drkmd-js'

new Darkmode()

window.addEventListener('theme-change', e => {
    console.log(e.detail.to) // will return 'light' or 'dark'
})

This can be turned off by setting the option events: false.

The theme-change event could be used to change the src attribute of an <img> tag depending on the theme (example below) or modify the page in any other way with JavaScript when the theme changes.

⚙️ Options

You can customize the behaviour of drkmd.js and the style of the included toggle with these options:

Name	Description	Default	Example
localStorage	Store the users choice in the local storage	true	false
cookie	Store the users choice in a cookie (local storage takes precedence)	false	true
events	Emit the theme-change event	true	false
autoMatchOsTheme	Detect the system theme and automatically change to it	true	false
defaultTheme	Specify which theme should be used on the first visit	light	dark
attach	Specify if the default toggle should be attached (can be used instead of data-drkmd-attach)	false	true
label	Specify a custom label for the theme toggle	🌓	💡
buttonLight	Background color of the theme toggle for the light mode	#fff	#222
buttonDark	Background color of the theme toggle for the dark mode	#000	#222
top	Space in px from the toggle to the top of the page (if set toggle will be placed at the top)	unset	20px
bottom	Space in px from the toggle to the bottom of the page (if set toggle will be placed at the bottom)	20px	unset
right	Space in px from the toggle to the right edge of the page (if set toggle will be placed on the left side)	unset	20px
left	Space in px from the toggle to the left edge of the page (if set toggle will be placed on the right side)	20px	unset

You can specify any number of them as the value for the data-drkmd-opts attribute (make sure the value is valid JSON):

<script src="https://cdn.jsdelivr.net/npm/drkmd-js/dist/drkmd-js.min.js" data-drkmd-opts='{ "defaultTheme": "dark", "cookie": true }'></script>

This works on any element, not just the script tag, so you can even use it when you are loading drkmd.js via NPM.

or you can pass them as a JS object to new Darkmode():

const options = {
  cookie: true,
  defaultTheme: 'dark',
}

const darkmode = new Darkmode(options)

📖 Examples

Basic

View example file

Render the darkmode toggle with all the default options.

Import drkmd.js like this:

HTML

<script src="https://cdn.jsdelivr.net/npm/drkmd-js/dist/drkmd-js.min.js" data-drkmd-attach></script>

or

JavaScript

import Darkmode from 'drkmd-js'
new Darkmode().attach()

Then specify the styles for the light and dark theme:

CSS

/* Styles for light theme */
.theme-light {
    background: #fff;
}

/* Styles for dark theme */
.theme-dark {
    background: #000;
}

---

CSS variables

View example file

If you want to specify different colors for each theme, you can use css-variables:

CSS

/* Light Colors */
.theme-light {
    --background: #fff;
    --color: #000;
}

/* Dark Colors */
.theme-dark {
    --background: #000;
    --color: #fff;
}

html,
body {
    background: var(--background);
    color: var(--color);
}

---

With options

View example file

Render the darkmode toggle with custom options:

HTML

<script src="https://cdn.jsdelivr.net/npm/drkmd-js/dist/drkmd-js.min.js" data-drkmd-opts='{ "right": "unset", "left": "32px", "defaultTheme": "dark" }'></script>

or

JavaScript

import Darkmode from 'drkmd-js'

const options = {
  right: 'unset',
  left: '32px',
  defaultTheme: 'dark',
}

new Darkmode(options).attach()

---

Custom darkmode toggle

View example file

Don't render the darkmode toggle, instead change the theme when a custom HTML element is clicked.

Import drkmd.js like this:

HTML

<script src="https://cdn.jsdelivr.net/npm/drkmd-js/dist/drkmd-js.min.js"></script>

Note: data-drkmd-attach is missing because we don't want to attach the default toggle to the page

or

JavaScript

import Darkmode from 'drkmd-js'

Then on your custom element add the attribute data-drkmd-toggle:

<span data-drkmd-toggle>Change theme</span>

When you click that element, the theme will be toggled automatically.

There's also data-drkmd-to-light and data-drkmd-to-dark which will change the theme to either dark or light specifically.

---

Different images depending on the theme

View example file

You can use the theme-change event to modify an element with JavaScript. Here we are changing the src attribute of an img tag when the theme changes:

HTML

<img id="image" src="/path/to/dark.png">

JavaScript

new Darkmode().attach() // or use the data-drkmd-attach attribute

const imageSrc = {
   dark: "/path/to/dark.png",
   light: "/path/to/light.png"
}

window.addEventListener('theme-change', e => {
    const theme = e.detail.to // will return 'light' or 'dark'
    document.getElementById('image').src = imageSrc[theme]
})

---

Programmatic usage

View example file

You can also control the theme programmatically.

Import drkmd.js like this:

HTML

<script src="https://cdn.jsdelivr.net/npm/drkmd-js/dist/drkmd-js.min.js"></script>

Note: data-drkmd-attach is missing because we don't want to attach the default toggle to the page

or

JavaScript

import Darkmode from 'drkmd-js'

Add HTML elements:

<button id="myBtn">Click me</button>
<span id="theme">Current theme:</span>

Then create a new Darkmode instance and use any of the available methods:

const darkmode = new Darkmode()

const updateValue = () => {
    document.getElementById('theme').innerText = `Current theme: ${ darkmode.currentTheme() }`
}

document.getElementById('myBtn').addEventListener('click', () => {
    darkmode.toggle()

    updateValue()
})

updateValue()

🌍 Browser compatibility

drkmd.js uses prefers-color-scheme: dark to automatically enable the Dark Mode if the OS prefered theme is dark.

Check the current compatibility here:

• Can I use prefers-color-scheme (to activate Dark Mode automatically)
• Can I use css-variables (to change specific colors depending on the theme)

💻 Development

Issues and PRs are very welcome!

The actual source code of this library is in the drkmd.js file in the src folder.

• run yarn lint or npm run lint to run eslint.
• run yarn dev or npm run dev during development.
• run yarn build or npm run build to produce a production version of drkmd.js in the dist folder.

❔ About

This project was developed by me (@betahuhn) in my free time. If you want to support me:

📄 License

Copyright 2021 Maximilian Schiller

This project is licensed under the MIT License - see the LICENSE file for details

Changelog

[v1.0.1] - 2021-04-19

Release notes · Compare · Tag · Archive (zip · tar.gz)

Dependency updates

• d7a1f7d Bump @betahuhn/config from 1.0.2 to 1.1.0