Namide
For a lot of usages of `extract-colors`, users require one or more specific colors from the image. For example, `extract-colors` is sometimes used to add a background of a web page (the background need to be an extracted color of an image). The current version of `extract-colors` (`v4.1.1`) return a list of colors with a count of colors that cannot be anticipated. To add feature that automatically extracts the necessary color(s), and to include the maximum number of use cases, it's important to be agnostic. Which colors define an image (in photography, paint, draw...)? Here a list of color classification: - **accents** (dark + light) = (contrasting colors) [opposite of dominants] - **accentsLight** = (contrasting light colors) - **accentsDark** = (contrasting dark colors) - **dominants** (dark + light) = (largest proportional area colors) [opposite of accents] - **dominantsLight** = (largest proportional area light colors) - **dominantsDark** = (largest proportional area dark colors) - **vivids** (dark + light) = (most saturated color colors) [opposite of dullests] - **vividsLight** = (most saturated color light colors) - **vividsDark** = (most saturated color dark colors) - **dullests** (dark + light) = (least saturated color colors) [opposite of vivids] - **dullestsLight** = (least saturated color light colors) - **dullestsDark** = (least saturated color dark colors) - **lightests** = (most lightest color colors) [opposite of darkests] - **darkests** = (most darkest color colors) [opposite of lightests] - **coolest** (dark + light) = (most cool colors) [opposite of warmest] - **coolestLight** = (most cool light colors) - **coolestDark** = (most cool dark colors) - **warmest** (dark + light) = (most warm colors) [opposite of coolest] - **warmestLight** = (most warm light colors) - **warmestDark** = (most warm dark colors) Here the options proposal: ```js { // List of colors type returned example: colorClassifications: ['accents', 'accentsLight', 'dominants', 'dominantsDark', 'vivid', 'dullest'], // Default value if color not found // If defaultColors is false the returned values can be empty // Example: defaultColors: false, // Default value if color not found // If defaultColors is true the returned values will be calculated by extract-colors // Example: defaultColors: true, // If defaultColors is and object, all values can be set by colorClassification. // Example: defaultColors: { accents: 0xFF0077, vivid: false, dominants: (classifiedColorsPart) => [0xFF5577, 0x775577], dullest: true } } ``` Here an example of use: ```js import { extractColors, extract, refine, classify, addDefaults } from "extract-colors" const imageSrc = "path-to/image.jpg" // Full use extractColors(imageSrc, { pixels: 64000, distance: 0.22, colorValidator: (red, green, blue, alpha = 255) => alpha > 250, saturationDistance: 0.2, lightnessDistance: 0.2, hueDistance: 0.083333333, colorClassifications: ['coolest', 'warmest'], defaultColors: { warmest: 0xFF0000, coolest: 0x0000FF, } }) .then(classifiedColors => console.log(classifiedColors)) // Same calculation with all functions splitted extract(imageSrc, { pixels: 64000, distance: 0.22, colorValidator: (red, green, blue, alpha = 255) => alpha > 250, }) .then(colors => refine(colors, { saturationDistance: 0.2, lightnessDistance: 0.2, hueDistance: 0.083333333 })) .then(refinedColors => classify(refinedColors, { colorClassifications: ['accents', 'dominants'] })) .then(classifiedColors => addDefaults(classifiedColors, { defaultColors: { accents: false, dominants: 0xCCCCCC, } })) .then(classifiedColors => console.log(classifiedColors)) ``` Feel free to comment, this feature is under development and we welcome your feedback. --- Work in progress in the [feature/classify](https://github.com/Namide/extract-colors/tree/feature/classify) branch. [Linked issue](https://github.com/Namide/extract-colors/issues/56)