README

Image Optimization for TYPO3

The nr_image_optimize extension provides on-demand image optimization for TYPO3. Images are processed lazily via middleware when first requested, with support for modern formats (WebP, AVIF), responsive srcset generation, and automatic format negotiation.

Features

• Lazy image processing. Images are optimized only when a visitor first requests them.
• Modern format support. Automatic WebP and AVIF conversion with fallback to original formats.
• Responsive images. Built-in SourceSetViewHelper for srcset and sizes generation.
• Render modes. Choose between cover and fit resize strategies.
• Width-based srcset. Optional responsive srcset with configurable width variants and sizes attribute.
• Fetch priority. Native fetchpriority attribute support for Core Web Vitals optimization.
• Middleware-based processing. Lightweight frontend middleware intercepts /processed/ requests.
• Backend maintenance module. View statistics, check system requirements, and clear processed images.

Requirements

• PHP 8.2, 8.3, 8.4, or 8.5.
• TYPO3 13.4 or 14.
• Intervention Image library (installed via Composer automatically).

Recommended extensions

• imageoptimizer -- Optimize images with external binaries of your choice.

Installation

Via Composer (recommended)

composer require netresearch/nr-image-optimize

Manual installation

1. Download the extension from the TYPO3 Extension Repository.
2. Upload to typo3conf/ext/.
3. Activate the extension in the Extension Manager.

Configuration

The extension works out of the box with sensible defaults. Images are automatically optimized when accessed via the /processed/ path.

ViewHelper usage

{namespace nr=Netresearch\NrImageOptimize\ViewHelpers}

<nr:sourceSet file="{image}"
              width="1200"
              height="800"
              quality="85"
              sizes="(max-width: 768px) 100vw, 50vw"
/>

Supported parameters

file

Image file resource.

width

Target width in pixels.

height

Target height in pixels.

quality

JPEG/WebP quality (1--100).

sizes

Responsive sizes attribute.

format

Output format: auto, webp, avif, jpg, png.

mode

Render mode: cover (default) or fit.

responsiveSrcset

Enable width-based responsive srcset instead of density-based 2x. Default: false.

widthVariants

Width variants for responsive srcset (comma-separated string or array). Default: 480, 576, 640, 768, 992, 1200, 1800.

fetchpriority

Native HTML fetchpriority attribute (high, low, auto).

Documentation

Full documentation is available in the Documentation/ directory and is rendered on docs.typo3.org.

Development and testing

# Run all tests
composer ci:test

# Run specific tests
composer ci:test:php:cgl      # Code style
composer ci:test:php:lint     # PHP syntax
composer ci:test:php:phpstan  # Static analysis
composer ci:test:php:unit     # PHPUnit tests
composer ci:test:php:rector   # Code quality

License

GPL-3.0-or-later. See the LICENSE file for details.

Support

For issues and feature requests, please use the GitHub issue tracker.

Credits

Developed by Netresearch DTT GmbH.