README

Image Colors for Craft CMS

Extract beautiful color palettes from your images.
Know exactly how dominant each color is.
Build dynamic, image-aware designs.

This plugin extracts weighted color palettes from uploaded images and makes them available in templates, GraphQL, and the admin UI. Each palette is weighted by pixel proportion, so you know how dominant each color is within the sampled region.

Features

• 6 extraction regions — overall, focal point, top, right, bottom, left
• Weighted colors — up to 4 colors per region, sorted by pixel dominance
• Focal point aware — the focal region follows the asset's focal point
• Automatic extraction — on upload, replace, and focal point change
• Drop-in field type — proportional color bars with click-to-copy hex values
• Twig API — access palettes, hex values, RGB, weights, and Craft's ColorData utilities
• GraphQL support — query all regions, colors, weights, and focal points
• Asset index swatches — color palettes in table and card views
• Console command — bulk extract with optional volume filtering
• Free to use

Requirements

• Craft CMS 5.6+
• PHP 8.2+
• GD extension

Installation

composer require newism/craft-image-colors
php craft plugin/install image-colors

Documentation

Full documentation is available at https://plugins.newism.com.au/image-colors.

Support

For support, please open an issue on GitHub.