color-supreme
TypeScript icon, indicating that this package has built-in type declarations

0.1.4 • Public • Published

color-supreme

A powerful library for extracting dominant colors from images. It uses the k-means clustering algorithm to analyze the colors in an image and identify the most dominant ones, making it ideal for a range of applications such as image processing, data visualization, and search algorithms.

Installation

Yarn

yarn add color-supreme  

NPM

npm install color-supreme --save  

Use

Browser

import { getDominantColors, rgbToHex } from "color-supreme";
import { getImageFromUrl } from "pixel-paradise";

export const getColors = async (url: string, colors = 5) => {
  const pixels = await getImageFromUrl(url);
  return getDominantColors(pixels, colors).map(rgbToHex);
};

// getColors('your image url').then(console.log)
  

Node

import sharp from 'sharp'
import { getDominantColors, rgbToHex } from 'color-supreme'

export const getColors = async (imagePath: string, colors = 5) => {
  const { data, info } = await sharp(imagePath)
    .raw()
    .toBuffer({ resolveWithObject: true })

  const ImageData = {
    buffer: data,
    width: info.width,
    height: info.height,
  }

  return getDominantColors(ImageData, colors).map(rgbToHex)
}

// getColors("your image path").then(console.log);
  

Notice

This library is open source software released under the MIT license. See the LICENSE file for more information. This code is provided as-is, without any warranty or guarantee of any kind. Use at your own risk. I cannot be held responsible for any issues or damages that may arise from the use of this code. However, I have done my best to ensure that it is well-written and thoroughly tested, and I am always open to feedback and suggestions for improvement. Thank you for your understanding. I hope you enjoy using it and find it useful in your projects. If you have any questions or feedback, please don't hesitate to reach out.

Readme

Keywords

Package Sidebar

Install

npm i color-supreme

Weekly Downloads

13

Version

0.1.4

License

MIT

Unpacked Size

487 kB

Total Files

235

Last publish

Collaborators

  • skulptur