react-dark-mode-toggle

0.2.0 • Public • Published

react-dark-mode-toggle

A super cutesy dark mode toggle button for React. Inspired by overreacted.io.

code style: prettier

🚀 Getting Started

Using npm:

npm i react-dark-mode-toggle

Using yarn:

yarn add react-dark-mode-toggle

Usage

import React, {useState} from "react";
import DarkModeToggle from "react-dark-mode-toggle";

export default () => {
  const [isDarkMode, setIsDarkMode] = useState(() => false);
  return (
    <DarkModeToggle
      onChange={setIsDarkMode}
      checked={isDarkMode}
      size={80}
    />
  );
};

📌 Props

Prop Type Default Required
onChange func value => null No
checked boolean false No
size number (defaults to px) or string (px, em, rem, %, etc.) 85 No
speed number 1.3 No
className string null No

Note, this is not a dark mode theme implementation; it's just a button! You'll need to mix this with a management solution such as use-dark-mode.

✌️ License

MIT

Buy @cawfree a coffee

Package Sidebar

Install

npm i react-dark-mode-toggle

Weekly Downloads

777

Version

0.2.0

License

MIT

Unpacked Size

27.6 kB

Total Files

10

Last publish

Collaborators

  • cawfree