Irodori Chroma

Image color analysis utilities for Node.js: dominant color extraction, luminance calculation, color code conversion, and more.

Installation

npm install irodori-chroma

Note: Canvas native dependencies are required. For Ubuntu:

sudo apt-get install -y build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev

Usage

import { getDominantColor } from 'irodori-chroma';
import { colorCodeToLuminance, rgbToLuminance } from 'irodori-chroma';

// Extract dominant color
const { color, hex } = await getDominantColor('path/to/image.png');
console.log(hex); // e.g., #ff0000

// Exclude specific colors
const res = await getDominantColor('path/to/image.png', { 
  excludeColors: ['#ffffff'] 
});

// Calculate luminance
const lum1 = rgbToLuminance(255, 255, 255); // 255
const lum2 = colorCodeToLuminance('#0c2238');

API

High-level

• getDominantColor(imagePath, options?) - Extract dominant color from image
• rgbToLuminance(r, g, b) - Calculate luminance from RGB (0-255)
• colorCodeToLuminance('#RRGGBB') - Calculate luminance from hex code
• rgbToColorCode([r,g,b]) / colorCodeToRgb('#RRGGBB') - Convert between formats

License

MIT