Download the PHP package breadthe/php-contrast without Composer
On this page you can find all versions of the php package breadthe/php-contrast. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download breadthe/php-contrast
More information about breadthe/php-contrast
Files in breadthe/php-contrast
Package php-contrast
Short Description Color and contrast tools
License MIT
Homepage https://github.com/breadthe/php-contrast
Informations about the package php-contrast
PHP Contrast Tools
Provides various utilities for working with color contrast.
The primary purpose is to facilitate easy generation of accessible (minimum 3.0 contrast ratio) hex color pairs. A variation of these tools restricts the generated colors to TailwindCSS's default palette.
I've created a demo page to show how color pairs can be generated by this package.
Installation
You can install the package via composer:
Usage
Import the class.
Check the contrast ratio between 2 colors
Get a random color pair (with the resulting ratio), with minimum 3:1 contrast ratio
Get a random color pair (with the resulting ratio), with minimum specified contrast ratio (but no less than 3:1)
⚠️ Warning For performance reasons, the minimum requested contrast ratio is capped at 4.5, although the generated pairs can go up to the theoretical maximum 21:1 ratio.
⚠️ Caution When chaining with minContrast()
, make sure to use getRandom()
instead of random()
.
Get a random accessible sibling for the given color, with minimum specified contrast ratio (but no less than 3:1)
Generate a random TailwindCSS color
Generate a pair of random accessible TailwindCSS colors
Generate a pair of random accessible TailwindCSS colors, with minimum specified contrast ratio (but no less than 3:1)
⚠️ Warning For performance reasons, the minimum requested contrast ratio is capped at 4.5, although the generated pairs can go up to the theoretical maximum 21:1 ratio.
⚠️ Caution When chaining with minContrast()
, make sure to use getRandomPair()
instead of randomPair()
.
Merge the default Tailwind colors with a custom palette
You may extend the default Tailwind colors with your own custom palette. Here's an example of how to import a custom palette from a JSON file.
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Omigosh Dev
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
PHP Package Boilerplate
This package was generated using the PHP Package Boilerplate.