Download the PHP package codewithkyle/jitter without Composer
On this page you can find all versions of the php package codewithkyle/jitter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download codewithkyle/jitter
More information about codewithkyle/jitter
Files in codewithkyle/jitter
Package jitter
Short Description A just in time image transformation service.
License MIT
Informations about the package jitter
Just In Time Image Transformations
Jitter is a just in time image transformation plugin for Craft CMS. The API is based on Imgix. This plugin 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 paid services/plugins offer. If you need something a bit more advanced besides basic image transformations I suggest you pay for Imgix or select a different Craft Plugin.
Requirements
This plugin requires ImageMagick and the following versions of PHP and Craft CMS:
- Craft CMS 5 with PHP 8 (Jitter v2.0, active)
- Craft CMS 4 with PHP 8 (Jitter v2.0, maintenance)
- Craft CMS 3 with PHP 7.2+ (Jitter v1.x, unsupported)
Installation
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
cd /path/to/project
-
Then tell Composer to load the plugin:
composer require codewithkyle/jitter
- In the Control Panel, go to Settings → Plugins and click the “Install” button for Jitter.
Configuring Jitter
Jitter can be configured to use S3-compatible object storage solutions by adding a jitter.php
file to your projects config/
directory. Transformed images will be stored in the storage solution but will still be served from your web server. If you would like to serve images from a CDN read the section below.
Note: the
endpoint
andacl
config values are optional. You will only need to useendpoint
when using an S3-compatible alternative S3 cloud object storage solution (like Digital Ocean Spaces).
Using a Content Delivery Network (CDN)
Jitter can be configured to use CDN URLs. The cdn
config value should be the CDN's origin URL. Jitter's url()
and srcset()
functions will automatically switch from using the /jitter/
URL to the CDN URL over time as the image transformations are performed.
Note: if you use Craft's template caching or a 3rd party HTML caching service (like Cloudflare's Edge Cache)
/jitter/
image URLs may be cached when a CDN URL is available. We do not recommend disabling your caching systems, however, you may want to consider using a lower TTL to ensure the CDN URLs propagate sooner rather than later.
Using Jitter
Image transformations via the API:
Image transformations via Twig:
Image transformations via PHP:
Transformation parameters
Parameter | Default | Description | Valid options |
---|---|---|---|
id |
null |
the image asset id | int |
path |
null |
the image file path | string |
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 , png , gif , auto |
m |
clip |
how the image should be resized | crop , clip , fit , letterbox , croponly |
q |
80 |
desired image quality | 0 to 100 |
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.
All versions of jitter with dependencies
craftcms/cms Version ^4.0|^5.0
aws/aws-sdk-php Version ^3.0.0
codewithkyle/jitter-core Version ^2.0.0