Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pelock/yii2-imgopt
Image widget with an auto WebP file generation for Yii2 Framework. Generate HTML <picture> tag with WebP and fallback PNG or JPG images.
https://github.com/pelock/yii2-imgopt
composer generator html image img imgopt jpg optimization packagist php picture png webp yii2 yii2-framework yii2-widget yii2-widgets
Last synced: about 20 hours ago
JSON representation
Image widget with an auto WebP file generation for Yii2 Framework. Generate HTML <picture> tag with WebP and fallback PNG or JPG images.
- Host: GitHub
- URL: https://github.com/pelock/yii2-imgopt
- Owner: PELock
- Created: 2021-03-17T20:13:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-09T09:54:11.000Z (over 1 year ago)
- Last Synced: 2024-09-23T22:03:16.265Z (1 day ago)
- Topics: composer, generator, html, image, img, imgopt, jpg, optimization, packagist, php, picture, png, webp, yii2, yii2-framework, yii2-widget, yii2-widgets
- Language: PHP
- Homepage: https://www.pelock.com
- Size: 133 KB
- Stars: 6
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Image widget with an auto WebP file generation for Yii2 Framework
**ImgOpt** is an image optimization widget for [Yii2 Framework](https://www.yiiframework.com) with auto [WebP](https://developers.google.com/speed/webp) & [AVIF](https://caniuse.com/avif) image formats generation from `PNG` and `JPG` files.
https://www.yiiframework.com/extension/pelock/yii2-imgopt
## How to make my website faster?
[My website](https://www.pelock.com) had all the beautiful images and screenshots, but there was one problem. Most of them were in `PNG` format, some of them weighted around 200 kB. And it adds up to the point where my website loading time was just slow.
I found about the WebP format, read that it's supported in the latest browsers and if it's not (only older Safari browsers), there's a way to overcome this and serve the default `PNG` or `JPG` images. Perfect.
_But_ the entire process would require me to go manually and use some sort of image conversion tool, upload new WebP images to the server and upgrade my `HTML` code.
To hell with that! We can do better!
## Automate PNG & JPG to WebP & AVIF conversion
I have decided to create a Yii2 widget that would automate this task.
What it does? Instead of static images like this:
```html
```
it will automatically generate an extra image in new [WebP](https://developers.google.com/speed/webp) format (in the same directory, where the provided image is located) and serve it to your browser in HTML `` tag, with a default fallback to the original image for browsers that don't support WebP images.
Replace your `IMG` tag within your `HTML` templates with a call to:
```php
= \PELock\ImgOpt\ImgOpt::widget(["src" => "/images/product/extra.png", "alt" => "Extra product" ]) ?>
```
(Image path is relative to [Yii2 Framework @webroot alias](https://www.yiiframework.com/wiki/667/yii-2-list-of-path-aliases-available-with-default-basic-and-advanced-app))
And once run, the widget code will generate a new WebP & AVIF image files on the fly (original image is left **untouched**) and he following HTML code gets generated:
```html
```
The browser will pick up the best source for the provided image, and thanks to revolutionary WebP and AVIF compression, it will make your website loading faster.
## Image lazy-loading
[Lazy images loading](https://web.dev/browser-level-image-lazy-loading/) makes the browser load the images when it reach a certain point, after which the image became visible in the current browser tab. You can use this pure HTML feature (no JS involved) from within the widget:
```php
= \PELock\ImgOpt\ImgOpt::widget(["src" => "/images/product/extra.png", "loading" => "lazy" ]) ?>
```
The generated output looks like this:
```html
```
Use it to make your website loading times even faster.
## AVIF image generation (new in v1.3.0)
ImgOpt will automatically generate AVIF file if it's supported by the existing PHP installation. If the conversion function is not available, it will just skip this step.
## Automatic WebP generation for updated images (new in v1.2.0)
ImgOpt will set the modification date of the generated WebP image to match the modification date of the original image file.
If ImgOpt detects that a file modification date of the source image file is different than the date of the previously generated WebP image file - it will automatically re-create the new WebP image file!
## Installation
The preferred way to install the library is through the [composer](https://getcomposer.org/).
Run:
```
php composer.phar require --prefer-dist pelock/yii2-imgopt "*"
```
Or add:
```
"pelock/yii2-imgopt": "*"
```
to the`require` section within your `composer.json` config file.
The installation package is available at https://packagist.org/packages/pelock/yii2-imgopt
The Yii2 extension is available at https://www.yiiframework.com/extension/pelock/yii2-imgopt
Source code is available at https://github.com/PELock/yii2-imgopt
## Image quality
I knew you would ask about it! By default the conversion tries all the steps from 100% output image quality down to 70% to generate the WebP file that is smaller than the original image.
| Original PNG (181 kB) | Optimized WebP (60 kB) |
| --------------------- | -------------- |
| [](https://www.pelock.com/products/social-media-bot) | [](https://www.pelock.com/products/social-media-bot/install) |
If the generated WebP or AVIF image is larger than the original image, the default `![]()
` tag will be generated.
## Disable WebP/AVIF images serving
If for some reason you want to disable WebP file serving via the HTML `` tag, you can do it per widget settings:
```php
= \PELock\ImgOpt\ImgOpt::widget(["src" => "/images/product/extra.png", "alt" => "Extra product", "disable" => true ]) ?>
```
## Recreate WebP/AVIF files
The widget code automatically detects if there's a WebP/AVIF images in the directory with the original image. If it's not there - it will recreate them. It's only done once.
If you wish to force the widget code to recreate it anyway, pass the special param to the widget code:
```php
= \PELock\ImgOpt\ImgOpt::widget(["src" => "/images/product/extra.png", "alt" => "Extra product", "recreate" => true ]) ?>
```
You might want to recreate all of the WebP and AVIF files and to do that without modifying, change the widget source code from:
```php
/**
* @var bool set to TRUE to recreate *ALL* of the WebP and AVIF files again (optional)
*/
const RECREATE_ALL = false;
```
to:
```php
/**
* @var bool set to TRUE to recreate *ALL* of the WebP files again (optional)
*/
const RECREATE_ALL = true;
```
## Lightbox 2 integration
You can also generate Lightbox (https://lokeshdhakar.com/projects/lightbox2/) friendly images.
Instead of:
```html
```
You can replace it with more compact widget code:
```php
= \PELock\ImgOpt\ImgOpt::widget(["lightbox_data" => "image-1", "lightbox_src" => "/images/sunset.jpg", "src" => "/images/sunset-thumbnail.jpg", "alt" => "Sunset" ]) ?>
```
And it will generate this HTML code:
```html
```
## Bugs, questions, feature requests
If you are interested in my software or have any questions regarding it, technical or legal issues, or if something is not clear, [please contact me](https://www.pelock.com/contact). I'll be happy to answer all of your questions.
Bartosz Wójcik
* Visit my site at — https://www.pelock.com
* Twitter — https://twitter.com/PELock
* GitHub — https://github.com/PELock
