https://github.com/parsilver/color-palette-php
A PHP library for extracting, analyzing, and managing color palettes from images
https://github.com/parsilver/color-palette-php
Last synced: 6 months ago
JSON representation
A PHP library for extracting, analyzing, and managing color palettes from images
- Host: GitHub
- URL: https://github.com/parsilver/color-palette-php
- Owner: parsilver
- License: mit
- Created: 2024-11-09T03:39:17.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-12-10T15:49:56.000Z (7 months ago)
- Last Synced: 2024-12-10T17:23:06.096Z (7 months ago)
- Language: PHP
- Homepage:
- Size: 752 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Color Palette PHP
[](https://packagist.org/packages/farzai/color-palette)
[](https://github.com/parsilver/color-palette-php/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/farzai/color-palette)
A powerful PHP library for extracting color palettes from images and generating color themes. This package supports multiple image processing backends (GD and Imagick) and provides a rich set of color manipulation features.
## Documentation
📚 **[View Full Documentation](https://parsilver.github.io/color-palette-php/)**
## Features
- 🎨 Extract dominant colors from images using advanced color quantization
- 🖼️ Support for multiple image formats (JPEG, PNG, GIF, etc.)
- 🔄 Multiple image processing backends (GD and Imagick)
- 🎯 Generate color themes with surface, background, and accent colors
- 🌈 Color manipulation with RGB, HSL, and Hex support
- 📏 Color contrast ratio calculations
- 🎭 Automatic text color suggestions for optimal readability
- 🔍 Smart surface color recommendations based on color brightness
## Requirements
- PHP 8.1 or higher
- GD extension or ImageMagick extension
- Composer
## Installation
You can install the package via composer:
```bash
composer require farzai/color-palette
```
## Basic Usage
```php
use Farzai\ColorPalette\ImageFactory;
use Farzai\ColorPalette\ColorExtractorFactory;
use Farzai\ColorPalette\ColorPalette;
// Create an image instance
$imageFactory = new ImageFactory();
$image = $imageFactory->createFromPath('path/to/image.jpg');
// Create a color extractor
$extractorFactory = new ColorExtractorFactory();
$extractor = $extractorFactory->create('gd'); // or 'imagick'
// Extract colors to create a palette
$colors = $extractor->extract($image);
$palette = new ColorPalette($colors);
// Get all colors
$colors = $palette->getColors();
// Get suggested text color for a background
$backgroundColor = $colors[0];
$textColor = $palette->getSuggestedTextColor($backgroundColor);
// Get suggested surface colors
$surfaceColors = $palette->getSuggestedSurfaceColors();
// Available keys: 'surface', 'background', 'accent', 'surface_variant'
```
## Documentation
For detailed documentation, please visit our [Documentation Site](https://parsilver.github.io/color-palette-php/).
## Testing
```bash
composer test
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](https://github.com/parsilver/color-palette-php/security/policy) on how to report security vulnerabilities.
## Credits
- [All Contributors](https://github.com/parsilver/color-palette-php/contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.