use-luminance v0.1.3

use-luminance

introduction

use-luminance is a simple, fast, and efficient luminance calculation hook.

it use the useDeferredValue hook to calculate the luminance of a color.

it can also provide a useTheme hook to calculate current theme based on the luminance of background-color.

Tips

this package is only support for React18.To use it,you must upgrade your react version to 18.

install

with npm

npm install --save use-luminance

with yarn

yarn add use-luminance

usage

import { useLuminance } from "use-luminance";

function App() {
  const luminance = useLuminance(color);
  return <div>{luminance}</div>;
}

import { useTheme } from "use-luminance";

function App() {
  const theme = useTheme(color);
  return <div>{theme}</div>;
}

API

• useLuminance(color: string):number
• useTheme(color: string):'light'|'dark'

color is a string, it can be a rbg string or a hex color.Be careful,color name is not supported.

demo

click me to view

licence

MIT