npm.io
1.0.1 • Published 5 years ago

dark-mode-toggle-animation

Licence
MIT
Version
1.0.1
Deps
0
Size
278 kB
Vulns
0
Weekly
0

@noelsner/dark-mode-toggle-animation

Sun-moon animation for toggling dark mode

Install

npm install dark-mode-toggle-animation

Example Usage

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

const YourComponent = () => {

  const [darkMode, setDarkMode] = useState(true);

  const onClick = () => setDarkMode((prev) => !prev);

  return (
    <div
      style={{
        backgroundColor: `${darkMode ? "#282c34" : "#f0f0f0"}`,
        transition: "background-color 1s ease",
      }}
    >
      <DarkModeToggle
        mode={darkMode ? "sun" : "moon"}
        onClick={onClick}
        width="100px"
        moonColor="#000000"
        sunColor="#ffffff"
        animationDuration={1}
      />
    </>
  );
};

Props

Props Description Required
mode "sun" or "moon" (string) Required
onClick toggle function (function) Required
width css width property (string) Optional (default 100px)
moonColor css color (string) Optional (default black)
sunColor css color (string) Optional (default white)
animationDuration animation length (integer) Optional (default 1 second)