npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-darkmode-hook

v1.0.0

Published

react-darkmode-hook is a custom react state hook intended to make adding darkmode support and management to any react app easy.

Downloads

7

Readme

react-darkmode-hook

react-darkmode-hook is a react hook for function components that assists with light and dark mode support into your react application. The hook enables both the initial setting of the color-mode, as well as exposes state to manage a control elements display state for toggling dark mode on / off.

react-darkmode-hook works by applying a color-mode attribute to the document (<html>) element. The initial value of the color-mode attribute will be based on what is returned from prefers-color-scheme. If the browser doesn't support prefers-color-scheme, the initial value will default to light mode.

Installation


npm i react-darkmode-hook

Usage


Set initial mode based on system theme

App.js

import React, { useEffect } from "react"
import { useColorMode } from "react-darkmode-hook"

const App = () => {
  const { colorMode, setColorMode } = useColorMode()

  useEffect(() => {
    setColorMode()
  })

  // ...
}

Use the built-in DarkmodeToggle component to enable mode control

App.js


import { DarkmodeToggle } from "react-darkmode-hook"

const App = () => {
  return (
    <DarkmodeToggle />
  )
}

OR create your own using the hook

DarkmodeToggle.js

import React from "react"
import { useColorMode, LIGHT_MODE, DARK_MODE } from "react-darkmode-hook"

const DarkmodeToggle = () => {
  const { colorMode, setColorMode } = useColorMode()

  const clickHandler = (e) => {
    const currentMode = colorMode
    const newMode = currentMode === LIGHT_MODE ? DARK_MODE : LIGHT_MODE
    setColorMode(newMode)
  }

  return (
    <label htmlFor="mode-toggle">
      <input
        id="mode-toggle"
        type="checkbox"
        onClick={clickHandler}
        defaultChecked={colorMode === DARK_MODE}
      />
      {`Dark Mode ${colorMode === DARK_MODE ? "ON" : "OFF"}`}
    </label>
  )
}

export { DarkmodeToggle }

How to setup your css file

App.css

:root {
  --body-padding: 1rem;
  /* mode-agnostic custom properties" */
}

:root[color-mode="light"] {
  --system-background: #fff;
  /* ...custom properties with light-mode specific values */
}

:root[color-mode="dark"] {
  --system-background: #000;
  /* ...custom properties with dark-mode specific values*/
}