https://github.com/harmstyler/contrast-ratio-calculator
Accessibility library that calculates contrast ratios of colors as well as rates the contrast ratio against WCAG standards.
https://github.com/harmstyler/contrast-ratio-calculator
accessibility contrast-ratio
Last synced: 2 months ago
JSON representation
Accessibility library that calculates contrast ratios of colors as well as rates the contrast ratio against WCAG standards.
- Host: GitHub
- URL: https://github.com/harmstyler/contrast-ratio-calculator
- Owner: harmstyler
- License: lgpl-3.0
- Created: 2018-05-16T19:15:30.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-07T14:51:13.000Z (over 6 years ago)
- Last Synced: 2025-03-25T02:01:36.601Z (3 months ago)
- Topics: accessibility, contrast-ratio
- Language: PHP
- Size: 10.7 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Contrast Ratio Calculator
Accessibility library that calculates contrast ratios of colors as well as
rates the contrast ratio against WCAG standards.
## Getting started
1. PHP 7.1.x is required
1. Install the Contrast Ratio Calculator using Composer (recommended) or manually
### Composer Installation
1. [Get Composer](http://getcomposer.org/)
1. Install with `composer require harmstyler/contrast-ratio-calculator`
1. Add the following to your application's main PHP file: `require 'vendor/autoload.php'`;
## Usage
```php
setHex('#ffffff');
$secondaryColor = new Color();
$secondaryColor->setHex('#000000');
$contrastRatio = new ContrastRatio($primaryColor, $secondaryColor);
echo $contrastRatio->getRatio(); // floating decimal point of calculated ratio
$rating = new WCAGContrastRating();
echo $rating->rateContrastRatio($contrastRatio); // the WCAGContrast grade, either 'fail', 'aa-large', 'aa', or 'aaa'
```
## Run the tests
```
./vendor/bin/phpunit tests/
```