🍏🍊🍅 Fast Average Color

!Coveralls

Demo

A simple library that calculates average or dominant color of any images or videos in browser environment.

Features

- Bet on speed
- Some algorithms: simple, sqrt (default) and dominant
- Small bundle size, tree shaking
- Average color can be obtained from:
+ image
+ string (url of image or base64)
+ video
+ canvas or OffscreenCanvas
+ ImageBitmap
+ VideoFrame
+ array of numbers, Uint8Array or Uint8ClampedArray
- Average color can be obtained from specific part of resource
- Support for transparency (PNG, SVG and other formats)
- Support for web workers
- Support for Node.js

Table of contents

- Using
+ Install
+ CommonJS
+ ES Modules or TypeScript
+ Node.js
- Examples
+ Get average color from loaded image
+ Get average color from unloaded image
+ Get average color from image url
+ Get average color with ignored color
+ Get average color with multiple ignored colors
+ Get average color with ignored color and threshold
- Algorithms
- API
+ [.getColor(resource, [options])](./docs/api.md#getcolorresource-options)
+ [.getColorAsync(resource, [options])](./docs/api.md#getcolorasyncresource-options)
+ [.getColorFromArray4(arr, [options])](./docs/api.md#getcolorfromarray4arr-options)
+ .destroy()
- Different Builds
- Development

Unhandled Rejection (SecurityError): The operation is insecure.

> The crossOrigin attribute allows images that are loaded from external origins to be used in canvas like the one they were being loaded from the current origin. Using images without CORS approval taints the canvas. Once a canvas has been tainted, you can no longer pull data back out of the canvas. By loading the canvas from cross origin domain, you are tainting the canvas.

>You can prevent this by setting crossorigin="anonymous".

- Details
- Storing an image from a foreign origin

More examples

+ Background
+ Timeline
+ Box shadow
+ Box shadow, 4 sides
+ Border
+ Gallery: borders or vertical-horizontally
+ Gradient
+ Gradient as stripes
+ Canvas
+ Text photo
+ Ambilight
+ Define the average color for your images

See code

License

MIT License

Similar projects

- fast-average-color-node
- color-thief
- node-vibrant
- image-palette
- react-color-extractor

Friends

- Check device online