Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

colorgram

darosh3.2kMIT0.2.0TypeScript support: included

Color extraction library. In TypeScript/JavaScript. For browser/server.

browser, color, image, quantization, server, typescript

readme

Colorgram Build Status

Color extraction library. In TypeScript/JavaScript. For browser/server.

Demo

test/browser_test.html

Features

  • small size, 1kB (minified + gzipped)
  • pretty fast, 512×512 pixels in ~50ms, 340×340 pixels in ~15ms (~6× slower on mobile)
  • scans every pixel
  • identical output for rotated images
  • sampled by top 2 bits of 3 groups: H, L, and luminance
  • calculates average per group
  • fixed memory footprint, samples using 2 (bits) ^ 3 (groups) * 4 (RGB + count) * 4 (Uint32) = 65536 bytes
  • usually generates small (~16 colors) palette of main colors
  • supports RGB and RGBA input pixel array (compatible with ImageData.data)
  • using TypedArray
  • no native dependencies

Similar stuff

Install

npm install colorgram

Usage

See test folder.

TypeScript documentation

http://darosh.github.io/colorgram-js/doc/

License

MIT

changelog

Changelog

0.2.0 9/3/2019

  • Fixes #1 and #2
  • Build toolchain updated

0.1.5 7/9/2015

  • Initial release