The b13 image view helper is a massive extension of the regular Fluid image ViewHelper. Basically it processes images and renders a single src element or a picture element depending on the specified configuration.
Install the extension using composer: composer req b13/picture.
Include the TypoScript within your main template:
@import 'EXT:picture/Configuration/TypoScript/setup.typoscript'
Use a proper configured Fluid template adding the namespace when using this ViewHelper:
<html
xmlns:f="http://typo3.org/ns/TYPO3/CMS/Fluid/ViewHelpers"
xmlns:i="http://typo3.org/ns/B13/Picture/ViewHelpers"
data-namespace-typo3-fluid="true"
>
See EXT:picture/Configuration/TypoScript/setup.typoscript for possible configuration options (key: plugin.tx_picture):
| TypoScript Configuration option | Description |
|---|---|
| addWebp | Add webp alternative image files as sources. default: 0 |
| onlyWebp | Enable only images in webp format and for all size variants. default: 0 |
| useRetina | Add retina (2x) version of all images as sizes variants. default: 0 |
| lossless | Enable lossless compression for webp images. default: 0 |
| retina | Use custom or multiple multipliers for calculating retina image variants. _default: retina.2 = 2x Only works in combination with useRetina = 1 |
| breakpoints | Use named breakpoints for easier markup of different image sizes for one picture element. default: empty. |
| lazyLoading | Use the loading attribute with images. See Browser Native Lazy Loading by Defaultdefault: {$types.content.image.lazyLoading} |
Our image ViewHelper mimics the Fluid Image ViewHelper, so it has all the same attributes, including:
widthandheight, includingcoption for crop scalingmaxWidthfor proportional scaling, without upscalingfileExtensionto set a file extension (to force webp for example)altandtitlecropVariantloadingto enable browser native lazy loading by default.
If useRetina is set and not further specified in TypoScript setup, the corresponding img tag's or source tag’s
attribute srcset is extended by a 2x retina version of the image.
Adds rendering of additional images in webp format. If it is specified without a given sources attribute, it renders a
picture tag instead of a single img tag in order to maintain a browser fallback. If it is specified together with
sources it adds an additional source tag above any source tag rendered by a given sources element.
This attribute is ignored if onlyWebp option is active.
Enable only images in webp format and for all size variants.
Enabling this option disables addWebp setting.
Enable lossless compression for webp images. If you find your webp images lacking in quality compared to jpg/png images, enable this option to overwrite default settings for ImageMagick/GraphicsMagick.
Adds multiple variants of an image with different image sizes, optionally add a sizes-attribute to image tags:
variants="400, 600, 800, 1000" sizes="(min-width: 600px) 400px, 100vw"
This can also be part of the sources-Array (see below).
Sources must be notated as array. For each element given a source tag is rendered. It accepts the same attributes as the fluid image view helper. The source tags are rendered in the same ordering as specified in the array. If you do not specify additional TypoScript settings, any key can be used.
sources="{
0: {
width: '300c', height: '300c', media: 'min-width: 1000px', cropVariant: 'desktop', variants: '400, 600, 800', sizes: '100vw'
},
1: {
width: '250c', height: '250c', media: 'min-width: 600px', src: alternativefile.uid, treatIdAsReference: 1
},
2: {
width: '200c', height: '200c', media: 'min-width: 300px', cropVariant: 'teaser'
}
}"
Add a CSS class used for the picture element (if rendered using <picture>).
The following attributes can also be set in TypoScript as defaults for your whole site: addWebp, useRetina.
A default setting can be overridden for each usage of the ViewHelper by setting the corresponding attribute.
The retina option enables an extension of the default behaviour of the useRetina attribute. If retina is set, an
array should be specified with the multiplier for the image size as key, and the multiplier value output in the
corresponding tag.
retina {
2 = 2x
3 = 3x
}
With the array breakpoints you can use those settings by using keys in your Fluid template (instead of adding media
queries for every key in your sources array). It simply adds a media query for min-width.
breakpoints {
sm = 640
md = 1024
lg = 1280
}
You can include a test configuration to see the ViewHelper in your test instance frontend in action:
@import 'EXT:picture/Configuration/TypoScript/test.typoscript'
This configuration enables frontend rendering of the test file with lots of different rendering examples using the
page type 1573387706874.
https://your.local.test.environment/?type=1573387706874
will render a page with different options to showcase code examples. This is intended for demonstration and testing purposes, not meant for your production environment.
This extension was created by Andreas Hämmerl and David Steeb in 2019 for b13 GmbH, Stuttgart.
Find more TYPO3 extensions we have developed that help us deliver value in client projects. As part of the way we work, we focus on testing and best practices ensuring long-term performance, reliability, and results in all our code.