/ Color

A hook to grab a color palette from images with react

A hook to grab a color palette from images with react

useImageColor

A hook to grab a color palette from images. Render a skeleton color while your original image still loading.

How does it work?

It renders your image on a canvas and then generates its palette of colors using color quantization.

Includes Image Component

This image component renders a placeholder color while your original images are loading.

Before loading big images (color from smaller images)
68747470733a2f2f692e706f7374696d672e63632f514e32375a685a312f622e706e67

After loading big images:
68747470733a2f2f692e706f7374696d672e63632f426e675046464c422f632e706e67

demo

68747470733a2f2f692e696d6775722e636f6d2f655331414432362e706e67

How does this image component work?

You must provide src (your original image) and a thumbnail (smaller image).
As soon as the thumbnail is loaded the skeleton becomes visible using its dominant color. In the meantime, your original image continues loading, finally, when your original image arrives, it replaces the skeleton.

Installation:

npm install use-image-color

The hook:

Usage:

import useImageColor from 'use-image-color'

export function Card() {
  const { colors } = useImageColor(url, { cors: true, colors: 5 })
  return (...);
}

Hook params:

useImageColor(url: String, options: OptionsObject)
param description default
cors Use CORS. Enable this if you are using external images false
colors Number of colors to grab 5
format Output format: rgb or hex hex
windowSize Size of window to grab pixels, low values are faster 50

The component:

Usage:

import { Image } from 'use-image-color'

export function Card() {
  return (
    <Image src={url} thumbnail={thumbnail} />
  );
}

Component params:

param description required
thumbnail Small version of your image true
src Original version of your image true
wrapperStyle Style object to apply to the wrapper of the image and the color false
wrapperClass Class to apply to the wrapper of the image and the color false

GitHub

Comments