xu-chris/contrastcolor

Calculates contrast color for given HEX color

v0.0.7 2025-07-07 20:50 UTC

Requires

• php: >=8.1.0
• getkirby/cms: ^4.0 || ^5.0
• getkirby/composer-installer: ^1.1

MIT

• Christian Xu

README

Adds toContrastColor() to calculate wether using a white or a black color for a given image color in Kirby.

1 Installation

Download and copy this repository to site/plugins/contrastcolor or use compose:

compose require xu-chris/contrastcolor

2 Blueprint for image files

For images, you can create a blueprint that adds a color field:

title: Image
accept:
  mime: image/jpeg, image/png
fields:
  color:
    label: Dominant color
    type: color
    format: hex

3 Use this plugin

Given an image with a color, you can use it like this:

$image->color()->toContrastColor()

Currently, it's limited for HEX color values automatically calculated