wedevelopnl/silverstripe-webp-images

There is no license information available for the latest version (2.0.1) of this package.

webp images module

2.0.1 2023-10-03 08:53 UTC

Requires

• php: ^8.1
• silverstripe/cms: ^5

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.4

Unknown License

• WeDevelop

• images
• silverstripe
• Webp

README

This SilverStripe module generates webp images from resized jpeg and png images.

Requirements

• See composer.json requirements
• GD with webp support

Installation

• composer require wedevelopnl/silverstripe-webp-images

Next, you'll need to run a dev/build (or at least flush) to allow access to files with the .webp extension from the .htaccess in your assets directory.

Known issues

Using $Image.DisableWebP in a template

Putting $Image.DisableWebP in a template will not work, this somehow calls getUrl twice, properly disabling the webp URL generation on the first run, but actually outputting the second run after which the disabled flag will have been removed. A workaround for this is to use <img $Image.DisableWebP.AttributesHTML />

License

See License

Maintainers

• WeDevelop [e-mail]

Configuration

SilverStripe\Core\Injector\Injector:
  WeDevelop\WebpImages\WebpGenerator:
    properties:
      enabled: true
      quality: 80

To disable generating webp images in code

WebpGenerator::singleton()->setEnabled(false)

Development and contribution

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. See read our contributing document for more information.

Getting started

We advise to use Docker/Docker compose for development.
We also included a Makefile to simplify some commands

Our development container contains some built-in tools like PHPCSFixer.

Getting development container up

make build to build the Docker container and then run detached.
If you want to only get the container up, you can simply type make up.

You can SSH into the container using make sh.

All make commands

You can run make help to get a list with all available make commands.