Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/emrocode/darkify-js

:new_moon_with_face: Easy dark mode for your site
https://github.com/emrocode/darkify-js

color-scheme dark-mode dark-theme data-theme easy-to-use frontend modo-oscuro toggle web

Last synced: 7 days ago
JSON representation

:new_moon_with_face: Easy dark mode for your site

Awesome Lists containing this project

README

        

# Darkify JS

🌚 A simple dark mode toggle library that makes it easy to implement dark mode on your website without additional configuration

> Please make sure to read the [Wiki] for detailed documentation and examples

### 📦 Installation

Use npm or any other package manager:

```bash
npm install darkify-js
```

### ⚙️ Setup

```js
// main.js
import Darkify from 'darkify-js';

const options = {
autoMatchTheme: true,
};

// autoMatchTheme: default is true
// useLocalStorage: default is true
// useSessionStorage: default is false
// useColorScheme: default is ['#ffffff', '#000000']

new Darkify('#element', options);
```

[Wiki]: https://github.com/emrocode/darkify-js/wiki