Skip to content

mcnaveen/is-darkmode

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌒 Is Darkmode?

Downloads this Week Bundle Size Version

is-darkmode

🦄 A Simple utility to find whether darkmode is enabled.

📦 Requirements

Node.js 16.x LTS

✨ Installation

Install the NPM Package with the below command:

npm install is-darkmode --save

(or)

Install with Yarn:

yarn add is-darkmode

🖊️ Usage

Import the module in your project:

// Commonjs Import
var { isDarkmode } = require("is-darkmode");

// or ES6 import
import { isDarkmode } from "is-darkmode";

💡 Example

Inside your React app, Pass the function into a Variable.

With that you can conditionally render the content based on the result of the function.

import { isDarkmode } from "is-darkmode";

export default function App() {
  const checkDarkmode = isDarkmode();

  return (
    <div className="App">
      <h1>Hello App</h1>
      <p>{checkDarkmode ? "Darkmode is Enabled" : "Darkmode is Disabled"}</p>
    </div>
  );
}

☑️ Example Output

Example Output


💚 Message

I hope you find this useful. If you have any questions, please create an issue.