Extract colors from image assets in Craft CMS.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
CHANGELOG.md
LICENSE.md
README.md
composer.json
composer.lock
releases.json

README.md

Color Extractor

Extract colors from image assets in Craft 3. The Craft 2 plugin is moved to another branch.

Inner working

By using the imageColor field on each asset, it doesn't require extra database queries when showing colors. On install it creates a task to extract the color for every image.

Requirements

  • A field named imageColor on all assets of kind image (can be color or plaintext)
  • Craft 3 (we test on the latest release of Craft 3)
  • PHP 7.1 at least

Example usage

Use the colorExtractor twig filter to retrieve the image's color from templates.

<div style="background-color: {{ entry.images[0]|colorExtractor }};"></div>

From command:

craft color-extractor/default

License

See license

Credits

Based upon craft-image-color plugin by familiar-studio.