repository·main·Indexed 25 days ago
https://github.com/vibrant-colors/node-vibrantA library for extracting prominent colors from images, providing an identical API across Node.js, browser, and Web Worker environments. It identifies significant colors for use in UI themes and color palettes, offering specialized packages like @vibrant/generator-default, @vibrant/image-browser, @vibrant/image, and @vibrant/quantizer. The library includes utilities for color space conversion (RGB, HSL, CIELab, Hex) and perceptual difference calculations using CIE delta E 1994.
@vibrant/image-browser package provides the necessary tools to process images within a browser environment. The primary interface for this package is the BrowserImage class, which handles image loading and color extraction in the browser.@vibrant/generator-default package provides a default implementation of a color generator within the node-vibrant ecosystem. It includes the DefaultGenerator function, a DefaultOpts variable for standard configuration, and the GeneratorOptions interface for defining custom generation parameters.@vibrant/color package provides the core primitives for color manipulation, representation, and comparison within the Vibrant ecosystem. It includes classes for color swatches, interfaces for palettes and filters, and a suite of utility functions for converting between different color spaces (RGB, HSL, XYZ, CIELab) and calculating color differences.node-vibrant ecosystem to identify and extract dominant colors.@vibrant/image-browser package provides a browser-compatible implementation of the ImageClass. It is designed to be used in web environments where you need to extract vibrant colors from images using the node-vibrant API. This package implements the necessary image handling logic specifically for the browser runtime.node-vibrant ecosystem. It is designed to assist in writing the algorithms that reduce an image's color palette to a specific set of representative colors.@vibrant/image package provides helper functions and TypeScript definitions designed to assist developers in implementing or working with an ImageClass. This is intended for use when building custom image processing logic within the node-vibrant ecosystem.@vibrant/image-node package provides Node.js-specific implementations for image processing within the Vibrant ecosystem. It is primarily used via the NodeImage class to handle image data in a Node.js environment.While node-vibrant provides consistent results within a single browser instance regardless of image display size, the underlying HTML5 canvas rendering is platform-dependent.
Key considerations:
quality == 1 (no downsampling).quality == 1 with no filters, color differences between major browsers (Chrome, Firefox, IE11) are generally not perceptible to the human eye.The Builder class is a helper used to configure settings and create a Vibrant instance. It supports method chaining to set various parameters such as quality, color count, and filters before executing the color extraction. You can initiate a builder using Vibrant.from(src) or by calling new Builder(src, opts).
Vibrant.from(src)
.quality(1)
.clearFilters()
// ...
.getPalette()
.then((palette) => {})The Resolvable<T> type alias is a utility type used throughout the library to indicate that a value can be either a direct instance of type T or a Promise that resolves to type T. This allows APIs to support both synchronous and asynchronous inputs or outputs seamlessly.
type Resolvable<T> = T | Promise<T>;