https://github.com/codewithkyle/jitter
An Imgix inspired image transformation library.
https://github.com/codewithkyle/jitter
Last synced: 2 months ago
JSON representation
An Imgix inspired image transformation library.
- Host: GitHub
- URL: https://github.com/codewithkyle/jitter
- Owner: codewithkyle
- License: mit
- Created: 2021-03-01T23:54:43.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T17:08:47.000Z (9 months ago)
- Last Synced: 2025-04-07T01:39:31.179Z (3 months ago)
- Language: PHP
- Homepage: https://packagist.org/packages/codewithkyle/jitter-core
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# Jitter
Jitter is an image transformation library with an API is based on [Imgix](https://docs.imgix.com/apis/url). This library was created to be a simple and free alternative to an Imgix style service. It **does not and will not** have all the bells and whistles that other services/libraries offer. If you need something more advanced besides basic image transformations I suggest you pay for [Imgix](https://www.imgix.com/pricing).
## Requirements
This library requires PHP 7.2 or later and [ImageMagick](https://imagemagick.org/index.php).
## Installation
```bash
# Install the library via composer
composer require codewithkyle/jitter-core
# Optional webp support (recommended)
sudo apt install webp
```
## Using Jitter
Transforming images:
```php
use codewithkyle\JitterCore\Jitter;
class ImageController
{
public function transformImage()
{
$imageFilePath = "./image.jpg"; // copy of source image (will be overwritten)
$params = ["w" => 320, "ar" => "1:1", "fm" => "jpg"]; // See transformation parameter table below for more options
$transformSettings = Jitter::BuildTransform($params); // Transform settings can be hashed with the base image's indentifier when caching
Jitter::TransformImage($imageFilePath, $transformSettings); // Manipulates and overwrites the image located at $imageFilePath
// Optional Next Steps:
// Save $imageFilePath a cloud provider (such as S3)
}
}
```
Transformation parameters:
| Parameter | Default | Description | Valid options |
| ------------- | -------------------------- | ------------------------------- | ---------------------------------------------- |
| `w` | base image width | desired image width | `int` |
| `h` | base image height | desired image height | `int` |
| `ar` | base image aspect ratio | desired aspect ratio | `int`:`int` |
| `fm` | `auto` | desired image format | `jpg`, `jpeg`, `png`, `gif`, `webp`, `auto` |
| `q` | `80` | desired image quality | `0` to `100` |
| `m` | `clip` | how the image should be resized | `crop`, `clip`, `fit`, `letterbox`, `croponly` |
| `bg` | `ffffff` | letterbox background color | `hex` |
| `fp-x` | `0.5` or asset focal point | horizontal focus point | `0` to `1` |
| `fp-y` | `0.5` or asset focal point | vertical focus point | `0` to `1` |
The `auto` format type will return a `webp` image when the server can generate the format and the client's browser supports the format.